Merge branch 'MDL-47628-master' of https://github.com/sammarshallou/moodle
[moodle.git] / availability / yui / build / moodle-core_availability-form / moodle-core_availability-form.js
1 YUI.add('moodle-core_availability-form', function (Y, NAME) {
3 /**
4  * Provides interface for users to edit availability settings on the
5  * module/section editing form.
6  *
7  * The system works using this JavaScript plus form.js files inside each
8  * condition plugin.
9  *
10  * The overall concept is that data is held in a textarea in the form in JSON
11  * format. This JavaScript converts the textarea into a set of controls
12  * generated here and by the relevant plugins.
13  *
14  * (Almost) all data is held directly by the state of the HTML controls, and
15  * can be updated to the form field by calling the 'update' method, which
16  * this code and the plugins call if any HTML control changes.
17  *
18  * @module moodle-core_availability-form
19  */
20 M.core_availability = M.core_availability || {};
22 /**
23  * Core static functions for availability settings in editing form.
24  *
25  * @class M.core_availability.form
26  * @static
27  */
28 M.core_availability.form = {
29     /**
30      * Object containing installed plugins. They are indexed by plugin name.
31      *
32      * @property plugins
33      * @type Object
34      */
35     plugins : {},
37     /**
38      * Availability field (textarea).
39      *
40      * @property field
41      * @type Y.Node
42      */
43     field : null,
45     /**
46      * Main div that replaces the availability field.
47      *
48      * @property mainDiv
49      * @type Y.Node
50      */
51     mainDiv : null,
53     /**
54      * Object that represents the root of the tree.
55      *
56      * @property rootList
57      * @type M.core_availability.List
58      */
59     rootList : null,
61     /**
62      * Counter used when creating anything that needs an id.
63      *
64      * @property idCounter
65      * @type Number
66      */
67     idCounter : 0,
69     /**
70      * The 'Restrict by group' button if present.
71      *
72      * @property restrictByGroup
73      * @type Y.Node
74      */
75     restrictByGroup : null,
77     /**
78      * Called to initialise the system when the page loads. This method will
79      * also call the init method for each plugin.
80      *
81      * @method init
82      */
83     init : function(pluginParams) {
84         // Init all plugins.
85         for(var plugin in pluginParams) {
86             var params = pluginParams[plugin];
87             var pluginClass = M[params[0]].form;
88             pluginClass.init.apply(pluginClass, params);
89         }
91         // Get the availability field, hide it, and replace with the main div.
92         this.field = Y.one('#id_availabilityconditionsjson');
93         this.field.setAttribute('aria-hidden', 'true');
94         // The fcontainer class here is inappropriate, but is necessary
95         // because otherwise it is impossible to make Behat work correctly on
96         // these controls as Behat incorrectly decides they're a moodleform
97         // textarea. IMO Behat should not know about moodleforms at all and
98         // should look purely at HTML elements on the page, but until it is
99         // fixed to do this or fixed in some other way to only detect moodleform
100         // elements that specifically match what those elements should look like,
101         // then there is no good solution.
102         this.mainDiv = Y.Node.create('<div class="availability-field fcontainer"></div>');
103         this.field.insert(this.mainDiv, 'after');
105         // Get top-level tree as JSON.
106         var value = this.field.get('value');
107         var data = null;
108         if (value !== '') {
109             try {
110                 data = Y.JSON.parse(value);
111             } catch(x) {
112                 // If the JSON data is not valid, treat it as empty.
113                 this.field.set('value', '');
114             }
115         }
116         this.rootList = new M.core_availability.List(data, true);
117         this.mainDiv.appendChild(this.rootList.node);
119         // Update JSON value after loading (to reflect any changes that need
120         // to be made to make it valid).
121         this.update();
122         this.rootList.renumber();
124         // Mark main area as dynamically updated.
125         this.mainDiv.setAttribute('aria-live', 'polite');
127         // Listen for form submission - to avoid having our made-up fields
128         // submitted, we need to disable them all before submit.
129         this.field.ancestor('form').on('submit', function() {
130             this.mainDiv.all('input,textarea,select').set('disabled', true);
131         }, this);
133         // If the form has group mode and/or grouping options, there is a
134         // 'add restriction' button there.
135         this.restrictByGroup = Y.one('#restrictbygroup');
136         if (this.restrictByGroup) {
137             this.restrictByGroup.on('click', this.addRestrictByGroup, this);
138             var groupmode = Y.one('#id_groupmode');
139             var groupingid = Y.one('#id_groupingid');
140             if (groupmode) {
141                 groupmode.on('change', this.updateRestrictByGroup, this);
142             }
143             if (groupingid) {
144                 groupingid.on('change', this.updateRestrictByGroup, this);
145             }
146             this.updateRestrictByGroup();
147         }
148     },
150     /**
151      * Called at any time to update the hidden field value.
152      *
153      * This should be called whenever any value changes in the form settings.
154      *
155      * @method update
156      */
157     update : function() {
158         // Convert tree to value.
159         var jsValue = this.rootList.getValue();
161         // Store any errors (for form reporting) in 'errors' value if present.
162         var errors = [];
163         this.rootList.fillErrors(errors);
164         if (errors.length !== 0) {
165             jsValue.errors = errors;
166         }
168         // Set into hidden form field, JS-encoded.
169         this.field.set('value', Y.JSON.stringify(jsValue));
171         // Also update the restrict by group button if present.
172         this.updateRestrictByGroup();
173     },
175     /**
176      * Updates the status of the 'restrict by group' button (enables or disables
177      * it) based on current availability restrictions and group/grouping settings.
178      */
179     updateRestrictByGroup : function() {
180         if (!this.restrictByGroup) {
181             return;
182         }
184         // If the root list is anything other than the default 'and' type, disable.
185         if (this.rootList.getValue().op !== '&') {
186             this.restrictByGroup.set('disabled', true);
187             return;
188         }
190         // If there's already a group restriction, disable it.
191         var alreadyGot = this.rootList.hasItemOfType('group') ||
192                 this.rootList.hasItemOfType('grouping');
193         if (alreadyGot) {
194             this.restrictByGroup.set('disabled', true);
195             return;
196         }
198         // If the groupmode and grouping id aren't set, disable it.
199         var groupmode = Y.one('#id_groupmode');
200         var groupingid = Y.one('#id_groupingid');
201         if ((!groupmode || Number(groupmode.get('value')) === 0) &&
202                 (!groupingid || Number(groupingid.get('value')) === 0)) {
203             this.restrictByGroup.set('disabled', true);
204             return;
205         }
207         this.restrictByGroup.set('disabled', false);
208     },
210     /**
211      * Called when the user clicks on the 'restrict by group' button. This is
212      * a special case that adds a group or grouping restriction.
213      *
214      * By default this restriction is not shown which makes it similar to the
215      *
216      * @param e Button click event
217      */
218     addRestrictByGroup : function(e) {
219         // If you don't prevent default, it submits the form for some reason.
220         e.preventDefault();
222         // Add the condition.
223         var groupingid = Y.one('#id_groupingid');
224         var newChild;
225         if (groupingid && Number(groupingid.get('value')) !== 0) {
226             // Add a grouping restriction if one is specified.
227             newChild = new M.core_availability.Item(
228                     {type : 'grouping', id : Number(groupingid.get('value'))}, true);
229         } else {
230             // Otherwise just add a group restriction.
231             newChild = new M.core_availability.Item({type : 'group'}, true);
232         }
234         // Refresh HTML.
235         this.rootList.addChild(newChild);
236         this.update();
237         this.rootList.renumber();
238         this.rootList.updateHtml();
239     }
240 };
243 /**
244  * Base object for plugins. Plugins should use Y.Object to extend this class.
245  *
246  * @class M.core_availability.plugin
247  * @static
248  */
249 M.core_availability.plugin = {
250     /**
251      * True if users are allowed to add items of this plugin at the moment.
252      *
253      * @property allowAdd
254      * @type Boolean
255      */
256     allowAdd : false,
258     /**
259      * Called (from PHP) to initialise the plugin. Should usually not be
260      * overridden by child plugin.
261      *
262      * @method init
263      * @param {String} component Component name e.g. 'availability_date'
264      */
265     init : function(component, allowAdd, params) {
266         var name = component.replace(/^availability_/, '');
267         this.allowAdd = allowAdd;
268         M.core_availability.form.plugins[name] = this;
269         this.initInner.apply(this, params);
270     },
272     /**
273      * Init method for plugin to override. (Default does nothing.)
274      *
275      * This method will receive any parameters defined in frontend.php
276      * get_javascript_init_params.
277      *
278      * @method initInner
279      * @protected
280      */
281     initInner : function() {
282     },
284     /**
285      * Gets a YUI node representing the controls for this plugin on the form.
286      *
287      * Must be implemented by sub-object; default throws an exception.
288      *
289      * @method getNode
290      * @return {Y.Node} YUI node
291      */
292     getNode : function() {
293         throw 'getNode not implemented';
294     },
296     /**
297      * Fills in the value from this plugin's controls into a value object,
298      * which will later be converted to JSON and stored in the form field.
299      *
300      * Must be implemented by sub-object; default throws an exception.
301      *
302      * @method fillValue
303      * @param {Object} value Value object (to be written to)
304      * @param {Y.Node} node YUI node (same one returned from getNode)
305      */
306     fillValue : function() {
307         throw 'fillValue not implemented';
308     },
310     /**
311      * Fills in any errors from this plugin's controls. If there are any
312      * errors, push them into the supplied array.
313      *
314      * Errors are Moodle language strings in format component:string, e.g.
315      * 'availability_date:error_date_past_end_of_world'.
316      *
317      * The default implementation does nothing.
318      *
319      * @method fillErrors
320      * @param {Array} errors Array of errors (push new errors here)
321      * @param {Y.Node} node YUI node (same one returned from getNode)
322      */
323     fillErrors : function() {
324     },
326     /**
327      * Focuses the first thing in the plugin after it has been added.
328      *
329      * The default implementation uses a simple algorithm to identify the
330      * first focusable input/select and then focuses it.
331      */
332     focusAfterAdd : function(node) {
333         var target = node.one('input:not([disabled]),select:not([disabled])');
334         target.focus();
335     }
336 };
339 /**
340  * Maintains a list of children and settings for how they are combined.
341  *
342  * @class M.core_availability.List
343  * @constructor
344  * @param {Object} json Decoded JSON value
345  * @param {Boolean} [false] root True if this is root level list
346  * @param {Boolean} [false] root True if parent is root level list
347  */
348 M.core_availability.List = function(json, root, parentRoot) {
349     // Set default value for children. (You can't do this in the prototype
350     // definition, or it ends up sharing the same array between all of them.)
351     this.children = [];
353     if (root !== undefined) {
354         this.root = root;
355     }
356     // Create DIV structure (without kids).
357     this.node = Y.Node.create('<div class="availability-list"><h3 class="accesshide"></h3>' +
358             '<div class="availability-inner">' +
359             '<div class="availability-header">' + M.util.get_string('listheader_sign_before', 'availability') +
360             ' <label><span class="accesshide">' + M.util.get_string('label_sign', 'availability') +
361             ' </span><select class="availability-neg" title="' + M.util.get_string('label_sign', 'availability') + '">' +
362             '<option value="">' + M.util.get_string('listheader_sign_pos', 'availability') + '</option>' +
363             '<option value="!">' + M.util.get_string('listheader_sign_neg', 'availability') + '</option></select></label> ' +
364             '<span class="availability-single">' + M.util.get_string('listheader_single', 'availability') + '</span>' +
365             '<span class="availability-multi">' + M.util.get_string('listheader_multi_before', 'availability') +
366             ' <label><span class="accesshide">' + M.util.get_string('label_multi', 'availability') + ' </span>' +
367             '<select class="availability-op" title="' + M.util.get_string('label_multi', 'availability') + '"><option value="&">' +
368             M.util.get_string('listheader_multi_and', 'availability') + '</option>' +
369             '<option value="|">' + M.util.get_string('listheader_multi_or', 'availability') + '</option></select></label> ' +
370             M.util.get_string('listheader_multi_after', 'availability') + '</span></div>' +
371             '<div class="availability-children"></div>' +
372             '<div class="availability-none">' + M.util.get_string('none', 'moodle') + '</div>' +
373             '<div class="availability-button"></div></div></div>');
374     if (!root) {
375         this.node.addClass('availability-childlist');
376     }
377     this.inner = this.node.one('> .availability-inner');
379     var shown = true;
380     if (root) {
381         // If it's the root, add an eye icon as first thing in header.
382         if (json && json.show !== undefined) {
383             shown = json.show;
384         }
385         this.eyeIcon = new M.core_availability.EyeIcon(false, shown);
386         this.node.one('.availability-header').get('firstChild').insert(
387                 this.eyeIcon.span, 'before');
388     } else if (parentRoot) {
389         // When the parent is root, add an eye icon before the main list div.
390         if (json && json.showc !== undefined) {
391             shown = json.showc;
392         }
393         this.eyeIcon = new M.core_availability.EyeIcon(false, shown);
394         this.inner.insert(this.eyeIcon.span, 'before');
395     }
397     if (!root) {
398         // If it's not the root, add a delete button to the 'none' option.
399         // You can only delete lists when they have no children so this will
400         // automatically appear at the correct time.
401         var deleteIcon = new M.core_availability.DeleteIcon(this);
402         var noneNode = this.node.one('.availability-none');
403         noneNode.appendChild(document.createTextNode(' '));
404         noneNode.appendChild(deleteIcon.span);
406         // Also if it's not the root, none is actually invalid, so add a label.
407         noneNode.appendChild(Y.Node.create('<span class="label label-warning">' +
408                 M.util.get_string('invalid', 'availability') + '</span>'));
409     }
411     // Create the button and add it.
412     var button = Y.Node.create('<button type="button" class="btn btn-default">' +
413             M.util.get_string('addrestriction', 'availability') + '</button>');
414     button.on("click", function() { this.clickAdd(); }, this);
415     this.node.one('div.availability-button').appendChild(button);
417     if (json) {
418         // Set operator from JSON data.
419         switch (json.op) {
420             case '&' :
421             case '|' :
422                 this.node.one('.availability-neg').set('value', '');
423                 break;
424             case '!&' :
425             case '!|' :
426                 this.node.one('.availability-neg').set('value', '!');
427                 break;
428         }
429         switch (json.op) {
430             case '&' :
431             case '!&' :
432                 this.node.one('.availability-op').set('value', '&');
433                 break;
434             case '|' :
435             case '!|' :
436                 this.node.one('.availability-op').set('value', '|');
437                 break;
438         }
440         // Construct children.
441         for (var i = 0; i < json.c.length; i++) {
442             var child = json.c[i];
443             if (this.root && json && json.showc !== undefined) {
444                 child.showc = json.showc[i];
445             }
446             var newItem;
447             if (child.type !== undefined) {
448                 // Plugin type.
449                 newItem = new M.core_availability.Item(child, this.root);
450             } else {
451                 // List type.
452                 newItem = new M.core_availability.List(child, false, this.root);
453             }
454             this.addChild(newItem);
455         }
456     }
458     // Add update listeners to the dropdowns.
459     this.node.one('.availability-neg').on('change', function() {
460         // Update hidden field and HTML.
461         M.core_availability.form.update();
462         this.updateHtml();
463     }, this);
464     this.node.one('.availability-op').on('change', function() {
465         // Update hidden field.
466         M.core_availability.form.update();
467         this.updateHtml();
468     }, this);
470     // Update HTML to hide unnecessary parts.
471     this.updateHtml();
472 };
474 /**
475  * Adds a child to the end of the list (in HTML and stored data).
476  *
477  * @method addChild
478  * @private
479  * @param {M.core_availability.Item|M.core_availability.List} newItem Child to add
480  */
481 M.core_availability.List.prototype.addChild = function(newItem) {
482     if (this.children.length > 0) {
483         // Create connecting label (text will be filled in later by updateHtml).
484         this.inner.one('.availability-children').appendChild(Y.Node.create(
485                 '<div class="availability-connector">' +
486                 '<span class="label"></span>' +
487                 '</div>'));
488     }
489     // Add item to array and to HTML.
490     this.children.push(newItem);
491     this.inner.one('.availability-children').appendChild(newItem.node);
492 };
494 /**
495  * Focuses something after a new list is added.
496  *
497  * @method focusAfterAdd
498  */
499 M.core_availability.List.prototype.focusAfterAdd = function() {
500     this.inner.one('button').focus();
501 };
503 /**
504  * Checks whether this list uses the individual show icons or the single one.
505  *
506  * (Basically, AND and the equivalent NOT OR list can have individual show icons
507  * so that you hide the activity entirely if a user fails one condition, but
508  * may display it with information about the condition if they fail a different
509  * one. That isn't possible with OR and NOT AND because for those types, there
510  * is not really a concept of which single condition caused the user to fail
511  * it.)
512  *
513  * Method can only be called on the root list.
514  *
515  * @method isIndividualShowIcons
516  * @return {Boolean} True if using the individual icons
517  */
518 M.core_availability.List.prototype.isIndividualShowIcons = function() {
519     if (!this.root) {
520         throw 'Can only call this on root list';
521     }
522     var neg = this.node.one('.availability-neg').get('value') === '!';
523     var isor = this.node.one('.availability-op').get('value') === '|';
524     return (!neg && !isor) || (neg && isor);
525 };
527 /**
528  * Renumbers the list and all children.
529  *
530  * @method renumber
531  * @param {String} parentNumber Number to use in heading for this list
532  */
533 M.core_availability.List.prototype.renumber = function(parentNumber) {
534     // Update heading for list.
535     var headingParams = { count: this.children.length };
536     var prefix;
537     if (parentNumber === undefined) {
538         headingParams.number = '';
539         prefix = '';
540     } else {
541         headingParams.number = parentNumber + ':';
542         prefix = parentNumber + '.';
543     }
544     var heading = M.util.get_string('setheading', 'availability', headingParams);
545     this.node.one('> h3').set('innerHTML', heading);
547     // Do children.
548     for (var i = 0; i < this.children.length; i++) {
549         var child = this.children[i];
550         child.renumber(prefix + (i + 1));
551     }
552 };
554 /**
555  * Updates HTML for the list based on the current values, for example showing
556  * the 'None' text if there are no children.
557  *
558  * @method updateHtml
559  */
560 M.core_availability.List.prototype.updateHtml = function() {
561     // Control children appearing or not appearing.
562     if (this.children.length > 0) {
563         this.inner.one('> .availability-children').removeAttribute('aria-hidden');
564         this.inner.one('> .availability-none').setAttribute('aria-hidden', 'true');
565         this.inner.one('> .availability-header').removeAttribute('aria-hidden');
566         if (this.children.length > 1) {
567             this.inner.one('.availability-single').setAttribute('aria-hidden', 'true');
568             this.inner.one('.availability-multi').removeAttribute('aria-hidden');
569         } else {
570             this.inner.one('.availability-single').removeAttribute('aria-hidden');
571             this.inner.one('.availability-multi').setAttribute('aria-hidden', 'true');
572         }
573     } else {
574         this.inner.one('> .availability-children').setAttribute('aria-hidden', 'true');
575         this.inner.one('> .availability-none').removeAttribute('aria-hidden');
576         this.inner.one('> .availability-header').setAttribute('aria-hidden', 'true');
577     }
579     // For root list, control eye icons.
580     if (this.root) {
581         var showEyes = this.isIndividualShowIcons();
583         // Individual icons.
584         for (var i = 0; i < this.children.length; i++) {
585             var child = this.children[i];
586             if (showEyes) {
587                 child.eyeIcon.span.removeAttribute('aria-hidden');
588             } else {
589                 child.eyeIcon.span.setAttribute('aria-hidden', 'true');
590             }
591         }
593         // Single icon is the inverse.
594         if (showEyes) {
595             this.eyeIcon.span.setAttribute('aria-hidden', 'true');
596         } else {
597             this.eyeIcon.span.removeAttribute('aria-hidden');
598         }
599     }
601     // Update connector text.
602     var connectorText;
603     if (this.inner.one('.availability-op').get('value') === '&') {
604         connectorText = M.util.get_string('and', 'availability');
605     } else {
606         connectorText = M.util.get_string('or', 'availability');
607     }
608     this.inner.all('> .availability-children > .availability-connector span.label').each(function(span) {
609         span.set('innerHTML', connectorText);
610     });
611 };
613 /**
614  * Deletes a descendant item (Item or List). Called when the user clicks a
615  * delete icon.
616  *
617  * This is a recursive function.
618  *
619  * @method deleteDescendant
620  * @param {M.core_availability.Item|M.core_availability.List} descendant Item to delete
621  * @return {Boolean} True if it was deleted
622  */
623 M.core_availability.List.prototype.deleteDescendant = function(descendant) {
624     // Loop through children.
625     for (var i = 0; i < this.children.length; i++) {
626         var child = this.children[i];
627         if (child === descendant) {
628             // Remove from internal array.
629             this.children.splice(i, 1);
630             var target = child.node;
631             // Remove one of the connector nodes around target (if any left).
632             if (this.children.length > 0) {
633                 if (target.previous('.availability-connector')) {
634                     target.previous('.availability-connector').remove();
635                 } else {
636                     target.next('.availability-connector').remove();
637                 }
638             }
639             // Remove target itself.
640             this.inner.one('> .availability-children').removeChild(target);
641             // Update the form and the list HTML.
642             M.core_availability.form.update();
643             this.updateHtml();
644             // Focus add button for this list.
645             this.inner.one('> .availability-button').one('button').focus();
646             return true;
647         } else if (child instanceof M.core_availability.List) {
648             // Recursive call.
649             var found = child.deleteDescendant(descendant);
650             if (found) {
651                 return true;
652             }
653         }
654     }
656     return false;
657 };
659 /**
660  * Shows the 'add restriction' dialogue box.
661  *
662  * @method clickAdd
663  */
664 M.core_availability.List.prototype.clickAdd = function() {
665     var content = Y.Node.create('<div>' +
666             '<ul class="list-unstyled"></ul>' +
667             '<div class="availability-buttons mdl-align">' +
668             '<button type="button" class="btn btn-default">' + M.util.get_string('cancel', 'moodle') +
669             '</button></div></div>');
670     var cancel = content.one('button');
672     // Make a list of all the dialog options.
673     var dialogRef = { dialog: null };
674     var ul = content.one('ul');
675     var li, id, button, label;
676     for (var type in M.core_availability.form.plugins) {
677         // Plugins might decide not to display their add button.
678         if (!M.core_availability.form.plugins[type].allowAdd) {
679             continue;
680         }
681         // Add entry for plugin.
682         li = Y.Node.create('<li class="clearfix"></li>');
683         id = 'availability_addrestriction_' + type;
684         button = Y.Node.create('<button type="button" class="btn btn-default"' +
685                 'id="' + id + '">' + M.util.get_string('title', 'availability_' + type) + '</button>');
686         button.on('click', this.getAddHandler(type, dialogRef), this);
687         li.appendChild(button);
688         label = Y.Node.create('<label for="' + id + '">' +
689                 M.util.get_string('description', 'availability_' + type) + '</label>');
690         li.appendChild(label);
691         ul.appendChild(li);
692     }
693     // Extra entry for lists.
694     li = Y.Node.create('<li class="clearfix"></li>');
695     id = 'availability_addrestriction_list_';
696     button = Y.Node.create('<button type="button" class="btn btn-default"' +
697             'id="' + id + '">' + M.util.get_string('condition_group', 'availability') + '</button>');
698     button.on('click', this.getAddHandler(null, dialogRef), this);
699     li.appendChild(button);
700     label = Y.Node.create('<label for="' + id + '">' +
701             M.util.get_string('condition_group_info', 'availability') + '</label>');
702     li.appendChild(label);
703     ul.appendChild(li);
705     var config = {
706         headerContent : M.util.get_string('addrestriction', 'availability'),
707         bodyContent : content,
708         additionalBaseClass : 'availability-dialogue',
709         draggable : true,
710         modal : true,
711         closeButton : false,
712         width : '450px'
713     };
714     dialogRef.dialog = new M.core.dialogue(config);
715     dialogRef.dialog.show();
716     cancel.on('click', function() {
717         dialogRef.dialog.destroy();
718         // Focus the button they clicked originally.
719         this.inner.one('> .availability-button').one('button').focus();
720     }, this);
721 };
723 /**
724  * Gets an add handler function used by the dialogue to add a particular item.
725  *
726  * @method getAddHandler
727  * @param {String|Null} type Type name of plugin or null to add lists
728  * @param {Object} dialogRef Reference to object that contains dialog
729  * @param {M.core.dialogue} dialogRef.dialog Dialog object
730  * @return {Function} Add handler function to call when adding that thing
731  */
732 M.core_availability.List.prototype.getAddHandler = function(type, dialogRef) {
733     return function() {
734         if (type) {
735             // Create an Item object to represent the child.
736             newItem = new M.core_availability.Item({ type: type, creating: true }, this.root);
737         } else {
738             // Create a new List object to represent the child.
739             newItem = new M.core_availability.List({ c: [], showc: true }, false, this.root);
740         }
741         // Add to list.
742         this.addChild(newItem);
743         // Update the form and list HTML.
744         M.core_availability.form.update();
745         M.core_availability.form.rootList.renumber();
746         this.updateHtml();
747         // Hide dialog.
748         dialogRef.dialog.destroy();
749         newItem.focusAfterAdd();
750     };
751 };
753 /**
754  * Gets the value of the list ready to convert to JSON and fill form field.
755  *
756  * @method getValue
757  * @return {Object} Value of list suitable for use in JSON
758  */
759 M.core_availability.List.prototype.getValue = function() {
760     // Work out operator from selects.
761     var value = {};
762     value.op = this.node.one('.availability-neg').get('value') +
763             this.node.one('.availability-op').get('value');
765     // Work out children from list.
766     value.c = [];
767     var i;
768     for (i = 0; i < this.children.length; i++) {
769         value.c.push(this.children[i].getValue());
770     }
772     // Work out show/showc for root level.
773     if (this.root) {
774         if (this.isIndividualShowIcons()) {
775             value.showc = [];
776             for (i = 0; i < this.children.length; i++) {
777                 value.showc.push(!this.children[i].eyeIcon.isHidden());
778             }
779         } else {
780             value.show = !this.eyeIcon.isHidden();
781         }
782     }
783     return value;
784 };
786 /**
787  * Checks whether this list has any errors (incorrect user input). If so,
788  * an error string identifier in the form langfile:langstring should be pushed
789  * into the errors array.
790  *
791  * @method fillErrors
792  * @param {Array} errors Array of errors so far
793  */
794 M.core_availability.List.prototype.fillErrors = function(errors) {
795     // List with no items is an error (except root).
796     if (this.children.length === 0 && !this.root) {
797         errors.push('availability:error_list_nochildren');
798     }
799     // Pass to children.
800     for (var i = 0; i < this.children.length; i++) {
801         this.children[i].fillErrors(errors);
802     }
803 };
805 /**
806  * Checks whether the list contains any items of the given type name.
807  *
808  * @method hasItemOfType
809  * @param {String} pluginType Required plugin type (name)
810  * @return {Boolean} True if there is one
811  */
812 M.core_availability.List.prototype.hasItemOfType = function(pluginType) {
813     // Check each item.
814     for (var i = 0; i < this.children.length; i++) {
815         var child = this.children[i];
816         if (child instanceof M.core_availability.List) {
817             // Recursive call.
818             if (child.hasItemOfType(pluginType)) {
819                 return true;
820             }
821         } else {
822             if (child.pluginType === pluginType) {
823                 return true;
824             }
825         }
826     }
827     return false;
828 };
830 /**
831  * Eye icon for this list (null if none).
832  *
833  * @property eyeIcon
834  * @type M.core_availability.EyeIcon
835  */
836 M.core_availability.List.prototype.eyeIcon = null;
838 /**
839  * True if list is special root level list.
840  *
841  * @property root
842  * @type Boolean
843  */
844 M.core_availability.List.prototype.root = false;
846 /**
847  * Array containing children (Lists or Items).
848  *
849  * @property children
850  * @type M.core_availability.List[]|M.core_availability.Item[]
851  */
852 M.core_availability.List.prototype.children = null;
854 /**
855  * HTML outer node for list.
856  *
857  * @property node
858  * @type Y.Node
859  */
860 M.core_availability.List.prototype.node = null;
862 /**
863  * HTML node for inner div that actually is the displayed list.
864  *
865  * @property node
866  * @type Y.Node
867  */
868 M.core_availability.List.prototype.inner = null;
871 /**
872  * Represents a single condition.
873  *
874  * @class M.core_availability.Item
875  * @constructor
876  * @param {Object} json Decoded JSON value
877  * @param {Boolean} root True if this item is a child of the root list.
878  */
879 M.core_availability.Item = function(json, root) {
880     this.pluginType = json.type;
881     if (M.core_availability.form.plugins[json.type] === undefined) {
882         // Handle undefined plugins.
883         this.plugin = null;
884         this.pluginNode = Y.Node.create('<div class="availability-warning">' +
885                 M.util.get_string('missingplugin', 'availability') + '</div>');
886     } else {
887         // Plugin is known.
888         this.plugin = M.core_availability.form.plugins[json.type];
889         this.pluginNode = this.plugin.getNode(json);
891         // Add a class with the plugin Frankenstyle name to make CSS easier in plugin.
892         this.pluginNode.addClass('availability_' + json.type);
893     }
895     this.node = Y.Node.create('<div class="availability-item"><h3 class="accesshide"></h3></div>');
897     // Add eye icon if required. This icon is added for root items, but may be
898     // hidden depending on the selected list operator.
899     if (root) {
900         var shown = true;
901         if(json.showc !== undefined) {
902             shown = json.showc;
903         }
904         this.eyeIcon = new M.core_availability.EyeIcon(true, shown);
905         this.node.appendChild(this.eyeIcon.span);
906     }
908     // Add plugin controls.
909     this.pluginNode.addClass('availability-plugincontrols');
910     this.node.appendChild(this.pluginNode);
912     // Add delete button for node.
913     var deleteIcon = new M.core_availability.DeleteIcon(this);
914     this.node.appendChild(deleteIcon.span);
916     // Add the invalid marker (empty).
917     this.node.appendChild(document.createTextNode(' '));
918     this.node.appendChild(Y.Node.create('<span class="label label-warning"/>'));
919 };
921 /**
922  * Obtains the value of this condition, which will be serialized into JSON
923  * format and stored in the form.
924  *
925  * @method getValue
926  * @return {Object} JavaScript object containing value of this item
927  */
928 M.core_availability.Item.prototype.getValue = function() {
929     value = { 'type' : this.pluginType };
930     if (this.plugin) {
931         this.plugin.fillValue(value, this.pluginNode);
932     }
933     return value;
934 };
936 /**
937  * Checks whether this condition has any errors (incorrect user input). If so,
938  * an error string identifier in the form langfile:langstring should be pushed
939  * into the errors array.
940  *
941  * @method fillErrors
942  * @param {Array} errors Array of errors so far
943  */
944 M.core_availability.Item.prototype.fillErrors = function(errors) {
945     var before = errors.length;
946     if (this.plugin) {
947         // Pass to plugin.
948         this.plugin.fillErrors(errors, this.pluginNode);
949     } else {
950         // Unknown plugin is an error
951         errors.push('core_availability:item_unknowntype');
952     }
953     // If any errors were added, add the marker to this item.
954     var errorLabel = this.node.one('> .label-warning');
955     if (errors.length !== before && !errorLabel.get('firstChild')) {
956         errorLabel.appendChild(document.createTextNode(M.util.get_string('invalid', 'availability')));
957     } else if (errors.length === before && errorLabel.get('firstChild')) {
958         errorLabel.get('firstChild').remove();
959     }
960 };
962 /**
963  * Renumbers the item.
964  *
965  * @method renumber
966  * @param {String} number Number to use in heading for this item
967  */
968 M.core_availability.Item.prototype.renumber = function(number) {
969     // Update heading for item.
970     var headingParams = { number: number };
971     if (this.plugin) {
972         headingParams.type = M.util.get_string('title', 'availability_' + this.pluginType);
973     } else {
974         headingParams.type = '[' + this.pluginType + ']';
975     }
976     headingParams.number = number + ':';
977     var heading = M.util.get_string('itemheading', 'availability', headingParams);
978     this.node.one('> h3').set('innerHTML', heading);
979 };
981 /**
982  * Focuses something after a new item is added.
983  *
984  * @method focusAfterAdd
985  */
986 M.core_availability.Item.prototype.focusAfterAdd = function() {
987     this.plugin.focusAfterAdd(this.pluginNode);
988 };
990 /**
991  * Name of plugin.
992  *
993  * @property pluginType
994  * @type String
995  */
996 M.core_availability.Item.prototype.pluginType = null;
998 /**
999  * Object representing plugin form controls.
1000  *
1001  * @property plugin
1002  * @type Object
1003  */
1004 M.core_availability.Item.prototype.plugin = null;
1006 /**
1007  * Eye icon for item.
1008  *
1009  * @property eyeIcon
1010  * @type M.core_availability.EyeIcon
1011  */
1012 M.core_availability.Item.prototype.eyeIcon = null;
1014 /**
1015  * HTML node for item.
1016  *
1017  * @property node
1018  * @type Y.Node
1019  */
1020 M.core_availability.Item.prototype.node = null;
1022 /**
1023  * Inner part of node that is owned by plugin.
1024  *
1025  * @property pluginNode
1026  * @type Y.Node
1027  */
1028 M.core_availability.Item.prototype.pluginNode = null;
1031 /**
1032  * Eye icon (to control show/hide of the activity if the user fails a condition).
1033  *
1034  * There are individual eye icons (show/hide control for a single condition) and
1035  * 'all' eye icons (show/hide control that applies to the entire item, whatever
1036  * reason it fails for). This is necessary because the individual conditions
1037  * don't make sense for OR and AND NOT lists.
1038  *
1039  * @class M.core_availability.EyeIcon
1040  * @constructor
1041  * @param {Boolean} individual True if the icon is controlling a single condition
1042  * @param {Boolean} shown True if icon is initially in shown state
1043  */
1044 M.core_availability.EyeIcon = function(individual, shown) {
1045     this.individual = individual;
1046     this.span = Y.Node.create('<a class="availability-eye" href="#" role="button">');
1047     var icon = Y.Node.create('<img />');
1048     this.span.appendChild(icon);
1050     // Set up button text and icon.
1051     var suffix = individual ? '_individual' : '_all',
1052         setHidden = function() {
1053             var hiddenStr = M.util.get_string('hidden' + suffix, 'availability');
1054             icon.set('src', M.util.image_url('i/show', 'core'));
1055             icon.set('alt', hiddenStr);
1056             this.span.set('title', hiddenStr + ' \u2022 ' +
1057                     M.util.get_string('show_verb', 'availability'));
1058         },
1059         setShown = function() {
1060             var shownStr = M.util.get_string('shown' + suffix, 'availability');
1061             icon.set('src', M.util.image_url('i/hide', 'core'));
1062             icon.set('alt', shownStr);
1063             this.span.set('title', shownStr + ' \u2022 ' +
1064                     M.util.get_string('hide_verb', 'availability'));
1065         };
1066     if(shown) {
1067         setShown.call(this);
1068     } else {
1069         setHidden.call(this);
1070     }
1072     // Update when button is clicked.
1073     var click = function(e) {
1074         e.preventDefault();
1075         if (this.isHidden()) {
1076             setShown.call(this);
1077         } else {
1078             setHidden.call(this);
1079         }
1080         M.core_availability.form.update();
1081     };
1082     this.span.on('click', click, this);
1083     this.span.on('key', click, 'up:32', this);
1084     this.span.on('key', function(e) { e.preventDefault(); }, 'down:32', this);
1085 };
1087 /**
1088  * True if this eye icon is an individual one (see above).
1089  *
1090  * @property individual
1091  * @type Boolean
1092  */
1093 M.core_availability.EyeIcon.prototype.individual = false;
1095 /**
1096  * YUI node for the span that contains this icon.
1097  *
1098  * @property span
1099  * @type Y.Node
1100  */
1101 M.core_availability.EyeIcon.prototype.span = null;
1103 /**
1104  * Checks the current state of the icon.
1105  *
1106  * @method isHidden
1107  * @return {Boolean} True if this icon is set to 'hidden'
1108  */
1109 M.core_availability.EyeIcon.prototype.isHidden = function() {
1110     var suffix = this.individual ? '_individual' : '_all',
1111         compare = M.util.get_string('hidden' + suffix, 'availability');
1112     return this.span.one('img').get('alt') === compare;
1113 };
1116 /**
1117  * Delete icon (to delete an Item or List).
1118  *
1119  * @class M.core_availability.DeleteIcon
1120  * @constructor
1121  * @param {M.core_availability.Item|M.core_availability.List} toDelete Thing to delete
1122  */
1123 M.core_availability.DeleteIcon = function(toDelete) {
1124     this.span = Y.Node.create('<a class="availability-delete" href="#" title="' +
1125             M.util.get_string('delete', 'moodle') + '" role="button">');
1126     var img = Y.Node.create('<img src="' + M.util.image_url('t/delete', 'core') +
1127             '" alt="' + M.util.get_string('delete', 'moodle') + '" />');
1128     this.span.appendChild(img);
1129     var click = function(e) {
1130         e.preventDefault();
1131         M.core_availability.form.rootList.deleteDescendant(toDelete);
1132         M.core_availability.form.rootList.renumber();
1133     };
1134     this.span.on('click', click, this);
1135     this.span.on('key', click, 'up:32', this);
1136     this.span.on('key', function(e) { e.preventDefault(); }, 'down:32', this);
1137 };
1139 /**
1140  * YUI node for the span that contains this icon.
1141  *
1142  * @property span
1143  * @type Y.Node
1144  */
1145 M.core_availability.DeleteIcon.prototype.span = null;
1148 }, '@VERSION@', {"requires": ["base", "node", "event", "panel", "moodle-core-notification-dialogue", "json"]});