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

namespace mod_quiz\admin;

/**

 * Admin settings class for the quiz review options.

 *

 * @package   mod_quiz

 * @category  admin

 * @copyright  2008 Tim Hunt

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

 */

class review_setting extends \admin_setting {

    /**

     * @var integer should match the constants defined in

     * {@see display_options}. Copied for performance reasons.

     */

    const DURING            = 0x10000;

    /**

     * @var integer should match the constants defined in

     * {@see display_options}. Copied for performance reasons.

     */

    const IMMEDIATELY_AFTER = 0x01000;

    /**

     * @var integer should match the constants defined in

     * {@see display_options}. Copied for performance reasons.

     */

    const LATER_WHILE_OPEN  = 0x00100;

    /**

     * @var integer should match the constants defined in

     * {@see display_options}. Copied for performance reasons.

     */

    const AFTER_CLOSE       = 0x00010;

    /**

     * @var boolean|null forced checked / disabled attributes for the during time.

     */

    protected $duringstate;

    /**

     * This should match {@link mod_quiz_mod_form::$reviewfields} but copied

     * here because generating the admin tree needs to be fast.

     * @return array

     */

    public static function fields() {

        return [

            'attempt'          => get_string('theattempt', 'quiz'),

            'correctness'      => get_string('whethercorrect', 'question'),

            'maxmarks'         => get_string('maxmarks', 'quiz'),

            'marks'            => get_string('marks', 'question'),

            'specificfeedback' => get_string('specificfeedback', 'question'),

            'generalfeedback'  => get_string('generalfeedback', 'question'),

            'rightanswer'      => get_string('rightanswer', 'question'),

            'overallfeedback'  => get_string('overallfeedback', 'quiz'),

        ];

    }

    /**

     * Constructor.

     *

     * @param string $name unique ascii name, either 'mysetting' for settings that in config,

     *                     or 'myplugin/mysetting' for ones in config_plugins.

     * @param string $visiblename localised name

     * @param string $description localised long description

     * @param mixed $defaultsetting string or array depending on implementation

     * @param bool|null $duringstate

     */

    public function __construct($name, $visiblename, $description,

            $defaultsetting, $duringstate = null) {

        $this->duringstate = $duringstate;

        parent::__construct($name, $visiblename, $description, $defaultsetting);

    }

    /**

     * Return the combination that means all times.

     * @return int all times.

     */

    public static function all_on() {

        return self::DURING | self::IMMEDIATELY_AFTER | self::LATER_WHILE_OPEN |

                self::AFTER_CLOSE;

    }

    /**

     * Get an array of the names of all the possible times.

     * @return array an array of time constant => lang string.

     */

    protected static function times() {

        return [

            self::DURING            => get_string('reviewduring', 'quiz'),

            self::IMMEDIATELY_AFTER => get_string('reviewimmediately', 'quiz'),

            self::LATER_WHILE_OPEN  => get_string('reviewopen', 'quiz'),

            self::AFTER_CLOSE       => get_string('reviewclosed', 'quiz'),

        ];

    }

    protected function normalise_data($data) {

        $times = self::times();

        $value = 0;

        foreach ($times as $timemask => $name) {

            if ($timemask == self::DURING && !is_null($this->duringstate)) {

                if ($this->duringstate) {

                    $value += $timemask;

                }

            } else if (!empty($data[$timemask])) {

                $value += $timemask;

            }

        }

        return $value;

    }

    public function get_setting() {

        return $this->config_read($this->name);

    }

    public function write_setting($data) {

        if (is_array($data) || empty($data)) {

            $data = $this->normalise_data($data);

        }

        $this->config_write($this->name, $data);

        return '';

    }

    public function output_html($data, $query = '') {

        if (is_array($data) || empty($data)) {

            $data = $this->normalise_data($data);

        }

        $return = '<div class="group"><input type="hidden" name="' .

                    $this->get_full_name() . '[' . self::DURING . ']" value="0" />';

        foreach (self::times() as $timemask => $namestring) {

            $id = $this->get_id(). '_' . $timemask;

            $state = '';

            if ($data & $timemask) {

                $state = 'checked="checked" ';

            }

            if ($timemask == self::DURING && !is_null($this->duringstate)) {

                $state = 'disabled="disabled" ';

                if ($this->duringstate) {

                    $state .= 'checked="checked" ';

                }

            }

            $return .= '<span><input type="checkbox" name="' .

                    $this->get_full_name() . '[' . $timemask . ']" value="1" id="' . $id .

                    '" ' . $state . '/> <label for="' . $id . '">' .

                    $namestring . "</label></span>\n";

        }

        $return .= "</div>\n";

        return format_admin_setting($this, $this->visiblename, $return,

                $this->description, true, '', get_string('everythingon', 'quiz'), $query);

    }

}