2 // This file is part of Moodle - http://moodle.org/
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 * RequireJS helper functions.
21 * @copyright 2015 Damyon Wiese <damyon@moodle.com>
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25 defined('MOODLE_INTERNAL') ||
die();
28 * Collection of requirejs related methods.
30 * @copyright 2015 Damyon Wiese <damyon@moodle.com>
31 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33 class core_requirejs
{
36 * Check a single module exists and return the full path to it.
38 * The expected location for amd modules is:
39 * <componentdir>/amd/src/modulename.js
41 * @param string $component The component determines the folder the js file should be in.
42 * @param string $jsfilename The filename for the module (with the js extension).
43 * @param boolean $debug If true, returns the paths to the original (unminified) source files.
44 * @return array $files An array of mappings from module names to file paths.
45 * Empty array if the file does not exist.
47 public static function find_one_amd_module($component, $jsfilename, $debug = false) {
48 $jsfileroot = core_component
::get_component_directory($component);
53 $module = str_replace('.js', '', $jsfilename);
55 $srcdir = $jsfileroot . '/amd/build';
58 $srcdir = $jsfileroot . '/amd/src';
62 $filename = $srcdir . '/' . $module . $minpart . '.js';
63 if (!file_exists($filename)) {
67 $fullmodulename = $component . '/' . $module;
68 return array($fullmodulename => $filename);
72 * Scan the source for AMD modules and return them all.
74 * The expected location for amd modules is:
75 * <componentdir>/amd/src/modulename.js
77 * @param boolean $debug If true, returns the paths to the original (unminified) source files.
78 * @return array $files An array of mappings from module names to file paths.
80 public static function find_all_amd_modules($debug = false) {
86 $dir = $CFG->libdir
. '/amd';
87 if (!empty($dir) && is_dir($dir)) {
88 $jsdirs['core'] = $dir;
90 $subsystems = core_component
::get_core_subsystems();
91 foreach ($subsystems as $subsystem => $dir) {
92 if (!empty($dir) && is_dir($dir . '/amd')) {
93 $jsdirs['core_' . $subsystem] = $dir . '/amd';
96 $plugintypes = core_component
::get_plugin_types();
97 foreach ($plugintypes as $type => $dir) {
98 $plugins = core_component
::get_plugin_list_with_file($type, 'amd', false);
99 foreach ($plugins as $plugin => $dir) {
100 if (!empty($dir) && is_dir($dir)) {
101 $jsdirs[$type . '_' . $plugin] = $dir;
106 foreach ($jsdirs as $component => $dir) {
107 $srcdir = $dir . '/build';
109 $srcdir = $dir . '/src';
111 if (!is_dir($srcdir) ||
!is_readable($srcdir)) {
112 // This is probably an empty amd directory without src or build.
113 // Skip it - RecursiveDirectoryIterator fatals if the directory is not readable as an iterator.
116 $items = new RecursiveDirectoryIterator($srcdir);
117 foreach ($items as $item) {
118 $extension = $item->getExtension();
119 if ($extension === 'js') {
120 $filename = str_replace('.min', '', $item->getBaseName('.js'));
121 // We skip lazy loaded modules.
122 if (strpos($filename, '-lazy') === false) {
123 $modulename = $component . '/' . $filename;
124 $jsfiles[$modulename] = $item->getRealPath();