lib/amd/src/modal_registry.js

   1 // This file is part of Moodle - http://moodle.org/
   2 //
   3 // Moodle is free software: you can redistribute it and/or modify
   4 // it under the terms of the GNU General Public License as published by
   5 // the Free Software Foundation, either version 3 of the License, or
   6 // (at your option) any later version.
   7 //
   8 // Moodle is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 // GNU General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU General Public License
  14 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  15
  16 /**
  17  * A registry for the different types of modal.
  18  *
  19  * @module     core/modal_registry
  20  * @class      modal_registry
  21  * @package    core
  22  * @copyright  2016 Ryan Wyllie <ryan@moodle.com>
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25 define(['core/notification'], function(Notification) {
  26
  27     // A singleton registry for all modules to access. Allows types to be
  28     // added at runtime.
  29     var registry = {};
  30
  31     /**
  32      * Get a registered type of modal.
  33      *
  34      * @method get
  35      * @param {string} type The type of modal to get
  36      * @return {object} The registered config for the modal
  37      */
  38     var get = function(type) {
  39         return registry[type];
  40     };
  41
  42     /**
  43      * Register a modal with the registry.
  44      *
  45      * @method register
  46      * @param {string} type The type of modal (must be unique)
  47      * @param {function} module The modal module (must be a constructor function of type core/modal)
  48      * @param {string} template The template name of the modal
  49      */
  50     var register = function(type, module, template) {
  51         if (get(type)) {
  52             Notification.exception({message: "Modal of  type '" + type + "' is already registered"});
  53         }
  54
  55         if (!module || typeof module !== 'function') {
  56             Notification.exception({message: "You must provide a modal module"});
  57         }
  58
  59         if (!template) {
  60             Notification.exception({message: "You must provide a modal template"});
  61         }
  62
  63         registry[type] = {
  64             module: module,
  65             template: template,
  66         };
  67     };
  68
  69     return {
  70         register: register,
  71         get: get,
  72     };
  73 });