weekly release 3.1dev
[moodle.git] / lib / classes / requirejs.php
CommitLineData
adeb96d2
DW
1<?php
2// This file is part of Moodle - http://moodle.org/
3//
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.
8//
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.
13//
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/>.
16
17/**
18 * RequireJS helper functions.
19 *
20 * @package core
21 * @copyright 2015 Damyon Wiese <damyon@moodle.com>
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25defined('MOODLE_INTERNAL') || die();
26
27/**
28 * Collection of requirejs related methods.
29 *
30 * @copyright 2015 Damyon Wiese <damyon@moodle.com>
31 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
32 */
33class core_requirejs {
34
35 /**
36 * Check a single module exists and return the full path to it.
37 *
38 * The expected location for amd modules is:
39 * <componentdir>/amd/src/modulename.js
40 *
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.
46 */
47 public static function find_one_amd_module($component, $jsfilename, $debug = false) {
48 $jsfileroot = core_component::get_component_directory($component);
49 if (!$jsfileroot) {
50 return array();
51 }
52
53 $module = str_replace('.js', '', $jsfilename);
54
55 $srcdir = $jsfileroot . '/amd/build';
56 $minpart = '.min';
57 if ($debug) {
58 $srcdir = $jsfileroot . '/amd/src';
59 $minpart = '';
60 }
61
62 $filename = $srcdir . '/' . $module . $minpart . '.js';
63 if (!file_exists($filename)) {
64 return array();
65 }
66
67 $fullmodulename = $component . '/' . $module;
68 return array($fullmodulename => $filename);
69 }
70
71 /**
72 * Scan the source for AMD modules and return them all.
73 *
74 * The expected location for amd modules is:
75 * <componentdir>/amd/src/modulename.js
76 *
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.
79 */
80 public static function find_all_amd_modules($debug = false) {
81 global $CFG;
82
83 $jsdirs = array();
84 $jsfiles = array();
85
86 $dir = $CFG->libdir . '/amd';
87 if (!empty($dir) && is_dir($dir)) {
88 $jsdirs['core'] = $dir;
89 }
90 $subsystems = core_component::get_core_subsystems();
91 foreach ($subsystems as $subsystem => $dir) {
92 if (!empty($dir) && is_dir($dir . '/amd')) {
93 $jsdirs[$subsystem] = $dir . '/amd';
94 }
95 }
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;
102 }
103 }
104 }
105
106 foreach ($jsdirs as $component => $dir) {
107 $srcdir = $dir . '/build';
108 if ($debug) {
109 $srcdir = $dir . '/src';
110 }
111 $items = new RecursiveDirectoryIterator($srcdir);
112 foreach ($items as $item) {
113 $extension = $item->getExtension();
114 if ($extension === 'js') {
115 $filename = str_replace('.min', '', $item->getBaseName('.js'));
116 // We skip lazy loaded modules.
117 if (strpos($filename, '-lazy') === false) {
118 $modulename = $component . '/' . $filename;
119 $jsfiles[$modulename] = $item->getRealPath();
120 }
121 }
122 unset($item);
123 }
124 unset($items);
125 }
126
127 return $jsfiles;
128 }
129
130}