\PHPExcel_CachedObjectStorageFactory

PHPExcel_CachedObjectStorageFactory

Copyright (c) 2006 - 2015 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

Summary

Methods
Properties
Constants
getCacheStorageMethod()
getCacheStorageClass()
getAllCacheStorageMethods()
getCacheStorageMethods()
initialize()
getInstance()
finalize()
No public properties found
cache_in_memory
cache_in_memory_gzip
cache_in_memory_serialized
cache_igbinary
cache_to_discISAM
cache_to_apc
cache_to_memcache
cache_to_phpTemp
cache_to_wincache
cache_to_sqlite
cache_to_sqlite3
No protected methods found
No protected properties found
N/A
No private methods found
$cacheStorageMethod
$cacheStorageClass
$storageMethods
$storageMethodDefaultParameters
$storageMethodParameters
N/A

Constants

cache_in_memory

cache_in_memory = 'Memory'

cache_in_memory_gzip

cache_in_memory_gzip = 'MemoryGZip'

cache_in_memory_serialized

cache_in_memory_serialized = 'MemorySerialized'

cache_igbinary

cache_igbinary = 'Igbinary'

cache_to_discISAM

cache_to_discISAM = 'DiscISAM'

cache_to_apc

cache_to_apc = 'APC'

cache_to_memcache

cache_to_memcache = 'Memcache'

cache_to_phpTemp

cache_to_phpTemp = 'PHPTemp'

cache_to_wincache

cache_to_wincache = 'Wincache'

cache_to_sqlite

cache_to_sqlite = 'SQLite'

cache_to_sqlite3

cache_to_sqlite3 = 'SQLite3'

Properties

$cacheStorageMethod

$cacheStorageMethod : string

Name of the method used for cell cacheing

Type

string

$cacheStorageClass

$cacheStorageClass : string

Name of the class used for cell cacheing

Type

string

$storageMethods

$storageMethods : array<mixed,string>

List of all possible cache storage methods

Type

array<mixed,string>

$storageMethodDefaultParameters

$storageMethodDefaultParameters : array

Default arguments for each cache storage method

Type

array — of mixed array

$storageMethodParameters

$storageMethodParameters : array

Arguments for the active cache storage method

Type

array — of mixed array

Methods

getCacheStorageMethod()

getCacheStorageMethod() : string|null

Return the current cache storage method

Returns

string|null

getCacheStorageClass()

getCacheStorageClass() : \PHPExcel_CachedObjectStorage_ICache|null

Return the current cache storage class

Returns

\PHPExcel_CachedObjectStorage_ICache|null

getAllCacheStorageMethods()

getAllCacheStorageMethods() : array<mixed,string>

Return the list of all possible cache storage methods

Returns

array<mixed,string>

getCacheStorageMethods()

getCacheStorageMethods() : array<mixed,string>

Return the list of all available cache storage methods

Returns

array<mixed,string>

initialize()

initialize(string  $method = self::cache_in_memory,   $arguments = array()) : boolean

Identify the cache storage method to use

Parameters

string $method

Name of the method to use for cell cacheing

$arguments

Returns

boolean

finalize()

finalize() 

Clear the cache storage