2 namespace Civi\Angular
;
5 * Manage Angular resources.
7 * @package Civi\Angular
12 * @var \CRM_Core_Resources
14 protected $res = NULL;
18 * Each item has some combination of these keys:
20 * The Civi extension which defines the Angular module.
21 * - js: array(string $relativeFilePath)
22 * List of JS files (relative to the extension).
23 * - css: array(string $relativeFilePath)
24 * List of CSS files (relative to the extension).
25 * - partials: array(string $relativeFilePath)
26 * A list of partial-HTML folders (relative to the extension).
27 * This will be mapped to "~/moduleName" by crmResource.
28 * - settings: array(string $key => mixed $value)
29 * List of settings to preload.
31 protected $modules = NULL;
34 * @var \CRM_Utils_Cache_Interface
40 * Array(string $name => ChangeSet $change).
42 protected $changeSets = NULL;
45 * @param \CRM_Core_Resources $res
46 * The resource manager.
48 public function __construct($res, \CRM_Utils_Cache_Interface
$cache = NULL) {
50 $this->cache
= $cache ?
$cache : new \
CRM_Utils_Cache_Arraycache(array());
54 * Get a list of AngularJS modules which should be autoloaded.
57 * Each item has some combination of these keys:
59 * The Civi extension which defines the Angular module.
60 * - js: array(string $relativeFilePath)
61 * List of JS files (relative to the extension).
62 * - css: array(string $relativeFilePath)
63 * List of CSS files (relative to the extension).
64 * - partials: array(string $relativeFilePath)
65 * A list of partial-HTML folders (relative to the extension).
66 * This will be mapped to "~/moduleName" by crmResource.
67 * - settings: array(string $key => mixed $value)
68 * List of settings to preload.
70 public function getModules() {
71 if ($this->modules
=== NULL) {
72 $config = \CRM_Core_Config
::singleton();
75 // Note: It would be nice to just glob("$civicrm_root/ang/*.ang.php"), but at time
76 // of writing CiviMail and CiviCase have special conditionals.
78 $angularModules = array();
79 $angularModules['angularFileUpload'] = include "$civicrm_root/ang/angularFileUpload.ang.php";
80 $angularModules['crmApp'] = include "$civicrm_root/ang/crmApp.ang.php";
81 $angularModules['crmAttachment'] = include "$civicrm_root/ang/crmAttachment.ang.php";
82 $angularModules['crmAutosave'] = include "$civicrm_root/ang/crmAutosave.ang.php";
83 $angularModules['crmCxn'] = include "$civicrm_root/ang/crmCxn.ang.php";
84 // $angularModules['crmExample'] = include "$civicrm_root/ang/crmExample.ang.php";
85 $angularModules['crmResource'] = include "$civicrm_root/ang/crmResource.ang.php";
86 $angularModules['crmUi'] = include "$civicrm_root/ang/crmUi.ang.php";
87 $angularModules['crmUtil'] = include "$civicrm_root/ang/crmUtil.ang.php";
88 $angularModules['dialogService'] = include "$civicrm_root/ang/dialogService.ang.php";
89 $angularModules['ngRoute'] = include "$civicrm_root/ang/ngRoute.ang.php";
90 $angularModules['ngSanitize'] = include "$civicrm_root/ang/ngSanitize.ang.php";
91 $angularModules['ui.utils'] = include "$civicrm_root/ang/ui.utils.ang.php";
92 $angularModules['ui.bootstrap'] = include "$civicrm_root/ang/ui.bootstrap.ang.php";
93 $angularModules['ui.sortable'] = include "$civicrm_root/ang/ui.sortable.ang.php";
94 $angularModules['unsavedChanges'] = include "$civicrm_root/ang/unsavedChanges.ang.php";
95 $angularModules['statuspage'] = include "$civicrm_root/ang/crmStatusPage.ang.php";
97 foreach (\CRM_Core_Component
::getEnabledComponents() as $component) {
98 $angularModules = array_merge($angularModules, $component->getAngularModules());
100 \CRM_Utils_Hook
::angularModules($angularModules);
101 foreach (array_keys($angularModules) as $module) {
102 if (!isset($angularModules[$module]['basePages'])) {
103 $angularModules[$module]['basePages'] = array('civicrm/a');
106 $this->modules
= $this->resolvePatterns($angularModules);
109 return $this->modules
;
113 * Get the descriptor for an Angular module.
115 * @param string $name
118 * Details about the module:
119 * - ext: string, the name of the Civi extension which defines the module
120 * - js: array(string $relativeFilePath).
121 * - css: array(string $relativeFilePath).
122 * - partials: array(string $relativeFilePath).
125 public function getModule($name) {
126 $modules = $this->getModules();
127 if (!isset($modules[$name])) {
128 throw new \
Exception("Unrecognized Angular module");
130 return $modules[$name];
134 * Resolve a full list of Angular dependencies.
136 * @param array $names
137 * List of Angular modules.
138 * Ex: array('crmMailing').
140 * List of Angular modules, include all dependencies.
141 * Ex: array('crmMailing', 'crmUi', 'crmUtil', 'ngRoute').
143 public function resolveDependencies($names) {
144 $allModules = $this->getModules();
147 while (($missingModules = array_diff($result, array_keys($visited))) && !empty($missingModules)) {
148 foreach ($missingModules as $module) {
149 $visited[$module] = 1;
150 if (!isset($allModules[$module])) {
151 \Civi
::log()->warning('Unrecognized Angular module {name}. Please ensure that all Angular modules are declared.', array(
153 'civi.tag' => 'deprecated',
156 elseif (isset($allModules[$module]['requires'])) {
157 $result = array_unique(array_merge($result, $allModules[$module]['requires']));
166 * Get a list of Angular modules that should be loaded on the given
169 * @param string $basePage
170 * The name of the base-page for which we want a list of moudles.
172 * List of Angular modules.
173 * Ex: array('crmMailing', 'crmUi', 'crmUtil', 'ngRoute').
175 public function resolveDefaultModules($basePage) {
176 $modules = $this->getModules();
178 foreach ($modules as $moduleName => $module) {
179 if (in_array($basePage, $module['basePages']) ||
in_array('*', $module['basePages'])) {
180 $result[] = $moduleName;
187 * Convert any globs in an Angular module to file names.
189 * @param array $modules
190 * List of Angular modules.
192 * Updated list of Angular modules
194 protected function resolvePatterns($modules) {
195 $newModules = array();
197 foreach ($modules as $moduleKey => $module) {
198 foreach (array('js', 'css', 'partials') as $fileset) {
199 if (!isset($module[$fileset])) {
202 $module[$fileset] = $this->res
->glob($module['ext'], $module[$fileset]);
204 $newModules[$moduleKey] = $module;
211 * Get the partial HTML documents for a module (unfiltered).
213 * @param string $name
214 * Angular module name.
216 * Array(string $extFilePath => string $html)
218 * Invalid partials configuration.
220 public function getRawPartials($name) {
221 $module = $this->getModule($name);
223 if (isset($module['partials'])) {
224 foreach ($module['partials'] as $partialDir) {
225 $partialDir = $this->res
->getPath($module['ext']) . '/' . $partialDir;
226 $files = \CRM_Utils_File
::findFiles($partialDir, '*.html', TRUE);
227 foreach ($files as $file) {
228 $filename = '~/' . $name . '/' . $file;
229 $result[$filename] = file_get_contents($partialDir . '/' . $file);
238 * Get the partial HTML documents for a module.
240 * @param string $name
241 * Angular module name.
243 * Array(string $extFilePath => string $html)
245 * Invalid partials configuration.
247 public function getPartials($name) {
248 $cacheKey = "angular-partials::$name";
249 $cacheValue = $this->cache
->get($cacheKey);
250 if ($cacheValue === NULL) {
251 $cacheValue = ChangeSet
::applyResourceFilters($this->getChangeSets(), 'partials', $this->getRawPartials($name));
252 $this->cache
->set($cacheKey, $cacheValue);
258 * Get list of translated strings for a module.
260 * @param string $name
261 * Angular module name.
263 * Translated strings: array(string $orig => string $translated).
265 public function getTranslatedStrings($name) {
266 $module = $this->getModule($name);
268 $strings = $this->getStrings($name);
269 foreach ($strings as $string) {
270 // TODO: should we pass translation domain based on $module[ext] or $module[tsDomain]?
271 // It doesn't look like client side really supports the domain right now...
272 $translated = ts($string, array(
273 'domain' => array($module['ext'], NULL),
275 if ($translated != $string) {
276 $result[$string] = $translated;
283 * Get list of translatable strings for a module.
285 * @param string $name
286 * Angular module name.
288 * Translatable strings.
290 public function getStrings($name) {
291 $module = $this->getModule($name);
293 if (isset($module['js'])) {
294 foreach ($module['js'] as $file) {
295 $strings = $this->res
->getStrings()->get(
297 $this->res
->getPath($module['ext'], $file),
300 $result = array_unique(array_merge($result, $strings));
303 $partials = $this->getPartials($name);
304 foreach ($partials as $partial) {
305 $result = array_unique(array_merge($result, \CRM_Utils_JS
::parseStrings($partial)));
311 * Get resources for one or more modules.
313 * @param string|array $moduleNames
314 * List of module names.
315 * @param string $resType
316 * Type of resource ('js', 'css', 'settings').
317 * @param string $refType
318 * Type of reference to the resource ('cacheUrl', 'rawUrl', 'path', 'settings').
320 * List of URLs or paths.
321 * @throws \CRM_Core_Exception
323 public function getResources($moduleNames, $resType, $refType) {
325 $moduleNames = (array) $moduleNames;
326 foreach ($moduleNames as $moduleName) {
327 $module = $this->getModule($moduleName);
328 if (isset($module[$resType])) {
329 foreach ($module[$resType] as $file) {
332 $result[] = $this->res
->getPath($module['ext'], $file);
336 $result[] = $this->res
->getUrl($module['ext'], $file);
340 $result[] = $this->res
->getUrl($module['ext'], $file, TRUE);
345 if (!empty($module[$resType])) {
346 $result[$moduleName] = $module[$resType];
351 throw new \
CRM_Core_Exception("Unrecognized resource format");
357 return ChangeSet
::applyResourceFilters($this->getChangeSets(), $resType, $result);
362 * Array(string $name => ChangeSet $changeSet).
364 public function getChangeSets() {
365 if ($this->changeSets
=== NULL) {
366 $this->changeSets
= array();
367 \CRM_Utils_Hook
::alterAngular($this);
369 return $this->changeSets
;
373 * @param ChangeSet $changeSet
374 * @return \Civi\Angular\Manager
376 public function add($changeSet) {
377 $this->changeSets
[$changeSet->getName()] = $changeSet;