Civi/Angular/Page/Main.php

   1 <?php
   2 namespace Civi\Angular\Page;
   3
   4 /**
   5  * This page is simply a container; any Angular modules defined by CiviCRM (or by CiviCRM extensions)
   6  * will be activated on this page.
   7  *
   8  * @link https://issues.civicrm.org/jira/browse/CRM-14479
   9  */
  10 class Main extends \CRM_Core_Page {
  11   /**
  12    * The weight to assign to any Angular JS module files.
  13    */
  14   const DEFAULT_MODULE_WEIGHT = 200;
  15
  16   /**
  17    * The resource manager.
  18    *
  19    * Do not use publicly. Inject your own copy!
  20    *
  21    * @var \CRM_Core_Resources
  22    */
  23   public $res;
  24
  25
  26   /**
  27    * The Angular module manager.
  28    *
  29    * Do not use publicly. Inject your own copy!
  30    *
  31    * @var \Civi\Angular\Manager
  32    */
  33   public $angular;
  34
  35   /**
  36    * The region of the page into which JavaScript will be loaded.
  37    *
  38    * @var String
  39    */
  40   public $region;
  41
  42   /**
  43    * @param string $title
  44    *   Title of the page.
  45    * @param int $mode
  46    *   Mode of the page.
  47    * @param \CRM_Core_Resources|null $res
  48    *   Resource manager.
  49    */
  50   public function __construct($title = NULL, $mode = NULL, $res = NULL) {
  51     parent::__construct($title, $mode);
  52     $this->res = \CRM_Core_Resources::singleton();
  53     $this->angular = \Civi::service('angular');
  54     $this->region = \CRM_Utils_Request::retrieve('snippet', 'String') ? 'ajax-snippet' : 'html-header';
  55   }
  56
  57   /**
  58    * This function takes care of all the things common to all
  59    * pages. This typically involves assigning the appropriate
  60    * smarty variable :)
  61    *
  62    * @return string
  63    *   The content generated by running this page
  64    */
  65   public function run() {
  66     $this->registerResources();
  67     return parent::run();
  68   }
  69
  70   /**
  71    * Register resources required by Angular.
  72    */
  73   public function registerResources() {
  74     $modules = $this->angular->getModules();
  75     $page = $this; // PHP 5.3 does not propagate $this to inner functions.
  76
  77     $this->res->addSettingsFactory(function () use (&$modules, $page) {
  78       // TODO optimization; client-side caching
  79       return array_merge($page->angular->getResources(array_keys($modules), 'settings', 'settings'), array(
  80         'resourceUrls' => \CRM_Extension_System::singleton()->getMapper()->getActiveModuleUrls(),
  81         'angular' => array(
  82           'modules' => array_merge(array('ngRoute'), array_keys($modules)),
  83           'cacheCode' => $page->res->getCacheCode(),
  84         ),
  85       ));
  86     });
  87
  88     $this->res->addScriptFile('civicrm', 'bower_components/angular/angular.min.js', 100, $this->region, FALSE);
  89
  90     $headOffset = 0;
  91     $config = \CRM_Core_Config::singleton();
  92     if ($config->debug) {
  93       foreach ($modules as $moduleName => $module) {
  94         foreach ($this->angular->getResources($moduleName, 'css', 'cacheUrl') as $url) {
  95           $this->res->addStyleUrl($url, self::DEFAULT_MODULE_WEIGHT + (++$headOffset), $this->region);
  96         }
  97         foreach ($this->angular->getResources($moduleName, 'js', 'cacheUrl') as $url) {
  98           $this->res->addScriptUrl($url, self::DEFAULT_MODULE_WEIGHT + (++$headOffset), $this->region);
  99           // addScriptUrl() bypasses the normal string-localization of addScriptFile(),
 100           // but that's OK because all Angular strings (JS+HTML) will load via crmResource.
 101         }
 102       }
 103     }
 104     else {
 105       // Note: addScriptUrl() bypasses the normal string-localization of addScriptFile(),
 106       // but that's OK because all Angular strings (JS+HTML) will load via crmResource.
 107       $aggScriptUrl = \CRM_Utils_System::url('civicrm/ajax/angular-modules', 'format=js&r=' . $page->res->getCacheCode(), FALSE, NULL, FALSE);
 108       $this->res->addScriptUrl($aggScriptUrl, 120, $this->region);
 109
 110       // FIXME: The following CSS aggregator doesn't currently handle path-adjustments - which can break icons.
 111       //$aggStyleUrl = \CRM_Utils_System::url('civicrm/ajax/angular-modules', 'format=css&r=' . $page->res->getCacheCode(), FALSE, NULL, FALSE);
 112       //$this->res->addStyleUrl($aggStyleUrl, 120, $this->region);
 113
 114       foreach ($this->angular->getResources(array_keys($modules), 'css', 'cacheUrl') as $url) {
 115         $this->res->addStyleUrl($url, self::DEFAULT_MODULE_WEIGHT + (++$headOffset), $this->region);
 116       }
 117     }
 118
 119     // If trying to load an Angular page via AJAX, the route must be passed as a
 120     // URL parameter, since the server doesn't receive information about
 121     // URL fragments (i.e, what comes after the #).
 122     \CRM_Core_Resources::singleton()->addSetting(array(
 123       'angularRoute' => \CRM_Utils_Request::retrieve('route', 'String'),
 124     ));
 125   }
 126
 127 }