/**
* Default time to wait before retrying.
*/
- const DEFAULT_RETRY = 7200; // 2 hours
+ // 2 hours
+ const DEFAULT_RETRY = 7200;
/**
* @var CRM_Utils_HttpClient
protected $cache;
/**
- * @var FALSE|string
+ * Url to retrieve community messages from.
+ *
+ * False means a retrieval will not be attempted.
+ *
+ * @var false|string
*/
protected $messagesUrl;
}
/**
+ * 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;
}
/**
- * 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
*/
if (empty($document) || !is_array($document)) {
$document = [
'messages' => [],
- 'expires' => 0, // ASAP
+ // ASAP
+ 'expires' => 0,
'ttl' => self::DEFAULT_RETRY,
'retry' => self::DEFAULT_RETRY,
];