blob: bbaf96fc4130fa5f3595c53536278507f87a524f [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
Greg Akerbde25d92010-12-21 09:31:21 -06002/**
3 * CodeIgniter
4 *
Andrey Andreevfe9309d2015-01-09 17:48:58 +02005 * An open source application development framework for PHP
Derek Jonesf4a4bd82011-10-20 12:18:42 -05006 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +02007 * This content is released under the MIT License (MIT)
Andrey Andreev7d4ea072011-12-25 19:23:50 +02008 *
Andrey Andreevcce6bd12018-01-09 11:32:02 +02009 * Copyright (c) 2014 - 2018, British Columbia Institute of Technology
Andrey Andreev7d4ea072011-12-25 19:23:50 +020010 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020011 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
Greg Akerbde25d92010-12-21 09:31:21 -060017 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020018 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 * THE SOFTWARE.
28 *
29 * @package CodeIgniter
30 * @author EllisLab Dev Team
Andrey Andreev1924e872016-01-11 12:55:34 +020031 * @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/)
Andrey Andreevcce6bd12018-01-09 11:32:02 +020032 * @copyright Copyright (c) 2014 - 2018, British Columbia Institute of Technology (http://bcit.ca/)
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020033 * @license http://opensource.org/licenses/MIT MIT License
Andrey Andreevbd202c92016-01-11 12:50:18 +020034 * @link https://codeigniter.com
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020035 * @since Version 2.0
Eric Barnesbffb7762011-04-18 00:03:31 -040036 * @filesource
Greg Akerbde25d92010-12-21 09:31:21 -060037 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020038defined('BASEPATH') OR exit('No direct script access allowed');
Greg Akerbde25d92010-12-21 09:31:21 -060039
Greg Akerbde25d92010-12-21 09:31:21 -060040/**
Eric Barnesbffb7762011-04-18 00:03:31 -040041 * CodeIgniter Dummy Caching Class
Greg Akerbde25d92010-12-21 09:31:21 -060042 *
43 * @package CodeIgniter
44 * @subpackage Libraries
45 * @category Core
Derek Jonesf4a4bd82011-10-20 12:18:42 -050046 * @author EllisLab Dev Team
Eric Barnesbffb7762011-04-18 00:03:31 -040047 * @link
Greg Akerbde25d92010-12-21 09:31:21 -060048 */
Phil Sturgeoneb2dcda2011-04-02 14:44:58 +010049class CI_Cache_dummy extends CI_Driver {
Greg Akerbde25d92010-12-21 09:31:21 -060050
51 /**
Eric Barnesbffb7762011-04-18 00:03:31 -040052 * Get
Greg Akerbde25d92010-12-21 09:31:21 -060053 *
54 * Since this is the dummy class, it's always going to return FALSE.
55 *
Andrey Andreevb24b0332012-03-26 15:34:39 +030056 * @param string
57 * @return bool FALSE
Greg Akerbde25d92010-12-21 09:31:21 -060058 */
59 public function get($id)
60 {
61 return FALSE;
62 }
63
Eric Barnesbffb7762011-04-18 00:03:31 -040064 // ------------------------------------------------------------------------
65
Greg Akerbde25d92010-12-21 09:31:21 -060066 /**
67 * Cache Save
68 *
Andrey Andreevb24b0332012-03-26 15:34:39 +030069 * @param string Unique Key
70 * @param mixed Data to store
71 * @param int Length of time (in seconds) to cache the data
Andrey Andreev43d7fa72014-01-09 17:29:45 +020072 * @param bool Whether to store the raw value
Andrey Andreevb24b0332012-03-26 15:34:39 +030073 * @return bool TRUE, Simulating success
Greg Akerbde25d92010-12-21 09:31:21 -060074 */
Andrey Andreev43d7fa72014-01-09 17:29:45 +020075 public function save($id, $data, $ttl = 60, $raw = FALSE)
Greg Akerbde25d92010-12-21 09:31:21 -060076 {
77 return TRUE;
78 }
Eric Barnesbffb7762011-04-18 00:03:31 -040079
Greg Akerbde25d92010-12-21 09:31:21 -060080 // ------------------------------------------------------------------------
81
82 /**
83 * Delete from Cache
84 *
Andrey Andreevb24b0332012-03-26 15:34:39 +030085 * @param mixed unique identifier of the item in the cache
Timothy Warren0688ac92012-04-20 10:25:04 -040086 * @return bool TRUE, simulating success
Greg Akerbde25d92010-12-21 09:31:21 -060087 */
88 public function delete($id)
89 {
90 return TRUE;
91 }
92
93 // ------------------------------------------------------------------------
94
95 /**
Andrey Andreev43d7fa72014-01-09 17:29:45 +020096 * Increment a raw value
97 *
98 * @param string $id Cache ID
99 * @param int $offset Step/value to add
100 * @return mixed New value on success or FALSE on failure
101 */
102 public function increment($id, $offset = 1)
103 {
104 return TRUE;
105 }
106
107 // ------------------------------------------------------------------------
108
109 /**
110 * Decrement a raw value
111 *
112 * @param string $id Cache ID
113 * @param int $offset Step/value to reduce by
114 * @return mixed New value on success or FALSE on failure
115 */
116 public function decrement($id, $offset = 1)
117 {
118 return TRUE;
119 }
120
121 // ------------------------------------------------------------------------
122
123 /**
Greg Akerbde25d92010-12-21 09:31:21 -0600124 * Clean the cache
125 *
Andrey Andreevb24b0332012-03-26 15:34:39 +0300126 * @return bool TRUE, simulating success
Greg Akerbde25d92010-12-21 09:31:21 -0600127 */
128 public function clean()
129 {
130 return TRUE;
131 }
132
133 // ------------------------------------------------------------------------
134
135 /**
136 * Cache Info
137 *
Andrey Andreevb24b0332012-03-26 15:34:39 +0300138 * @param string user/filehits
139 * @return bool FALSE
Greg Akerbde25d92010-12-21 09:31:21 -0600140 */
141 public function cache_info($type = NULL)
142 {
143 return FALSE;
144 }
145
146 // ------------------------------------------------------------------------
147
148 /**
149 * Get Cache Metadata
150 *
Andrey Andreevb24b0332012-03-26 15:34:39 +0300151 * @param mixed key to get cache metadata on
152 * @return bool FALSE
Greg Akerbde25d92010-12-21 09:31:21 -0600153 */
154 public function get_metadata($id)
155 {
156 return FALSE;
157 }
158
159 // ------------------------------------------------------------------------
160
161 /**
162 * Is this caching driver supported on the system?
163 * Of course this one is.
Eric Barnesbffb7762011-04-18 00:03:31 -0400164 *
Andrey Andreevb24b0332012-03-26 15:34:39 +0300165 * @return bool TRUE
Greg Akerbde25d92010-12-21 09:31:21 -0600166 */
167 public function is_supported()
168 {
169 return TRUE;
170 }
171
Greg Akerbde25d92010-12-21 09:31:21 -0600172}