X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FCommunityMessages.php;h=c15b13e129f251dbe2a30c922336fa1734544a10;hb=2e9051c710b62fd9fb5fd8bff48cdf5bb3d0e98e;hp=9e7ad56aa35859cfe46f2f1d8b9fbba9b358d09b;hpb=eeca7960db033b9ee3511f6bf7d1217b1b5caed9;p=civicrm-core.git

diff --git a/CRM/Core/CommunityMessages.php b/CRM/Core/CommunityMessages.php
index 9e7ad56aa3..c15b13e129 100644
--- a/CRM/Core/CommunityMessages.php
+++ b/CRM/Core/CommunityMessages.php
@@ -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
    */
@@ -96,7 +103,8 @@ class CRM_Core_CommunityMessages {
     if (empty($document) || !is_array($document)) {
       $document = [
         'messages' => [],
-        'expires' => 0, // ASAP
+        // ASAP
+        'expires' => 0,
         'ttl' => self::DEFAULT_RETRY,
         'retry' => self::DEFAULT_RETRY,
       ];