buttonizer-multifunctional-button / freemius / includes / managers / class-fs-cache-manager.php

class-fs-cache-manager.php in Buttonizer – Floating Menus, Sticky Buttons, & Popup Builder 1.0.3, at freemius/includes/managers/class-fs-cache-manager.php

237 lines 4.9 KB

Raw Download Zip

1	<?php
2	/**
3	* @package Freemius
4	* @copyright Copyright (c) 2015, Freemius, Inc.
5	* @license http://opensource.org/licenses/gpl-2.0.php GNU Public License
6	* @since 1.1.6
7	*/
8
9	if ( ! defined( 'ABSPATH' ) ) {
10	exit;
11	}
12
13	class FS_Cache_Manager {
14	/**
15	* @var FS_Option_Manager
16	*/
17	private $_options;
18	/**
19	* @var FS_Logger
20	*/
21	private $_logger;
22
23	/**
24	* @var FS_Cache_Manager[]
25	*/
26	private static $_MANAGERS = array();
27
28	/**
29	* @author Vova Feldman (@svovaf)
30	* @since 1.1.3
31	*
32	* @param string $id
33	*/
34	private function __construct( $id ) {
35	$this->_logger = FS_Logger::get_logger( WP_FS__SLUG . '_cach_mngr_' . $id, WP_FS__DEBUG_SDK, WP_FS__ECHO_DEBUG_SDK );
36
37	$this->_logger->entrance();
38	$this->_logger->log( 'id = ' . $id );
39
40	$this->_options = FS_Option_Manager::get_manager( $id, true );
41	}
42
43	/**
44	* @author Vova Feldman (@svovaf)
45	* @since 1.1.6
46	*
47	* @param $id
48	*
49	* @return FS_Cache_Manager
50	*/
51	static function get_manager( $id ) {
52	$id = strtolower( $id );
53
54	if ( ! isset( self::$_MANAGERS[ $id ] ) ) {
55	self::$_MANAGERS[ $id ] = new FS_Cache_Manager( $id );
56	}
57
58	return self::$_MANAGERS[ $id ];
59	}
60
61	/**
62	* @author Vova Feldman (@svovaf)
63	* @since 1.1.6
64	*
65	* @return bool
66	*/
67	function is_empty() {
68	$this->_logger->entrance();
69
70	return $this->_options->is_empty();
71	}
72
73	/**
74	* @author Vova Feldman (@svovaf)
75	* @since 1.1.6
76	*/
77	function clear() {
78	$this->_logger->entrance();
79
80	$this->_options->clear( true );
81	}
82
83	/**
84	* Delete cache manager from DB.
85	*
86	* @author Vova Feldman (@svovaf)
87	* @since 1.0.9
88	*/
89	function delete() {
90	$this->_options->delete();
91	}
92
93	/**
94	* Check if there's a cached item.
95	*
96	* @author Vova Feldman (@svovaf)
97	* @since 1.1.6
98	*
99	* @param string $key
100	*
101	* @return bool
102	*/
103	function has( $key ) {
104	$cache_entry = $this->_options->get_option( $key, false );
105
106	return ( is_object( $cache_entry ) &&
107	isset( $cache_entry->timestamp ) &&
108	is_numeric( $cache_entry->timestamp )
109	);
110	}
111
112	/**
113	* Check if there's a valid cached item.
114	*
115	* @author Vova Feldman (@svovaf)
116	* @since 1.1.6
117	*
118	* @param string $key
119	*
120	* @return bool
121	*/
122	function has_valid( $key ) {
123	$cache_entry = $this->_options->get_option( $key, false );
124
125	return ( is_object( $cache_entry ) &&
126	isset( $cache_entry->timestamp ) &&
127	is_numeric( $cache_entry->timestamp ) &&
128	$cache_entry->timestamp > WP_FS__SCRIPT_START_TIME
129	);
130	}
131
132	/**
133	* @author Vova Feldman (@svovaf)
134	* @since 1.1.6
135	*
136	* @param string $key
137	* @param mixed $default
138	*
139	* @return mixed
140	*/
141	function get( $key, $default = null ) {
142	$this->_logger->entrance( 'key = ' . $key );
143
144	$cache_entry = $this->_options->get_option( $key, false );
145
146	if ( is_object( $cache_entry ) &&
147	isset( $cache_entry->timestamp ) &&
148	is_numeric( $cache_entry->timestamp )
149	) {
150	return $cache_entry->result;
151	}
152
153	return $default;
154	}
155
156	/**
157	* @author Vova Feldman (@svovaf)
158	* @since 1.1.6
159	*
160	* @param string $key
161	* @param mixed $default
162	*
163	* @return mixed
164	*/
165	function get_valid( $key, $default = null ) {
166	$this->_logger->entrance( 'key = ' . $key );
167
168	$cache_entry = $this->_options->get_option( $key, false );
169
170	if ( is_object( $cache_entry ) &&
171	isset( $cache_entry->timestamp ) &&
172	is_numeric( $cache_entry->timestamp ) &&
173	$cache_entry->timestamp > WP_FS__SCRIPT_START_TIME
174	) {
175	return $cache_entry->result;
176	}
177
178	return $default;
179	}
180
181	/**
182	* @author Vova Feldman (@svovaf)
183	* @since 1.1.6
184	*
185	* @param string $key
186	* @param mixed $value
187	* @param int $expiration
188	*/
189	function set( $key, $value, $expiration = WP_FS__TIME_24_HOURS_IN_SEC ) {
190	$this->_logger->entrance( 'key = ' . $key );
191
192	$cache_entry = new stdClass();
193	$cache_entry->result = $value;
194	$cache_entry->timestamp = WP_FS__SCRIPT_START_TIME + $expiration;
195	$this->_options->set_option( $key, $cache_entry, true );
196	}
197
198	/**
199	* Get cached record expiration, or false if not cached or expired.
200	*
201	* @author Vova Feldman (@svovaf)
202	* @since 1.1.7.3
203	*
204	* @param string $key
205	*
206	* @return bool\|int
207	*/
208	function get_record_expiration( $key ) {
209	$this->_logger->entrance( 'key = ' . $key );
210
211	$cache_entry = $this->_options->get_option( $key, false );
212
213	if ( is_object( $cache_entry ) &&
214	isset( $cache_entry->timestamp ) &&
215	is_numeric( $cache_entry->timestamp ) &&
216	$cache_entry->timestamp > WP_FS__SCRIPT_START_TIME
217	) {
218	return $cache_entry->timestamp;
219	}
220
221	return false;
222	}
223
224	/**
225	* Purge cached item.
226	*
227	* @author Vova Feldman (@svovaf)
228	* @since 1.1.6
229	*
230	* @param string $key
231	*/
232	function purge( $key ) {
233	$this->_logger->entrance( 'key = ' . $key );
234
235	$this->_options->unset_option( $key, true );
236	}
237	}