From: Tim Otten <totten@civicrm.org>
Date: Tue, 18 Aug 2020 02:56:43 +0000 (-0700)
Subject: CollectionTrait - Model scriptFile and styleFile as distinct types
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=bac2c5e42fb9a4d21f74d5bb41e0b51a9a8af7c0;p=civicrm-core.git

CollectionTrait - Model scriptFile and styleFile as distinct types
---

diff --git a/CRM/Core/Region.php b/CRM/Core/Region.php
index 3f4e1f29d0..7a31455005 100644
--- a/CRM/Core/Region.php
+++ b/CRM/Core/Region.php
@@ -36,7 +36,7 @@ class CRM_Core_Region {
    */
   public function __construct($name) {
     $this->_name = $name;
-    $this->types = ['markup', 'template', 'callback', 'scriptUrl', 'script', 'jquery', 'settings', 'style', 'styleUrl'];
+    $this->types = ['markup', 'template', 'callback', 'scriptFile', 'scriptUrl', 'script', 'jquery', 'settings', 'style', 'styleFile', 'styleUrl'];
     $this->defaults['region'] = $name;
 
     // Placeholder which represents any of the default content generated by the main Smarty template
@@ -100,12 +100,24 @@ class CRM_Core_Region {
           ]);
           break;
 
+        case 'scriptFile':
+          foreach ($snippet['scriptFileUrls'] as $url) {
+            $html .= $renderSnippet(['type' => 'scriptUrl', 'scriptUrl' => $url] + $snippet);
+          }
+          break;
+
         case 'script':
           if (!$allowCmsOverride || !$cms->addScript($snippet['script'], $this->_name)) {
             $html .= sprintf("<script type=\"text/javascript\">\n%s\n</script>\n", $snippet['script']);
           }
           break;
 
+        case 'styleFile':
+          foreach ($snippet['styleFileUrls'] as $url) {
+            $html .= $renderSnippet(['type' => 'styleUrl', 'styleUrl' => $url] + $snippet);
+          }
+          break;
+
         case 'styleUrl':
           if (!$allowCmsOverride || !$cms->addStyleUrl($snippet['styleUrl'], $this->_name)) {
             $html .= sprintf("<link href=\"%s\" rel=\"stylesheet\" type=\"text/css\"/>\n", $snippet['styleUrl']);
diff --git a/CRM/Core/Resources/CollectionTrait.php b/CRM/Core/Resources/CollectionTrait.php
index 35147c48b7..38d259bc73 100644
--- a/CRM/Core/Resources/CollectionTrait.php
+++ b/CRM/Core/Resources/CollectionTrait.php
@@ -102,27 +102,55 @@ trait CRM_Core_Resources_CollectionTrait {
         }
       }
     }
-    elseif (!in_array($snippet['type'], $this->types)) {
-      throw new \RuntimeException("Unsupported snippet type: " . $snippet['type']);
+    if (!in_array($snippet['type'] ?? NULL, $this->types)) {
+      $typeExpr = $snippet['type'] ?? '(' . implode(',', array_keys($snippet)) . ')';
+      throw new \RuntimeException("Unsupported snippet type: $typeExpr");
     }
     // Traditional behavior: sort by (1) weight and (2) either name or natural position. This second thing is called 'sortId'.
     if (isset($snippet['name'])) {
       $snippet['sortId'] = $snippet['name'];
     }
     else {
-      $snippet['sortId'] = $this->nextId();
       switch ($snippet['type']) {
         case 'scriptUrl':
         case 'styleUrl':
+          $snippet['sortId'] = $this->nextId();
           $snippet['name'] = $snippet[$snippet['type']];
           break;
 
+        case 'scriptFile':
+        case 'styleFile':
+          $snippet['sortId'] = $this->nextId();
+          $snippet['name'] = implode(':', $snippet[$snippet['type']]);
+          break;
+
         default:
+          $snippet['sortId'] = $this->nextId();
           $snippet['name'] = $snippet['sortId'];
           break;
       }
     }
 
+    if ($snippet['type'] === 'scriptFile' && !isset($snippet['scriptFileUrls'])) {
+      $res = Civi::resources();
+      list ($ext, $file) = $snippet['scriptFile'];
+
+      $snippet['translate'] = $snippet['translate'] ?? TRUE;
+      if ($snippet['translate']) {
+        $domain = ($snippet['translate'] === TRUE) ? $ext : $snippet['translate'];
+        // Is this too early?
+        $this->addString(Civi::service('resources.js_strings')->get($domain, $res->getPath($ext, $file), 'text/javascript'), $domain);
+      }
+      $snippet['scriptFileUrls'] = [$res->getUrl($ext, $res->filterMinify($ext, $file), TRUE)];
+    }
+
+    if ($snippet['type'] === 'styleFile' && !isset($snippet['styleFileUrls'])) {
+      /** @var Civi\Core\Themes $theme */
+      $theme = Civi::service('themes');
+      list ($ext, $file) = $snippet['styleFile'];
+      $snippet['styleFileUrls'] = $theme->resolveUrls($theme->getActiveThemeKey(), $ext, $file);
+    }
+
     $this->snippets[$snippet['name']] = $snippet;
     $this->isSorted = FALSE;
     return $snippet;
@@ -361,18 +389,7 @@ trait CRM_Core_Resources_CollectionTrait {
    * @throws \CRM_Core_Exception
    */
   public function addScriptFile(string $ext, string $file, array $options = []) {
-    // TODO: Maybe this should be its own resource type to allow smarter management?
-
-    $res = Civi::resources();
-
-    $translate = $options['translate'] ?? TRUE;
-    unset($options['translate']);
-    if ($translate) {
-      $domain = ($translate === TRUE) ? $ext : $translate;
-      $this->addString(Civi::service('resources.js_strings')->get($domain, $res->getPath($ext, $file), 'text/javascript'), $domain);
-    }
-    $url = $res->getUrl($ext, $res->filterMinify($ext, $file), TRUE);
-    $this->add($options + ['scriptUrl' => $url, 'name' => "$ext:$file"]);
+    $this->add($options + ['scriptFile' => [$ext, $file]]);
     return $this;
   }
 
@@ -469,13 +486,7 @@ trait CRM_Core_Resources_CollectionTrait {
    * @return static
    */
   public function addStyleFile(string $ext, string $file, array $options = []) {
-    // TODO: Maybe this should be its own resource type to allow smarter management?
-
-    /** @var Civi\Core\Themes $theme */
-    $theme = Civi::service('themes');
-    foreach ($theme->resolveUrls($theme->getActiveThemeKey(), $ext, $file) as $url) {
-      $this->add($options + ['styleUrl' => $url, 'name' => "$ext:$file"]);
-    }
+    $this->add($options + ['styleFile' => [$ext, $file]]);
     return $this;
   }