From 92e00296235a1586c3ef79ed931806d64c5456b5 Mon Sep 17 00:00:00 2001 From: Mark Nelson Date: Tue, 16 Apr 2019 19:22:50 +0800 Subject: [PATCH] Incorrect PHPDocs for render_form_elements and co (#271) --- classes/element.php | 2 +- classes/element_helper.php | 8 ++++---- element/bgimage/classes/element.php | 2 +- element/border/classes/element.php | 4 ++-- element/date/classes/element.php | 4 ++-- element/digitalsignature/classes/element.php | 4 ++-- element/grade/classes/element.php | 4 ++-- element/gradeitemname/classes/element.php | 4 ++-- element/image/classes/element.php | 4 ++-- element/teachername/classes/element.php | 4 ++-- element/text/classes/element.php | 4 ++-- element/userfield/classes/element.php | 4 ++-- element/userpicture/classes/element.php | 4 ++-- 13 files changed, 26 insertions(+), 26 deletions(-) diff --git a/classes/element.php b/classes/element.php index 00331a8..0c72fac 100644 --- a/classes/element.php +++ b/classes/element.php @@ -230,7 +230,7 @@ abstract class element { * This function renders the form elements when adding a customcert element. * Can be overridden if more functionality is needed. * - * @param edit_element_form $mform the edit_form instance. + * @param \MoodleQuickForm $mform the edit_form instance. */ public function render_form_elements($mform) { // Render the common elements. diff --git a/classes/element_helper.php b/classes/element_helper.php index 153dae0..e4b89c4 100644 --- a/classes/element_helper.php +++ b/classes/element_helper.php @@ -134,7 +134,7 @@ class element_helper { /** * Helper function to render the font elements. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance. + * @param \MoodleQuickForm $mform the edit_form instance. */ public static function render_form_element_font($mform) { $mform->addElement('select', 'font', get_string('font', 'customcert'), \mod_customcert\certificate::get_fonts()); @@ -151,7 +151,7 @@ class element_helper { /** * Helper function to render the colour elements. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance. + * @param \MoodleQuickForm $mform the edit_form instance. */ public static function render_form_element_colour($mform) { $mform->addElement('customcert_colourpicker', 'colour', get_string('fontcolour', 'customcert')); @@ -163,7 +163,7 @@ class element_helper { /** * Helper function to render the position elements. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance. + * @param \MoodleQuickForm $mform the edit_form instance. */ public static function render_form_element_position($mform) { $mform->addElement('text', 'posx', get_string('posx', 'customcert'), array('size' => 10)); @@ -179,7 +179,7 @@ class element_helper { /** * Helper function to render the width element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance. + * @param \MoodleQuickForm $mform the edit_form instance. */ public static function render_form_element_width($mform) { $mform->addElement('text', 'width', get_string('elementwidth', 'customcert'), array('size' => 10)); diff --git a/element/bgimage/classes/element.php b/element/bgimage/classes/element.php index cbd2641..a4c36e8 100644 --- a/element/bgimage/classes/element.php +++ b/element/bgimage/classes/element.php @@ -38,7 +38,7 @@ class element extends \customcertelement_image\element { /** * This function renders the form elements when adding a customcert element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function render_form_elements($mform) { $mform->addElement('select', 'fileid', get_string('image', 'customcertelement_image'), self::get_images()); diff --git a/element/border/classes/element.php b/element/border/classes/element.php index 127754c..a33f831 100644 --- a/element/border/classes/element.php +++ b/element/border/classes/element.php @@ -38,7 +38,7 @@ class element extends \mod_customcert\element { /** * This function renders the form elements when adding a customcert element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function render_form_elements($mform) { // We want to define the width of the border. @@ -103,7 +103,7 @@ class element extends \mod_customcert\element { /** * Sets the data on the form when editing an element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function definition_after_data($mform) { if (!empty($this->get_data())) { diff --git a/element/date/classes/element.php b/element/date/classes/element.php index 30cab73..d3693e7 100644 --- a/element/date/classes/element.php +++ b/element/date/classes/element.php @@ -65,7 +65,7 @@ class element extends \mod_customcert\element { /** * This function renders the form elements when adding a customcert element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function render_form_elements($mform) { global $CFG, $COURSE; @@ -223,7 +223,7 @@ class element extends \mod_customcert\element { /** * Sets the data on the form when editing an element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function definition_after_data($mform) { // Set the item and format for this element. diff --git a/element/digitalsignature/classes/element.php b/element/digitalsignature/classes/element.php index 65c07ce..178d2d4 100644 --- a/element/digitalsignature/classes/element.php +++ b/element/digitalsignature/classes/element.php @@ -60,7 +60,7 @@ class element extends \customcertelement_image\element { /** * This function renders the form elements when adding a customcert element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function render_form_elements($mform) { $mform->addElement('select', 'fileid', get_string('image', 'customcertelement_image'), self::get_images()); @@ -240,7 +240,7 @@ class element extends \customcertelement_image\element { /** * Sets the data on the form when editing an element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function definition_after_data($mform) { global $COURSE, $SITE; diff --git a/element/grade/classes/element.php b/element/grade/classes/element.php index 95bc64d..4eb4454 100644 --- a/element/grade/classes/element.php +++ b/element/grade/classes/element.php @@ -43,7 +43,7 @@ class element extends \mod_customcert\element { /** * This function renders the form elements when adding a customcert element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function render_form_elements($mform) { global $COURSE; @@ -168,7 +168,7 @@ class element extends \mod_customcert\element { /** * Sets the data on the form when editing an element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function definition_after_data($mform) { // Set the item and format for this element. diff --git a/element/gradeitemname/classes/element.php b/element/gradeitemname/classes/element.php index 401de90..ec1b16b 100644 --- a/element/gradeitemname/classes/element.php +++ b/element/gradeitemname/classes/element.php @@ -38,7 +38,7 @@ class element extends \mod_customcert\element { /** * This function renders the form elements when adding a customcert element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function render_form_elements($mform) { global $COURSE; @@ -99,7 +99,7 @@ class element extends \mod_customcert\element { /** * Sets the data on the form when editing an element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function definition_after_data($mform) { if (!empty($this->get_data())) { diff --git a/element/image/classes/element.php b/element/image/classes/element.php index 7708dd7..e2dde5a 100644 --- a/element/image/classes/element.php +++ b/element/image/classes/element.php @@ -60,7 +60,7 @@ class element extends \mod_customcert\element { /** * This function renders the form elements when adding a customcert element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function render_form_elements($mform) { $mform->addElement('select', 'fileid', get_string('image', 'customcertelement_image'), self::get_images()); @@ -282,7 +282,7 @@ class element extends \mod_customcert\element { /** * Sets the data on the form when editing an element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function definition_after_data($mform) { global $COURSE, $SITE; diff --git a/element/teachername/classes/element.php b/element/teachername/classes/element.php index 1c18e30..8432e9d 100644 --- a/element/teachername/classes/element.php +++ b/element/teachername/classes/element.php @@ -38,7 +38,7 @@ class element extends \mod_customcert\element { /** * This function renders the form elements when adding a customcert element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function render_form_elements($mform) { $mform->addElement('select', 'teacher', get_string('teacher', 'customcertelement_teachername'), @@ -123,7 +123,7 @@ class element extends \mod_customcert\element { /** * Sets the data on the form when editing an element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function definition_after_data($mform) { if (!empty($this->get_data())) { diff --git a/element/text/classes/element.php b/element/text/classes/element.php index c2a4f13..0f2adf9 100644 --- a/element/text/classes/element.php +++ b/element/text/classes/element.php @@ -38,7 +38,7 @@ class element extends \mod_customcert\element { /** * This function renders the form elements when adding a customcert element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function render_form_elements($mform) { $mform->addElement('textarea', 'text', get_string('text', 'customcertelement_text')); @@ -85,7 +85,7 @@ class element extends \mod_customcert\element { /** * Sets the data on the form when editing an element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function definition_after_data($mform) { if (!empty($this->get_data())) { diff --git a/element/userfield/classes/element.php b/element/userfield/classes/element.php index 84db94a..d054e92 100644 --- a/element/userfield/classes/element.php +++ b/element/userfield/classes/element.php @@ -38,7 +38,7 @@ class element extends \mod_customcert\element { /** * This function renders the form elements when adding a customcert element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function render_form_elements($mform) { // Get the user profile fields. @@ -116,7 +116,7 @@ class element extends \mod_customcert\element { /** * Sets the data on the form when editing an element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function definition_after_data($mform) { if (!empty($this->get_data())) { diff --git a/element/userpicture/classes/element.php b/element/userpicture/classes/element.php index ce945cb..898bdc4 100644 --- a/element/userpicture/classes/element.php +++ b/element/userpicture/classes/element.php @@ -38,7 +38,7 @@ class element extends \mod_customcert\element { /** * This function renders the form elements when adding a customcert element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function render_form_elements($mform) { $mform->addElement('text', 'width', get_string('width', 'customcertelement_userpicture'), array('size' => 10)); @@ -190,7 +190,7 @@ class element extends \mod_customcert\element { /** * Sets the data on the form when editing an element. * - * @param \mod_customcert\edit_element_form $mform the edit_form instance + * @param \MoodleQuickForm $mform the edit_form instance */ public function definition_after_data($mform) { // Set the image, width and height for this element.