MDL-22388 Added some checks to kill these scripts dead with an unequivocal notice...
[moodle.git] / blocks / edit_form.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Defines the base class form used by blocks/edit.php to edit block instance configuration.
20  *
21  * It works with the {@link block_edit_form} class, or rather the particular
22  * subclass defined by this block, to do the editing.
23  *
24  * @package   moodlecore
25  * @copyright 2009 Tim Hunt
26  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 if (!defined('MOODLE_INTERNAL')) {
30     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
31 }
33 require_once($CFG->libdir . '/formslib.php');
35 /**
36  * The base class form used by blocks/edit.php to edit block instance configuration.
37  *
38  * @copyright 2009 Tim Hunt
39  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 class block_edit_form extends moodleform {
42     /**
43      * The block instance we are editing.
44      * @var block_base
45      */
46     public $block;
47     /**
48      * The page we are editing this block in association with.
49      * @var moodle_page
50      */
51     public $page;
53     function __construct($actionurl, $block, $page) {
54         global $CFG;
55         $this->block = $block;
56         $this->page = $page;
57         parent::moodleform($actionurl);
58     }
60     function definition() {
61         $mform =& $this->_form;
63         // First show fields specific to this type of block.
64         $this->specific_definition($mform);
66         // Then show the fields about where this block appears.
67         $mform->addElement('header', 'whereheader', get_string('wherethisblockappears', 'block'));
69         // If the current weight of the block is out-of-range, add that option in.
70         $blockweight = $this->block->instance->weight;
71         $weightoptions = array();
72         if ($blockweight < -block_manager::MAX_WEIGHT) {
73             $weightoptions[$blockweight] = $blockweight;
74         }
75         for ($i = -block_manager::MAX_WEIGHT; $i <= block_manager::MAX_WEIGHT; $i++) {
76             $weightoptions[$i] = $i;
77         }
78         if ($blockweight > block_manager::MAX_WEIGHT) {
79             $weightoptions[$blockweight] = $blockweight;
80         }
81         $first = reset($weightoptions);
82         $weightoptions[$first] = get_string('bracketfirst', 'block', $first);
83         $last = end($weightoptions);
84         $weightoptions[$last] = get_string('bracketlast', 'block', $last);
86         $regionoptions = $this->page->theme->get_all_block_regions();
88         $parentcontext = get_context_instance_by_id($this->block->instance->parentcontextid);
89         $mform->addElement('hidden', 'bui_parentcontextid', $parentcontext->id);
91         $contextoptions = array();
92         if ( ($parentcontext->contextlevel == CONTEXT_COURSE && $parentcontext->instanceid == SITEID) ||
93              ($parentcontext->contextlevel == CONTEXT_SYSTEM)) {        // Home page
94             $contextoptions[0] = get_string('showonfrontpageonly', 'block');
95             $contextoptions[1] = get_string('showonfrontpageandsubs', 'block');
96             $contextoptions[2] = get_string('showonentiresite', 'block');
97         } else {
98             $parentcontextname = print_context_name($parentcontext);
99             $contextoptions[0] = get_string('showoncontextonly', 'block', $parentcontextname);
100             $contextoptions[1] = get_string('showoncontextandsubs', 'block', $parentcontextname);
101         }
102         $mform->addElement('select', 'bui_contexts', get_string('contexts', 'block'), $contextoptions);
104         if ($this->page->pagetype == 'site-index') {   // No need for pagetype list on home page
105             $pagetypelist = array('*');
106         } else {
107             $pagetypelist = matching_page_type_patterns($this->page->pagetype);
108         }
109         $pagetypeoptions = array();
110         foreach ($pagetypelist as $pagetype) {         // Find human-readable names for the pagetypes
111             $pagetypeoptions[$pagetype] = $pagetype;
112             $pagetypestringname = 'page-'.str_replace('*', 'x',$pagetype);  // Better names MDL-21375
113             if (get_string_manager()->string_exists($pagetypestringname, 'pagetype')) {
114                 $pagetypeoptions[$pagetype] .= ' (' . get_string($pagetypestringname, 'pagetype') . ')';
115             }
116         }
117         $mform->addElement('select', 'bui_pagetypepattern', get_string('restrictpagetypes', 'block'), $pagetypeoptions);
119         if ($this->page->subpage) {
120             $subpageoptions = array(
121                 '%@NULL@%' => get_string('anypagematchingtheabove', 'block'),
122                 $this->page->subpage => get_string('thisspecificpage', 'block', $this->page->subpage),
123             );
124             $mform->addElement('select', 'bui_subpagepattern', get_string('subpages', 'block'), $subpageoptions);
125         }
127         $defaultregionoptions = $regionoptions;
128         $defaultregion = $this->block->instance->defaultregion;
129         if (!array_key_exists($defaultregion, $defaultregionoptions)) {
130             $defaultregionoptions[$defaultregion] = $defaultregion;
131         }
132         $mform->addElement('select', 'bui_defaultregion', get_string('defaultregion', 'block'), $defaultregionoptions);
134         $mform->addElement('select', 'bui_defaultweight', get_string('defaultweight', 'block'), $weightoptions);
136         // Where this block is positioned on this page.
137         $mform->addElement('header', 'whereheader', get_string('onthispage', 'block'));
139         $mform->addElement('selectyesno', 'bui_visible', get_string('visible', 'block'));
141         $blockregion = $this->block->instance->region;
142         if (!array_key_exists($blockregion, $regionoptions)) {
143             $regionoptions[$blockregion] = $blockregion;
144         }
145         $mform->addElement('select', 'bui_region', get_string('region', 'block'), $regionoptions);
147         $mform->addElement('select', 'bui_weight', get_string('weight', 'block'), $weightoptions);
149         $pagefields = array('bui_visible', 'bui_region', 'bui_weight');
150         if (!$this->block->user_can_edit()) {
151             $mform->hardFreezeAllVisibleExcept($pagefields);
152         }
153         if (!$this->page->user_can_edit_blocks()) {
154             $mform->hardFreeze($pagefields);
155         }
157         $this->add_action_buttons();
158     }
160     function set_data($defaults) {
161         // Prefix bui_ on all the core field names.
162         $blockfields = array('showinsubcontexts', 'pagetypepattern', 'subpagepattern', 'parentcontextid',
163                 'defaultregion', 'defaultweight', 'visible', 'region', 'weight');
164         foreach ($blockfields as $field) {
165             $newname = 'bui_' . $field;
166             $defaults->$newname = $defaults->$field;
167         }
169         // Copy block config into config_ fields.
170         if (!empty($this->block->config)) {
171             foreach ($this->block->config as $field => $value) {
172                 $configfield = 'config_' . $field;
173                 $defaults->$configfield = $value;
174             }
175         }
177         // Munge ->subpagepattern becuase HTML selects don't play nicely with NULLs.
178         if (empty($defaults->bui_subpagepattern)) {
179             $defaults->bui_subpagepattern = '%@NULL@%';
180         }
182         $systemcontext = get_context_instance(CONTEXT_SYSTEM);
183         if ($defaults->parentcontextid == $systemcontext->id) {
184             $defaults->bui_contexts = 2; // System-wide and sticky
185         } else {
186             $defaults->bui_contexts = $defaults->bui_showinsubcontexts;
187         }
189         parent::set_data($defaults);
190     }
192     /**
193      * Override this to create any form fields specific to this type of block.
194      * @param object $mform the form being built.
195      */
196     protected function specific_definition($mform) {
197         // By default, do nothing.
198     }