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

/**

 * This file contains classes used to manage the navigation structures in Moodle

 * and was introduced as part of the changes occuring in Moodle 2.0

 *

 * @since Moodle 2.0

 * @package block_settings

 * @copyright 2009 Sam Hemelryk

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

 */

/**

 * The settings navigation tree block class

 *

 * Used to produce the settings navigation block new to Moodle 2.0

 *

 * @package block_settings

 * @copyright 2009 Sam Hemelryk

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

 */

class block_settings extends block_base {

    /** @var string */

    public static $navcount;

    public $blockname = null;

    /** @var bool */

    protected $contentgenerated = false;

    /** @var bool|null */

    protected $docked = null;

    /**

     * Set the initial properties for the block

     */

    function init() {

        $this->blockname = get_class($this);

        $this->title = get_string('pluginname', $this->blockname);

    }

    /**

     * All multiple instances of this block

     * @return bool Returns true

     */

    function instance_allow_multiple() {

        return false;

    }

    /**

     * The settings block cannot be hidden by default as it is integral to

     * the navigation of Moodle.

     *

     * @return false

     */

    function instance_can_be_hidden() {

        return false;

    }

    /**

     * Set the applicable formats for this block to all

     * @return array

     */

    function applicable_formats() {

        return array('all' => true);

    }

    /**

     * Allow the user to configure a block instance

     * @return bool Returns true

     */

    function instance_allow_config() {

        return true;

    }

    function instance_can_be_docked() {

        return (parent::instance_can_be_docked() && (empty($this->config->enabledock) || $this->config->enabledock=='yes'));

    }

    function get_required_javascript() {

        $adminnode = $this->page->settingsnav->find('siteadministration', navigation_node::TYPE_SITE_ADMIN);

        parent::get_required_javascript();

        $arguments = array(

            'instanceid' => $this->instance->id,

            'adminnodeid' => $adminnode ? $adminnode->id : null

        );

        $this->page->requires->js_call_amd('block_settings/settingsblock', 'init', $arguments);

    }

    /**

     * Gets the content for this block by grabbing it from $this->page

     */

    function get_content() {

        global $CFG, $OUTPUT;

        // First check if we have already generated, don't waste cycles

        if ($this->contentgenerated === true) {

            return true;

        }

        // JS for navigation moved to the standard theme, the code will probably have to depend on the actual page structure

        // $this->page->requires->js('/lib/javascript-navigation.js');

        block_settings::$navcount++;

        // Check if this block has been docked

        if ($this->docked === null) {

            $this->docked = get_user_preferences('nav_in_tab_panel_settingsnav'.block_settings::$navcount, 0);

        }

        // Check if there is a param to change the docked state

        if ($this->docked && optional_param('undock', null, PARAM_INT)==$this->instance->id) {

            unset_user_preference('nav_in_tab_panel_settingsnav'.block_settings::$navcount, 0);

            $url = $this->page->url;

            $url->remove_params(array('undock'));

            redirect($url);

        } else if (!$this->docked && optional_param('dock', null, PARAM_INT)==$this->instance->id) {

            set_user_preferences(array('nav_in_tab_panel_settingsnav'.block_settings::$navcount=>1));

            $url = $this->page->url;

            $url->remove_params(array('dock'));

            redirect($url);

        }

        $renderer = $this->page->get_renderer('block_settings');

        $this->content = new stdClass();

        $this->content->text = $renderer->settings_tree($this->page->settingsnav);

        // only do search if you have moodle/site:config

        if (!empty($this->content->text)) {

            if (has_capability('moodle/site:config',context_system::instance()) ) {

                $this->content->footer = $renderer->search_form(new moodle_url("$CFG->wwwroot/$CFG->admin/search.php"), optional_param('query', '', PARAM_RAW));

            } else {

                $this->content->footer = '';

            }

        }

        $this->contentgenerated = true;

        return true;

    }

    /**

     * Returns the role that best describes the settings block.

     *

     * @return string 'navigation'

     */

    public function get_aria_role() {

        return 'navigation';

    }

    /**

     * Return the plugin config settings for external functions.

     *

     * @return stdClass the configs for both the block instance and plugin

     * @since Moodle 3.8

     */

    public function get_config_for_external() {

        // Return all settings for all users since it is safe (no private keys, etc..).

        $configs = !empty($this->config) ? $this->config : new stdClass();

        return (object) [

            'instance' => $configs,

            'plugin' => new stdClass(),

        ];

    }

}