fix misfiled pdf merges
[civicrm-core.git] / CRM / Core / CommunityMessages.php
index 999978a2bad9ef5ee2d8c449861d15555356bef7..c15b13e129f251dbe2a30c922336fa1734544a10 100644 (file)
@@ -36,7 +36,8 @@ class CRM_Core_CommunityMessages {
   /**
    * Default time to wait before retrying.
    */
-  const DEFAULT_RETRY = 7200; // 2 hours
+  // 2 hours
+  const DEFAULT_RETRY = 7200;
 
   /**
    * @var CRM_Utils_HttpClient
@@ -49,7 +50,11 @@ class CRM_Core_CommunityMessages {
   protected $cache;
 
   /**
-   * @var FALSE|string
+   * Url to retrieve community messages from.
+   *
+   * False means a retrieval will not be attempted.
+   *
+   * @var false|string
    */
   protected $messagesUrl;
 
@@ -66,9 +71,11 @@ class CRM_Core_CommunityMessages {
   }
 
   /**
+   * Class constructor.
+   *
    * @param CRM_Utils_Cache_Interface $cache
    * @param CRM_Utils_HttpClient $client
-   * @param null $messagesUrl
+   * @param string|false $messagesUrl
    */
   public function __construct($cache, $client, $messagesUrl = NULL) {
     $this->cache = $cache;
@@ -85,7 +92,7 @@ class CRM_Core_CommunityMessages {
   }
 
   /**
-   * Get the messages document (either from the cache or by downloading)
+   * Get the messages document (either from the cache or by downloading).
    *
    * @return NULL|array
    */
@@ -94,12 +101,13 @@ class CRM_Core_CommunityMessages {
     $document = $this->cache->get('communityMessages');
 
     if (empty($document) || !is_array($document)) {
-      $document = array(
-        'messages' => array(),
-        'expires' => 0, // ASAP
+      $document = [
+        'messages' => [],
+        // ASAP
+        'expires' => 0,
         'ttl' => self::DEFAULT_RETRY,
         'retry' => self::DEFAULT_RETRY,
-      );
+      ];
       $isChanged = TRUE;
     }
 
@@ -164,10 +172,10 @@ class CRM_Core_CommunityMessages {
    */
   public function pick() {
     $document = $this->getDocument();
-    $messages = array();
+    $messages = [];
     foreach ($document['messages'] as $message) {
       if (!isset($message['perms'])) {
-        $message['perms'] = array(self::DEFAULT_PERMISSION);
+        $message['perms'] = [self::DEFAULT_PERMISSION];
       }
       if (!CRM_Core_Permission::checkAnyPerm($message['perms'])) {
         continue;
@@ -196,7 +204,7 @@ class CRM_Core_CommunityMessages {
    */
   public static function evalMarkup($markup) {
     $config = CRM_Core_Config::singleton();
-    $vals = array(
+    $vals = [
       'resourceUrl' => rtrim($config->resourceBase, '/'),
       'ver' => CRM_Utils_System::version(),
       'uf' => $config->userFramework,
@@ -205,8 +213,8 @@ class CRM_Core_CommunityMessages {
       'baseUrl' => $config->userFrameworkBaseURL,
       'lang' => $config->lcMessages,
       'co' => $config->defaultContactCountry,
-    );
-    $vars = array();
+    ];
+    $vars = [];
     foreach ($vals as $k => $v) {
       $vars['%%' . $k . '%%'] = $v;
       $vars['{{' . $k . '}}'] = urlencode($v);