summaryrefslogtreecommitdiffstats
path: root/admin/survey/excel/PHPExcel/CachedObjectStorageFactory.php
blob: d523a20686a10f2ec04c8ed9aa8b4e4064a339ca (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
<?php

/**
 * PHPExcel
 *
 * Copyright (c) 2006 - 2012 PHPExcel
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * @category   PHPExcel
 * @package    PHPExcel
 * @copyright  Copyright (c) 2006 - 2012 PHPExcel (http://www.codeplex.com/PHPExcel)
 * @license    http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt	LGPL
 * @version    1.7.8, 2012-10-12
 */


/**
 * PHPExcel_CachedObjectStorageFactory
 *
 * @category	PHPExcel
 * @package		PHPExcel_CachedObjectStorage
 * @copyright	Copyright (c) 2006 - 2012 PHPExcel (http://www.codeplex.com/PHPExcel)
 */
class PHPExcel_CachedObjectStorageFactory
{
	const cache_in_memory				= 'Memory';
	const cache_in_memory_gzip			= 'MemoryGZip';
	const cache_in_memory_serialized	= 'MemorySerialized';
	const cache_igbinary				= 'Igbinary';
	const cache_to_discISAM				= 'DiscISAM';
	const cache_to_apc					= 'APC';
	const cache_to_memcache				= 'Memcache';
	const cache_to_phpTemp				= 'PHPTemp';
	const cache_to_wincache				= 'Wincache';
	const cache_to_sqlite				= 'SQLite';
	const cache_to_sqlite3				= 'SQLite3';


	/**
	 * Name of the method used for cell cacheing
	 *
	 * @var string
	 */
	private static $_cacheStorageMethod = NULL;

	/**
	 * Name of the class used for cell cacheing
	 *
	 * @var string
	 */
	private static $_cacheStorageClass = NULL;


	/**
	 * List of all possible cache storage methods
	 *
	 * @var string[]
	 */
	private static $_storageMethods = array(
		self::cache_in_memory,
		self::cache_in_memory_gzip,
		self::cache_in_memory_serialized,
		self::cache_igbinary,
		self::cache_to_phpTemp,
		self::cache_to_discISAM,
		self::cache_to_apc,
		self::cache_to_memcache,
		self::cache_to_wincache,
		self::cache_to_sqlite,
		self::cache_to_sqlite3,
	);


	/**
	 * Default arguments for each cache storage method
	 *
	 * @var array of mixed array
	 */
	private static $_storageMethodDefaultParameters = array(
		self::cache_in_memory				=> array(
													),
		self::cache_in_memory_gzip			=> array(
													),
		self::cache_in_memory_serialized	=> array(
													),
		self::cache_igbinary				=> array(
													),
		self::cache_to_phpTemp				=> array( 'memoryCacheSize'	=> '1MB'
													),
		self::cache_to_discISAM				=> array( 'dir'				=> NULL
													),
		self::cache_to_apc					=> array( 'cacheTime'		=> 600
													),
		self::cache_to_memcache				=> array( 'memcacheServer'	=> 'localhost',
													  'memcachePort'	=> 11211,
													  'cacheTime'		=> 600
													),
		self::cache_to_wincache				=> array( 'cacheTime'		=> 600
													),
		self::cache_to_sqlite				=> array(
													),
		self::cache_to_sqlite3				=> array(
													),
	);


	/**
	 * Arguments for the active cache storage method
	 *
	 * @var array of mixed array
	 */
	private static $_storageMethodParameters = array();


	/**
	 * Return the current cache storage method
	 *
	 * @return string|NULL
	 **/
	public static function getCacheStorageMethod()
	{
		return self::$_cacheStorageMethod;
	}	//	function getCacheStorageMethod()


	/**
	 * Return the current cache storage class
	 *
	 * @return PHPExcel_CachedObjectStorage_ICache|NULL
	 **/
	public static function getCacheStorageClass()
	{
		return self::$_cacheStorageClass;
	}	//	function getCacheStorageClass()


	/**
	 * Return the list of all possible cache storage methods
	 *
	 * @return string[]
	 **/
	public static function getAllCacheStorageMethods()
	{
		return self::$_storageMethods;
	}	//	function getCacheStorageMethods()


	/**
	 * Return the list of all available cache storage methods
	 *
	 * @return string[]
	 **/
	public static function getCacheStorageMethods()
	{
		$activeMethods = array();
		foreach(self::$_storageMethods as $storageMethod) {
			$cacheStorageClass = 'PHPExcel_CachedObjectStorage_' . $storageMethod;
			if (call_user_func(array($cacheStorageClass, 'cacheMethodIsAvailable'))) {
				$activeMethods[] = $storageMethod;
			}
		}
		return $activeMethods;
	}	//	function getCacheStorageMethods()


	/**
	 * Identify the cache storage method to use
	 *
	 * @param	string			$method		Name of the method to use for cell cacheing
	 * @param	array of mixed	$arguments	Additional arguments to pass to the cell caching class
	 *										when instantiating
	 * @return boolean
	 **/
	public static function initialize($method = self::cache_in_memory, $arguments = array())
	{
		if (!in_array($method,self::$_storageMethods)) {
			return FALSE;
		}

		$cacheStorageClass = 'PHPExcel_CachedObjectStorage_'.$method;
		if (!call_user_func(array( $cacheStorageClass,
								   'cacheMethodIsAvailable'))) {
			return FALSE;
		}

		self::$_storageMethodParameters[$method] = self::$_storageMethodDefaultParameters[$method];
		foreach($arguments as $k => $v) {
			if (isset(self::$_storageMethodParameters[$method][$k])) {
				self::$_storageMethodParameters[$method][$k] = $v;
			}
		}

		if (self::$_cacheStorageMethod === NULL) {
			self::$_cacheStorageClass = 'PHPExcel_CachedObjectStorage_' . $method;
			self::$_cacheStorageMethod = $method;
		}
		return TRUE;
	}	//	function initialize()


	/**
	 * Initialise the cache storage
	 *
	 * @param	PHPExcel_Worksheet 	$parent		Enable cell caching for this worksheet
	 * @return	PHPExcel_CachedObjectStorage_ICache
	 **/
	public static function getInstance(PHPExcel_Worksheet $parent)
	{
		$cacheMethodIsAvailable = TRUE;
		if (self::$_cacheStorageMethod === NULL) {
			$cacheMethodIsAvailable = self::initialize();
		}

		if ($cacheMethodIsAvailable) {
			$instance = new self::$_cacheStorageClass( $parent,
													   self::$_storageMethodParameters[self::$_cacheStorageMethod]
													 );
			if ($instance !== NULL) {
				return $instance;
			}
		}

		return FALSE;
	}	//	function getInstance()

}