Collaboration diagram for PHPExcel_CachedObjectStorageFactory:

Static Public Member Functions
static	getCacheStorageMethod ()
	Return the current cache storage method. More...

static	getCacheStorageClass ()
	Return the current cache storage class. More...

static	getAllCacheStorageMethods ()
	Return the list of all possible cache storage methods. More...

static	getCacheStorageMethods ()
	Return the list of all available cache storage methods. More...

static	initialize ($method=self::cache_in_memory, $arguments=array())
	Identify the cache storage method to use. More...

static	getInstance (PHPExcel_Worksheet $parent)
	Initialise the cache storage. More...

static	finalize ()
	Clear the cache storage. More...

Data Fields
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'

Static Private Attributes
static	$_cacheStorageMethod = NULL

static	$_cacheStorageClass = NULL

static	$_storageMethods

static	$_storageMethodDefaultParameters

static	$_storageMethodParameters = array()

Detailed Description

Definition at line 37 of file CachedObjectStorageFactory.php.

Member Function Documentation

◆ finalize()

static PHPExcel_CachedObjectStorageFactory::finalize ( )

static

Clear the cache storage.

Definition at line 244 of file CachedObjectStorageFactory.php.

References array.

Referenced by CellCollectionTest\testCacheLastCell().

         {
                 self::$_cacheStorageMethod = NULL;
                 self::$_cacheStorageClass = NULL;
                 self::$_storageMethodParameters = array();
         }

Here is the caller graph for this function:

◆ getAllCacheStorageMethods()

static PHPExcel_CachedObjectStorageFactory::getAllCacheStorageMethods ( )

static

Return the list of all possible cache storage methods.

Returns: string[]

Definition at line 155 of file CachedObjectStorageFactory.php.

     {
         return self::$_storageMethods;
     }   //    function getCacheStorageMethods()

◆ getCacheStorageClass()

static PHPExcel_CachedObjectStorageFactory::getCacheStorageClass ( )

static

Return the current cache storage class.

Returns: PHPExcel_CachedObjectStorage_ICache|NULL

Definition at line 144 of file CachedObjectStorageFactory.php.

Referenced by PHPExcel_Settings\getCacheStorageClass().

     {
         return self::$_cacheStorageClass;
     }   //    function getCacheStorageClass()

Here is the caller graph for this function:

◆ getCacheStorageMethod()

static PHPExcel_CachedObjectStorageFactory::getCacheStorageMethod ( )

static

Return the current cache storage method.

Returns: string|NULL

Definition at line 133 of file CachedObjectStorageFactory.php.

Referenced by PHPExcel_Settings\getCacheStorageMethod().

     {
         return self::$_cacheStorageMethod;
     }   //    function getCacheStorageMethod()

Here is the caller graph for this function:

◆ getCacheStorageMethods()

static PHPExcel_CachedObjectStorageFactory::getCacheStorageMethods ( )

static

Return the list of all available cache storage methods.

Returns: string[]

Definition at line 166 of file CachedObjectStorageFactory.php.

References array.

Referenced by CellCollectionTest\testCacheLastCell().

     {
         $activeMethods = array();
         foreach(self::$_storageMethods as $storageMethod) {
             $cacheStorageClass = 'PHPExcel_CachedObjectStorage_' . $storageMethod;
             if (call_user_func(array($cacheStorageClass, 'cacheMethodIsAvailable'))) {
                 $activeMethods[] = $storageMethod;
             }
         }
         return $activeMethods;
     }   //    function getCacheStorageMethods()

Here is the caller graph for this function:

◆ getInstance()

static PHPExcel_CachedObjectStorageFactory::getInstance ( PHPExcel_Worksheet $parent )

static

Initialise the cache storage.

Parameters

PHPExcel_Worksheet $parent Enable cell caching for this worksheet

Returns: PHPExcel_CachedObjectStorage_ICache

Definition at line 220 of file CachedObjectStorageFactory.php.

Referenced by PHPExcel_Worksheet\__construct().

     {
         $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()

Here is the caller graph for this function:

◆ initialize()

static PHPExcel_CachedObjectStorageFactory::initialize	(	$method = `self::cache_in_memory`,
		$arguments = `array()`
	)

static

Identify the cache storage method to use.

Parameters

string	$method	Name of the method to use for cell cacheing
	array	of mixed $arguments Additional arguments to pass to the cell caching class when instantiating

Returns: boolean

Definition at line 187 of file CachedObjectStorageFactory.php.

References array.

Referenced by PHPExcel_Settings\setCacheStorageMethod(), and CellCollectionTest\testCacheLastCell().

     {
         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 (array_key_exists($k, self::$_storageMethodParameters[$method])) {
                 self::$_storageMethodParameters[$method][$k] = $v;
             }
         }
 
         if (self::$_cacheStorageMethod === NULL) {
             self::$_cacheStorageClass = 'PHPExcel_CachedObjectStorage_' . $method;
             self::$_cacheStorageMethod = $method;
         }
         return TRUE;
     }   //    function initialize()

Here is the caller graph for this function:

Field Documentation

◆ $_cacheStorageClass

PHPExcel_CachedObjectStorageFactory::$_cacheStorageClass = NULL

staticprivate

Definition at line 64 of file CachedObjectStorageFactory.php.

◆ $_cacheStorageMethod

PHPExcel_CachedObjectStorageFactory::$_cacheStorageMethod = NULL

staticprivate

Definition at line 57 of file CachedObjectStorageFactory.php.

◆ $_storageMethodDefaultParameters

PHPExcel_CachedObjectStorageFactory::$_storageMethodDefaultParameters

staticprivate

Initial value:

= 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(
                                                    ),
    )

Definition at line 92 of file CachedObjectStorageFactory.php.

◆ $_storageMethodParameters

PHPExcel_CachedObjectStorageFactory::$_storageMethodParameters = array()

staticprivate

Definition at line 125 of file CachedObjectStorageFactory.php.

◆ $_storageMethods

PHPExcel_CachedObjectStorageFactory::$_storageMethods

staticprivate

Initial value:

= 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,
    )

Definition at line 72 of file CachedObjectStorageFactory.php.