MDL-38855 blocks: Fix missing setType calls
[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    core
25  * @subpackage block
26  * @copyright  2009 Tim Hunt
27  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28  */
30 if (!defined('MOODLE_INTERNAL')) {
31     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
32 }
34 require_once($CFG->libdir . '/formslib.php');
35 require_once($CFG->libdir . '/blocklib.php');
37 /**
38  * The base class form used by blocks/edit.php to edit block instance configuration.
39  *
40  * @copyright 2009 Tim Hunt
41  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42  */
43 class block_edit_form extends moodleform {
44     /**
45      * The block instance we are editing.
46      * @var block_base
47      */
48     public $block;
49     /**
50      * The page we are editing this block in association with.
51      * @var moodle_page
52      */
53     public $page;
55     function __construct($actionurl, $block, $page) {
56         global $CFG;
57         $this->block = $block;
58         $this->page = $page;
59         parent::moodleform($actionurl);
60     }
62     function definition() {
63         $mform =& $this->_form;
65         // First show fields specific to this type of block.
66         $this->specific_definition($mform);
68         // Then show the fields about where this block appears.
69         $mform->addElement('header', 'whereheader', get_string('wherethisblockappears', 'block'));
71         // If the current weight of the block is out-of-range, add that option in.
72         $blockweight = $this->block->instance->weight;
73         $weightoptions = array();
74         if ($blockweight < -block_manager::MAX_WEIGHT) {
75             $weightoptions[$blockweight] = $blockweight;
76         }
77         for ($i = -block_manager::MAX_WEIGHT; $i <= block_manager::MAX_WEIGHT; $i++) {
78             $weightoptions[$i] = $i;
79         }
80         if ($blockweight > block_manager::MAX_WEIGHT) {
81             $weightoptions[$blockweight] = $blockweight;
82         }
83         $first = reset($weightoptions);
84         $weightoptions[$first] = get_string('bracketfirst', 'block', $first);
85         $last = end($weightoptions);
86         $weightoptions[$last] = get_string('bracketlast', 'block', $last);
88         $regionoptions = $this->page->theme->get_all_block_regions();
90         $parentcontext = context::instance_by_id($this->block->instance->parentcontextid);
91         $mform->addElement('hidden', 'bui_parentcontextid', $parentcontext->id);
92         $mform->setType('bui_parentcontextid', PARAM_INT);
94         $mform->addElement('static', 'bui_homecontext', get_string('createdat', 'block'), print_context_name($parentcontext));
95         $mform->addHelpButton('bui_homecontext', 'createdat', 'block');
97         // For pre-calculated (fixed) pagetype lists
98         $pagetypelist = array();
100         // parse pagetype patterns
101         $bits = explode('-', $this->page->pagetype);
103         // First of all, check if we are editing blocks @ front-page or no and
104         // make some dark magic if so (MDL-30340) because each page context
105         // implies one (and only one) harcoded page-type that will be set later
106         // when processing the form data at {@link block_manager::process_url_edit()}
108         // There are some conditions to check related to contexts
109         $ctxconditions = $this->page->context->contextlevel == CONTEXT_COURSE &&
110                          $this->page->context->instanceid == get_site()->id;
111         // And also some pagetype conditions
112         $pageconditions = isset($bits[0]) && isset($bits[1]) && $bits[0] == 'site' && $bits[1] == 'index';
113         // So now we can be 100% sure if edition is happening at frontpage
114         $editingatfrontpage = $ctxconditions && $pageconditions;
116         // Let the form to know about that, can be useful later
117         $mform->addElement('hidden', 'bui_editingatfrontpage', (int)$editingatfrontpage);
118         $mform->setType('bui_editingatfrontpage', PARAM_INT);
120         // Front page, show the page-contexts element and set $pagetypelist to 'any page' (*)
121         // as unique option. Processign the form will do any change if needed
122         if ($editingatfrontpage) {
123             $contextoptions = array();
124             $contextoptions[BUI_CONTEXTS_FRONTPAGE_ONLY] = get_string('showonfrontpageonly', 'block');
125             $contextoptions[BUI_CONTEXTS_FRONTPAGE_SUBS] = get_string('showonfrontpageandsubs', 'block');
126             $contextoptions[BUI_CONTEXTS_ENTIRE_SITE]    = get_string('showonentiresite', 'block');
127             $mform->addElement('select', 'bui_contexts', get_string('contexts', 'block'), $contextoptions);
128             $mform->addHelpButton('bui_contexts', 'contexts', 'block');
129             $pagetypelist['*'] = '*'; // This is not going to be shown ever, it's an unique option
131         // Any other system context block, hide the page-contexts element,
132         // it's always system-wide BUI_CONTEXTS_ENTIRE_SITE
133         } else if ($parentcontext->contextlevel == CONTEXT_SYSTEM) {
134             $mform->addElement('hidden', 'bui_contexts', BUI_CONTEXTS_ENTIRE_SITE);
136         } else if ($parentcontext->contextlevel == CONTEXT_COURSE) {
137             // 0 means display on current context only, not child contexts
138             // but if course managers select mod-* as pagetype patterns, block system will overwrite this option
139             // to 1 (display on current context and child contexts)
140             $mform->addElement('hidden', 'bui_contexts', BUI_CONTEXTS_CURRENT);
141         } else if ($parentcontext->contextlevel == CONTEXT_MODULE or $parentcontext->contextlevel == CONTEXT_USER) {
142             // module context doesn't have child contexts, so display in current context only
143             $mform->addElement('hidden', 'bui_contexts', BUI_CONTEXTS_CURRENT);
144         } else {
145             $parentcontextname = print_context_name($parentcontext);
146             $contextoptions[BUI_CONTEXTS_CURRENT]      = get_string('showoncontextonly', 'block', $parentcontextname);
147             $contextoptions[BUI_CONTEXTS_CURRENT_SUBS] = get_string('showoncontextandsubs', 'block', $parentcontextname);
148             $mform->addElement('select', 'bui_contexts', get_string('contexts', 'block'), $contextoptions);
149         }
150         $mform->setType('bui_contexts', PARAM_INT);
152         // Generate pagetype patterns by callbacks if necessary (has not been set specifically)
153         if (empty($pagetypelist)) {
154             $pagetypelist = generate_page_type_patterns($this->page->pagetype, $parentcontext, $this->page->context);
155             $displaypagetypewarning = false;
156             if (!array_key_exists($this->block->instance->pagetypepattern, $pagetypelist)) {
157                 // Pushing block's existing page type pattern
158                 $pagetypestringname = 'page-'.str_replace('*', 'x', $this->block->instance->pagetypepattern);
159                 if (get_string_manager()->string_exists($pagetypestringname, 'pagetype')) {
160                     $pagetypelist[$this->block->instance->pagetypepattern] = get_string($pagetypestringname, 'pagetype');
161                 } else {
162                     //as a last resort we could put the page type pattern in the select box
163                     //however this causes mod-data-view to be added if the only option available is mod-data-*
164                     // so we are just showing a warning to users about their prev setting being reset
165                     $displaypagetypewarning = true;
166                 }
167             }
168         }
170         // hide page type pattern select box if there is only one choice
171         if (count($pagetypelist) > 1) {
172             if ($displaypagetypewarning) {
173                 $mform->addElement('static', 'pagetypewarning', '', get_string('pagetypewarning','block'));
174             }
176             $mform->addElement('select', 'bui_pagetypepattern', get_string('restrictpagetypes', 'block'), $pagetypelist);
177         } else {
178             $values = array_keys($pagetypelist);
179             $value = array_pop($values);
180             $mform->addElement('hidden', 'bui_pagetypepattern', $value);
181             $mform->setType('bui_pagetypepattern', PARAM_RAW);
182             // Now we are really hiding a lot (both page-contexts and page-type-patterns),
183             // specially in some systemcontext pages having only one option (my/user...)
184             // so, until it's decided if we are going to add the 'bring-back' pattern to
185             // all those pages or no (see MDL-30574), we are going to show the unique
186             // element statically
187             // TODO: Revisit this once MDL-30574 has been decided and implemented, although
188             // perhaps it's not bad to always show this statically when only one pattern is
189             // available.
190             if (!$editingatfrontpage) {
191                 // Try to beautify it
192                 $strvalue = $value;
193                 $strkey = 'page-'.str_replace('*', 'x', $strvalue);
194                 if (get_string_manager()->string_exists($strkey, 'pagetype')) {
195                     $strvalue = get_string($strkey, 'pagetype');
196                 }
197                 // Show as static (hidden has been set already)
198                 $mform->addElement('static', 'bui_staticpagetypepattern',
199                     get_string('restrictpagetypes','block'), $strvalue);
200             }
201         }
203         if ($this->page->subpage) {
204             if ($parentcontext->contextlevel == CONTEXT_USER) {
205                 $mform->addElement('hidden', 'bui_subpagepattern', '%@NULL@%');
206                 $mform->setType('bui_subpagepattern', PARAM_RAW);
207             } else {
208                 $subpageoptions = array(
209                     '%@NULL@%' => get_string('anypagematchingtheabove', 'block'),
210                     $this->page->subpage => get_string('thisspecificpage', 'block', $this->page->subpage),
211                 );
212                 $mform->addElement('select', 'bui_subpagepattern', get_string('subpages', 'block'), $subpageoptions);
213             }
214         }
216         $defaultregionoptions = $regionoptions;
217         $defaultregion = $this->block->instance->defaultregion;
218         if (!array_key_exists($defaultregion, $defaultregionoptions)) {
219             $defaultregionoptions[$defaultregion] = $defaultregion;
220         }
221         $mform->addElement('select', 'bui_defaultregion', get_string('defaultregion', 'block'), $defaultregionoptions);
222         $mform->addHelpButton('bui_defaultregion', 'defaultregion', 'block');
224         $mform->addElement('select', 'bui_defaultweight', get_string('defaultweight', 'block'), $weightoptions);
225         $mform->addHelpButton('bui_defaultweight', 'defaultweight', 'block');
227         // Where this block is positioned on this page.
228         $mform->addElement('header', 'onthispage', get_string('onthispage', 'block'));
230         $mform->addElement('selectyesno', 'bui_visible', get_string('visible', 'block'));
232         $blockregion = $this->block->instance->region;
233         if (!array_key_exists($blockregion, $regionoptions)) {
234             $regionoptions[$blockregion] = $blockregion;
235         }
236         $mform->addElement('select', 'bui_region', get_string('region', 'block'), $regionoptions);
238         $mform->addElement('select', 'bui_weight', get_string('weight', 'block'), $weightoptions);
240         $pagefields = array('bui_visible', 'bui_region', 'bui_weight');
241         if (!$this->block->user_can_edit()) {
242             $mform->hardFreezeAllVisibleExcept($pagefields);
243         }
244         if (!$this->page->user_can_edit_blocks()) {
245             $mform->hardFreeze($pagefields);
246         }
248         $this->add_action_buttons();
249     }
251     function set_data($defaults) {
252         // Prefix bui_ on all the core field names.
253         $blockfields = array('showinsubcontexts', 'pagetypepattern', 'subpagepattern', 'parentcontextid',
254                 'defaultregion', 'defaultweight', 'visible', 'region', 'weight');
255         foreach ($blockfields as $field) {
256             $newname = 'bui_' . $field;
257             $defaults->$newname = $defaults->$field;
258         }
260         // Copy block config into config_ fields.
261         if (!empty($this->block->config)) {
262             foreach ($this->block->config as $field => $value) {
263                 $configfield = 'config_' . $field;
264                 $defaults->$configfield = $value;
265             }
266         }
268         // Munge ->subpagepattern becuase HTML selects don't play nicely with NULLs.
269         if (empty($defaults->bui_subpagepattern)) {
270             $defaults->bui_subpagepattern = '%@NULL@%';
271         }
273         $systemcontext = context_system::instance();
274         if ($defaults->parentcontextid == $systemcontext->id) {
275             $defaults->bui_contexts = BUI_CONTEXTS_ENTIRE_SITE; // System-wide and sticky
276         } else {
277             $defaults->bui_contexts = $defaults->bui_showinsubcontexts;
278         }
280         parent::set_data($defaults);
281     }
283     /**
284      * Override this to create any form fields specific to this type of block.
285      * @param object $mform the form being built.
286      */
287     protected function specific_definition($mform) {
288         // By default, do nothing.
289     }