(dev/core#174) Add concrete classes for cache exceptions
[civicrm-core.git] / CRM / Utils / Cache / NoCache.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
13 | |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
18 | |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
26 */
27
28 /**
29 *
30 * @package CRM
31 * @copyright CiviCRM LLC (c) 2004-2018
32 */
33 class CRM_Utils_Cache_NoCache implements CRM_Utils_Cache_Interface {
34
35 use CRM_Utils_Cache_NaiveMultipleTrait; // TODO Consider native implementation.
36 use CRM_Utils_Cache_NaiveHasTrait; // TODO Native implementation
37
38 /**
39 * We only need one instance of this object. So we use the singleton
40 * pattern and cache the instance in this variable
41 *
42 * @var object
43 */
44 static private $_singleton = NULL;
45
46 /**
47 * Constructor.
48 *
49 * @param array $config
50 * An array of configuration params.
51 *
52 * @return \CRM_Utils_Cache_NoCache
53 */
54 public function __construct($config) {
55 }
56
57 /**
58 * @param string $key
59 * @param mixed $value
60 * @param null|int|\DateInterval $ttl
61 *
62 * @return bool
63 */
64 public function set($key, $value, $ttl = NULL) {
65 return FALSE;
66 }
67
68 /**
69 * @param string $key
70 * @param mixed $default
71 *
72 * @return null
73 */
74 public function get($key, $default = NULL) {
75 return $default;
76 }
77
78 /**
79 * @param string $key
80 *
81 * @return bool
82 */
83 public function delete($key) {
84 return FALSE;
85 }
86
87 /**
88 * @return bool
89 */
90 public function flush() {
91 return FALSE;
92 }
93
94 public function clear() {
95 return $this->flush();
96 }
97
98 }