<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 5 |
- +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2019 |
- +--------------------------------------------------------------------+
- | This file is a part of CiviCRM. |
- | |
- | CiviCRM is free software; you can copy, modify, and distribute it |
- | under the terms of the GNU Affero General Public License |
- | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
- | |
- | CiviCRM is distributed in the hope that it will be useful, but |
- | WITHOUT ANY WARRANTY; without even the implied warranty of |
- | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
- | See the GNU Affero General Public License for more details. |
+ | Copyright CiviCRM LLC. All rights reserved. |
| |
- | You should have received a copy of the GNU Affero General Public |
- | License and the CiviCRM Licensing Exception along |
- | with this program; if not, contact CiviCRM LLC |
- | at info[AT]civicrm[DOT]org. If you have questions about the |
- | GNU Affero General Public License or the licensing of CiviCRM, |
- | see the CiviCRM license FAQ at http://civicrm.org/licensing |
+ | This work is published under the GNU AGPLv3 license with some |
+ | permitted exceptions and without any warranty. For full license |
+ | and copyright information, see https://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
* 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,
];