Proyectos de Subversion Moodle

<?php

// This file is part of Moodle - http://moodle.org/

//

// Moodle is free software: you can redistribute it and/or modify

// it under the terms of the GNU General Public License as published by

// the Free Software Foundation, either version 3 of the License, or

// (at your option) any later version.

//

// Moodle is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

// 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/>.

/**

 * Menu profile field.

 *

 * @package    profilefield_menu

 * @copyright  2007 onwards Shane Elliot {@link http://pukunui.com}

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

/**

 * Class profile_field_menu

 *

 * @copyright  2007 onwards Shane Elliot {@link http://pukunui.com}

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

class profile_field_menu extends profile_field_base {

    /** @var array $options */

    public $options;

    /** @var int $datakey */

    public $datakey;

    /**

     * Constructor method.

     *

     * Pulls out the options for the menu from the database and sets the the corresponding key for the data if it exists.

     *

     * @param int $fieldid

     * @param int $userid

     * @param object $fielddata

     */

    public function __construct($fieldid = 0, $userid = 0, $fielddata = null) {

        // First call parent constructor.

        parent::__construct($fieldid, $userid, $fielddata);

        // Param 1 for menu type is the options.

        if (isset($this->field->param1)) {

            $options = explode("\n", $this->field->param1);

        } else {

            $options = array();

        }

        $this->options = array();

        if (!empty($this->field->required)) {

            $this->options[''] = get_string('choose').'...';

        }

        foreach ($options as $key => $option) {

            // Multilang formatting with filters.

            $this->options[$option] = format_string($option, true, ['context' => context_system::instance()]);

        }

        // Set the data key.

        if ($this->data !== null) {

            $key = $this->data;

            if (isset($this->options[$key]) || ($key = array_search($key, $this->options)) !== false) {

                $this->data = $key;

                $this->datakey = $key;

            }

        }

    }

    /**

     * Create the code snippet for this field instance

     * Overwrites the base class method

     * @param moodleform $mform Moodle form instance

     */

    public function edit_field_add($mform) {

        $mform->addElement('select', $this->inputname, format_string($this->field->name), $this->options);

    }

    /**

     * Set the default value for this field instance

     * Overwrites the base class method.

     * @param moodleform $mform Moodle form instance

     */

    public function edit_field_set_default($mform) {

        $key = $this->field->defaultdata;

        if (isset($this->options[$key]) || ($key = array_search($key, $this->options)) !== false){

            $defaultkey = $key;

        } else {

            $defaultkey = '';

        }

        $mform->setDefault($this->inputname, $defaultkey);

    }

    /**

     * The data from the form returns the key.

     *

     * This should be converted to the respective option string to be saved in database

     * Overwrites base class accessor method.

     *

     * @param mixed $data The key returned from the select input in the form

     * @param stdClass $datarecord The object that will be used to save the record

     * @return mixed Data or null

     */

    public function edit_save_data_preprocess($data, $datarecord) {

        return isset($this->options[$data]) ? $data : null;

    }

    /**

     * When passing the user object to the form class for the edit profile page

     * we should load the key for the saved data

     *

     * Overwrites the base class method.

     *

     * @param stdClass $user User object.

     */

    public function edit_load_user_data($user) {

        $user->{$this->inputname} = $this->datakey;

    }

    /**

     * HardFreeze the field if locked.

     * @param moodleform $mform instance of the moodleform class

     */

    public function edit_field_set_locked($mform) {

        if (!$mform->elementExists($this->inputname)) {

            return;

        }

        if ($this->is_locked() and !has_capability('moodle/user:update', context_system::instance())) {

            $mform->hardFreeze($this->inputname);

            $mform->setConstant($this->inputname, format_string($this->datakey));

        }

    }

    /**

     * Convert external data (csv file) from value to key for processing later by edit_save_data_preprocess

     *

     * @param string $value one of the values in menu options.

     * @return int options key for the menu

     */

    public function convert_external_data($value) {

        if (isset($this->options[$value])) {

            $retval = $value;

        } else {

            $retval = array_search($value, $this->options);

        }

        // If value is not found in options then return null, so that it can be handled

        // later by edit_save_data_preprocess.

        if ($retval === false) {

            $retval = null;

        }

        return $retval;

    }

    /**

     * Return the field type and null properties.

     * This will be used for validating the data submitted by a user.

     *

     * @return array the param type and null property

     * @since Moodle 3.2

     */

    public function get_field_properties() {

        return array(PARAM_TEXT, NULL_NOT_ALLOWED);

    }

    /**

     * Return the field settings suitable to be exported via an external function.

     *

     * @return array all the settings

     */

    public function get_field_config_for_external() {

        if (isset($this->field->param1) && !empty($this->options)) {

            // Remove "Choose" option to make it consisten with the rest of the data.

            if (!empty($this->field->required)) {

                unset($this->options['']);

            }

            $this->field->param2 = implode("\n", array_values($this->options));

        }

        return (array) $this->field;

    }

}