WebSVN – Moodle – Diff – /badges/classes/form/badge.php

 // GNU General Public License for more details.
 //
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
-/**
- * Form classes for editing badges
- *
- * @package    core
- * @subpackage badges
- * @copyright  2012 onwards Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @author     Yuliya Bozhko <yuliya.bozhko@totaralms.com>
- */
 namespace core_badges\form;
 require_once($CFG->libdir . '/filelib.php');
 use moodleform;
 /**
+ * Form classes for editing badges
+ *
+ * @package    core_badges
+ * @copyright  2012 onwards Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
- * Form to edit badge details.
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @author     Yuliya Bozhko <yuliya.bozhko@totaralms.com>
  */
 class badge extends moodleform {
     /**
      * Defines the form
      */
     public function definition() {
-        global $CFG;
+        global $CFG, $SITE;
+        $mform = $this->_form;
+        $badge = (isset($this->_customdata['badge'])) ? $this->_customdata['badge'] : false;
+        $action = $this->_customdata['action'];
+        if (array_key_exists('courseid', $this->_customdata)) {
+            $courseid = $this->_customdata['courseid'];
+        } else if (array_key_exists('badge', $this->_customdata)) {
+            $courseid = $this->_customdata['badge']->courseid;
+        }
         if (!empty($courseid)) {
-        $mform = $this->_form;
+            $mform->addElement('hidden', 'courseid', $courseid);
-        $badge = (isset($this->_customdata['badge'])) ? $this->_customdata['badge'] : false;
+            $mform->setType('courseid', PARAM_INT);
         $action = $this->_customdata['action'];
         $mform->addElement('header', 'badgedetails', get_string('badgedetails', 'badges'));
-        $mform->addElement('text', 'name', get_string('name'), array('size' => '70'));
+        $mform->addElement('text', 'name', get_string('name'), ['size' => '70']);
         // When downloading badge, it will be necessary to clean the name as PARAM_FILE.
-        $mform->setType('name', PARAM_TEXT);
-        $mform->addRule('name', null, 'required');
+        $mform->setType('name', PARAM_TEXT);
-        $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
+        $mform->addRule('name', null, 'required');
+        $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
+        $mform->addElement('text', 'version', get_string('version', 'badges'), ['size' => '70']);
+        $mform->setType('version', PARAM_TEXT);
-        $mform->addElement('text', 'version', get_string('version', 'badges'), array('size' => '70'));
+        $languages = get_string_manager()->get_list_of_languages();
-        $mform->setType('version', PARAM_TEXT);
+        $mform->addElement('select', 'language', get_string('language'), $languages);
         $mform->addHelpButton('version', 'version', 'badges');
         $mform->addElement(
-        $languages = get_string_manager()->get_list_of_languages();
+            'textarea',
-        $mform->addElement('select', 'language', get_string('language'), $languages);
+            'description',
-        $mform->addHelpButton('language', 'language', 'badges');
+            get_string('description', 'badges'),
             'wrap="virtual" rows="8" cols="70" placeholder="' . s(get_string('descriptioninfo', 'badges')) . '"',
-        $mform->addElement('textarea', 'description', get_string('description', 'badges'), 'wrap="virtual" rows="8" cols="70"');
+        );
         $mform->setType('description', PARAM_NOTAGS);
         $mform->addRule('description', null, 'required');
-        $str = $action == 'new' ? get_string('badgeimage', 'badges') : get_string('newimage', 'badges');
-        $imageoptions = array('maxbytes' => 262144, 'accepted_types' => array('optimised_image'));
-        $mform->addElement('filepicker', 'image', $str, null, $imageoptions);
-        if ($action == 'new') {
-            $mform->addRule('image', null, 'required');
-        } else {
-            $currentimage = $mform->createElement('static', 'currentimage', get_string('currentimage', 'badges'));
+        $str = $action == 'new' ? get_string('badgeimage', 'badges') : get_string('newimage', 'badges');
-            $mform->insertElementBefore($currentimage, 'image');
-        }
+        $imageoptions = ['maxbytes' => 262144, 'accepted_types' => ['optimised_image']];
-        $mform->addHelpButton('image', 'badgeimage', 'badges');
+        $mform->addElement('filepicker', 'image', $str, null, $imageoptions);
         $mform->addElement('text', 'imageauthorname', get_string('imageauthorname', 'badges'), array('size' => '70'));
-        $mform->setType('imageauthorname', PARAM_TEXT);
-        $mform->addHelpButton('imageauthorname', 'imageauthorname', 'badges');
-        $mform->addElement('text', 'imageauthoremail', get_string('imageauthoremail', 'badges'), array('size' => '70'));
-        $mform->setType('imageauthoremail', PARAM_TEXT);
+        if ($action == 'new') {
-        $mform->addHelpButton('imageauthoremail', 'imageauthoremail', 'badges');
+            $mform->addRule('image', null, 'required');
-        $mform->addElement('text', 'imageauthorurl', get_string('imageauthorurl', 'badges'), array('size' => '70'));
-        $mform->setType('imageauthorurl', PARAM_URL);
-        $mform->addHelpButton('imageauthorurl', 'imageauthorurl', 'badges');
-        $mform->addElement('text', 'imagecaption', get_string('imagecaption', 'badges'), array('size' => '70'));
-        $mform->setType('imagecaption', PARAM_TEXT);
-        $mform->addHelpButton('imagecaption', 'imagecaption', 'badges');
+        } else {
+            $currentimage = $mform->createElement('static', 'currentimage', get_string('currentimage', 'badges'));
+            $mform->insertElementBefore($currentimage, 'image');
+        }
+        $mform->addElement('static', 'imageinfo', null, get_string('badgeimageinfo', 'badges'));
+        $mform->addElement('text', 'imagecaption', get_string('imagecaption', 'badges'), ['size' => '70']);
-        $mform->addElement('tags', 'tags', get_string('tags', 'badges'), ['itemtype' => 'badge', 'component' => 'core_badges']);
+        $mform->setType('imagecaption', PARAM_TEXT);
-        if (badges_open_badges_backpack_api() == OPEN_BADGES_V1) {
+        $mform->addElement('tags', 'tags', get_string('tags', 'badges'), ['itemtype' => 'badge', 'component' => 'core_badges']);
-            $mform->addElement('header', 'issuerdetails', get_string('issuerdetails', 'badges'));
+        $mform->addElement('header', 'issuerdetails', get_string('issuerdetails', 'badges'));
-            $mform->addElement('text', 'issuername', get_string('name'), array('size' => '70'));
+        $mform->addElement('text', 'issuername', get_string('issuername', 'badges'), ['size' => '70']);
-            $mform->setType('issuername', PARAM_NOTAGS);
+        $mform->setType('issuername', PARAM_NOTAGS);
-            $mform->addRule('issuername', null, 'required');
+        $mform->addRule('issuername', null, 'required');
-            if (isset($CFG->badges_defaultissuername)) {
+        $site = get_site();
-                $mform->setDefault('issuername', $CFG->badges_defaultissuername);
+        $issuername = $CFG->badges_defaultissuername ?: $site->fullname;
-            }
+        $mform->setDefault('issuername', $issuername);
-            $mform->addHelpButton('issuername', 'issuername', 'badges');
-            $mform->addElement('text', 'issuercontact', get_string('contact', 'badges'), array('size' => '70'));
+        $mform->addElement('text', 'issuercontact', get_string('contact', 'badges'), ['size' => '70']);
-            if (isset($CFG->badges_defaultissuercontact)) {
+        if (isset($CFG->badges_defaultissuercontact)) {
-                $mform->setDefault('issuercontact', $CFG->badges_defaultissuercontact);
+            $mform->setDefault('issuercontact', $CFG->badges_defaultissuercontact);
-            }
+        }
-            $mform->setType('issuercontact', PARAM_RAW);
+        $mform->setType('issuercontact', PARAM_RAW);
-            $mform->addHelpButton('issuercontact', 'contact', 'badges');
+        $mform->addRule('issuercontact', null, 'email');
-            // Set issuer URL.
-            // Have to parse URL because badge issuer origin cannot be a subfolder in wwwroot.
+        // Set issuer URL.
-            $url = parse_url($CFG->wwwroot);
+        // Have to parse URL because badge issuer origin cannot be a subfolder in wwwroot.
-            $mform->addElement('hidden', 'issuerurl', $url['scheme'] . '://' . $url['host']);
+        $url = parse_url($CFG->wwwroot);
-            $mform->setType('issuerurl', PARAM_URL);
         $mform->addElement('hidden', 'issuerurl', $url['scheme'] . '://' . $url['host']);
         $mform->setType('issuerurl', PARAM_URL);
         $mform->addElement('header', 'issuancedetails', get_string('issuancedetails', 'badges'));
         $mform->addElement('header', 'issuancedetails', get_string('issuancedetails', 'badges'));
         $issuancedetails = array();
             $this->add_action_buttons();
             $this->set_data($badge);
             // Freeze all elements if badge is active or locked.
             if ($badge->is_active() || $badge->is_locked()) {
-                $mform->hardFreezeAllVisibleExcept(array());
+                $mform->hardFreezeAllVisibleExcept([]);
+            }
+        }
+    }
     /**
      * Load in existing data as form defaults
+     *
-     * @param stdClass|array $badge object or array of default values
+     * @param \core_badges\badge $badge object or array of default values
      */
     public function set_data($badge) {
         $defaultvalues = [];
-        parent::set_data($badge);
+        parent::set_data((object) $badge);
         if (!empty($badge->expiredate)) {
             $defaultvalues['expiry'] = 1;
             $defaultvalues['expiredate'] = $badge->expiredate;
         } else if (!empty($badge->expireperiod)) {
+            $defaultvalues['expiry'] = 2;
+            $defaultvalues['expireperiod'] = $badge->expireperiod;
+        }
+        if (!empty($badge->name)) {
-            $defaultvalues['expiry'] = 2;
+            $defaultvalues['name'] = trim($badge->name);
             $defaultvalues['expireperiod'] = $badge->expireperiod;
         $defaultvalues['tags'] = \core_tag_tag::get_item_tags_array('core_badges', 'badge', $badge->id);
         $defaultvalues['currentimage'] = print_badge_image($badge, $badge->get_context(), 'large');
         parent::set_data($defaultvalues);
+    }
-    /**
-     * Validates form data
+    /**
-     */
+     * Validates form data
+     */
     public function validation($data, $files) {
-        global $DB;
-        $errors = parent::validation($data, $files);
         global $DB, $SITE;
         if (badges_open_badges_backpack_api() == OPEN_BADGES_V1) {
-            if (!empty($data['issuercontact']) && !validate_email($data['issuercontact'])) {
+        // Trim badge name (to guarantee no badges are created with the same name but some extra spaces).
-                $errors['issuercontact'] = get_string('invalidemail');
+        $data['name'] = trim($data['name']);
         $errors = parent::validation($data, $files);
-        if ($data['expiry'] == 2 && $data['expireperiod'] <= 0) {
-            $errors['expirydategr'] = get_string('error:invalidexpireperiod', 'badges');
-        }
-        if ($data['expiry'] == 1 && $data['expiredate'] <= time()) {
-            $errors['expirydategr'] = get_string('error:invalidexpiredate', 'badges');
-        }
-        if ($data['imageauthoremail'] && !validate_email($data['imageauthoremail'])) {
-            $errors['imageauthoremail'] = get_string('invalidemail');
-        }
-        // Check for duplicate badge names.
-        if ($data['action'] == 'new') {
-            $duplicate = $DB->record_exists_select('badge', 'name = :name AND status != :deleted',
-                array('name' => $data['name'], 'deleted' => BADGE_STATUS_ARCHIVED));
-        } else {
-            $duplicate = $DB->record_exists_select('badge', 'name = :name AND id != :badgeid AND status != :deleted',
-                array('name' => $data['name'], 'badgeid' => $data['id'], 'deleted' => BADGE_STATUS_ARCHIVED));
-        }
-        if ($duplicate) {
+        if ($data['expiry'] == 2 && $data['expireperiod'] <= 0) {
-            $errors['name'] = get_string('error:duplicatename', 'badges');
+            $errors['expirydategr'] = get_string('error:invalidexpireperiod', 'badges');
-        }

Proyectos de Subversion Moodle

(root)/badges/classes/form/badge.php – Rev 1 → 1441