CRM/Core/Region.php

   1 <?php
   2
   3 /**
   4  * Maintain a set of markup/templates to inject inside various regions
   5  */
   6 class CRM_Core_Region implements CRM_Core_Resources_CollectionInterface, CRM_Core_Resources_CollectionAdderInterface {
   7
   8   /**
   9    * Obtain the content for a given region.
  10    *
  11    * @param string $name
  12    * @param bool $autocreate
  13    *   Whether to automatically create an empty region.
  14    * @return CRM_Core_Region
  15    */
  16   public static function &instance($name, $autocreate = TRUE) {
  17     if ($autocreate && !isset(Civi::$statics[__CLASS__][$name])) {
  18       Civi::$statics[__CLASS__][$name] = new CRM_Core_Region($name);
  19     }
  20     return Civi::$statics[__CLASS__][$name];
  21   }
  22
  23   use CRM_Core_Resources_CollectionTrait;
  24
  25   /**
  26    * Symbolic name of this region
  27    *
  28    * @var string
  29    */
  30   public $_name;
  31
  32   /**
  33    * @param string $name
  34    */
  35   public function __construct($name) {
  36     $this->_name = $name;
  37     $this->types = ['markup', 'template', 'callback', 'scriptFile', 'scriptUrl', 'script', 'jquery', 'settings', 'style', 'styleFile', 'styleUrl'];
  38     $this->defaults['region'] = $name;
  39
  40     // Placeholder which represents any of the default content generated by the main Smarty template
  41     $this->add([
  42       'name' => 'default',
  43       'type' => 'markup',
  44       'markup' => '',
  45       'weight' => 0,
  46     ]);
  47   }
  48
  49   /**
  50    * Render all the snippets in a region.
  51    *
  52    * @param string $default
  53    *   HTML, the initial content of the region.
  54    * @param bool $allowCmsOverride
  55    *   Allow CMS to override rendering of region.
  56    * @return string, HTML
  57    */
  58   public function render($default, $allowCmsOverride = TRUE) {
  59     // $default is just another part of the region
  60     if (is_array($this->snippets['default'])) {
  61       $this->snippets['default']['markup'] = $default;
  62     }
  63
  64     Civi::dispatcher()->dispatch('civi.region.render', \Civi\Core\Event\GenericHookEvent::create(['region' => $this]));
  65
  66     $this->sort();
  67
  68     $cms = CRM_Core_Config::singleton()->userSystem;
  69     $smarty = CRM_Core_Smarty::singleton();
  70     $html = '';
  71
  72     $renderSnippet = function($snippet) use (&$html, $smarty, $cms, $allowCmsOverride, &$renderSnippet) {
  73       switch ($snippet['type']) {
  74         case 'markup':
  75           $html .= $snippet['markup'];
  76           break;
  77
  78         case 'template':
  79           $tmp = $smarty->get_template_vars('snippet');
  80           $smarty->assign('snippet', $snippet);
  81           $html .= $smarty->fetch($snippet['template']);
  82           $smarty->assign('snippet', $tmp);
  83           break;
  84
  85         case 'callback':
  86           $args = $snippet['arguments'] ?? array(&$snippet, &$html);
  87           $html .= call_user_func_array($snippet['callback'], $args);
  88           break;
  89
  90         case 'scriptUrl':
  91           if (!$allowCmsOverride || !$cms->addScriptUrl($snippet['scriptUrl'], $this->_name)) {
  92             $html .= sprintf("<script type=\"text/javascript\" src=\"%s\">\n</script>\n", $snippet['scriptUrl']);
  93           }
  94           break;
  95
  96         case 'jquery':
  97           $renderSnippet([
  98             'type' => 'script',
  99             'script' => sprintf("CRM.\$(function(\$) {\n%s\n});", $snippet['jquery']),
 100           ]);
 101           break;
 102
 103         case 'scriptFile':
 104           foreach ($snippet['scriptFileUrls'] as $url) {
 105             $html .= $renderSnippet(['type' => 'scriptUrl', 'scriptUrl' => $url] + $snippet);
 106           }
 107           break;
 108
 109         case 'script':
 110           if (!$allowCmsOverride || !$cms->addScript($snippet['script'], $this->_name)) {
 111             $html .= sprintf("<script type=\"text/javascript\">\n%s\n</script>\n", $snippet['script']);
 112           }
 113           break;
 114
 115         case 'styleFile':
 116           foreach ($snippet['styleFileUrls'] as $url) {
 117             $html .= $renderSnippet(['type' => 'styleUrl', 'styleUrl' => $url] + $snippet);
 118           }
 119           break;
 120
 121         case 'styleUrl':
 122           if (!$allowCmsOverride || !$cms->addStyleUrl($snippet['styleUrl'], $this->_name)) {
 123             $html .= sprintf("<link href=\"%s\" rel=\"stylesheet\" type=\"text/css\"/>\n", $snippet['styleUrl']);
 124           }
 125           break;
 126
 127         case 'style':
 128           if (!$allowCmsOverride || !$cms->addStyle($snippet['style'], $this->_name)) {
 129             $html .= sprintf("<style type=\"text/css\">\n%s\n</style>\n", $snippet['style']);
 130           }
 131           break;
 132
 133         case 'settings':
 134           $settingsData = json_encode($this->getSettings(), JSON_UNESCAPED_SLASHES);
 135           $js = "(function(vars) {
 136             if (window.CRM) CRM.$.extend(true, CRM, vars); else window.CRM = vars;
 137             })($settingsData)";
 138           $html .= sprintf("<script type=\"text/javascript\">\n%s\n</script>\n", $js);
 139           break;
 140
 141         default:
 142           throw new CRM_Core_Exception(ts('Snippet type %1 is unrecognized',
 143             [1 => $snippet['type']]));
 144       }
 145     };
 146
 147     foreach ($this->snippets as $snippet) {
 148       if (empty($snippet['disabled'])) {
 149         $renderSnippet($snippet);
 150       }
 151     }
 152     return $html;
 153   }
 154
 155 }