Class CacheManager

Provides a standardized cache access

Namespace: Xoops\Core\Cache
Package: CacheManager
Category: Xoops\Core\Cache
Copyright: 2015 The XOOPS Project https://github.com/XOOPS
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Richard Griffith richard@geekwright.com
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Cache/CacheManager.php

Methods summary
`public`	# `__construct( )` __construct __construct
`public static`	# `createDefaultConfig( )` Create a default configuration file, used in installation Create a default configuration file, used in installation When using Windows NTFS, PHP has a maximum path length of 260 bytes. Each key level in a Stash hierarchical key corresponds to a directory, and is normalized as an md5 hash. Also, Stash uses 2 levels for its own integrity ad locking mechanisms. The full key length used in XoopCore can reach 202 charachters. If the combined path length would excede 260, we will try and switch to SQLite driver if it is available when running on a Windows system.
`public Xoops\Core\Cache\Access`	# `getCache( string $name )` Get a cache corresponding to the specified name Get a cache corresponding to the specified name Parameters `$name` Name of cache definition Returns `Xoops\Core\Cache\Access` object
`protected Xoops\Core\Cache\Access\|false`	# `startPoolAccess( string $name )` Instantiate an Access object from named configuration, including instantiating pool and driver Instantiate an Access object from named configuration, including instantiating pool and driver Parameters `$name` name of pool configuration to start Returns `Xoops\Core\Cache\Access`\|false pool or false if a pool cannot be created
`protected Stash\Interfaces\DriverInterface\|false`	# `getDriver( string $driverName, array $options )` getDriver getDriver Parameters `$driverName` short name of the driver `$options` array of options for the driver Returns Stash\Interfaces\DriverInterface\|false driver object or false if it could not be instantiated
`protected Xoops\Core\Cache\Access`	# `getDefaultPool( string $originalName )` Get an Access object based on the default pool. If it isn't set, create it. If no definition exists for default, use Stash default (Ephimeral.) Get an Access object based on the default pool. If it isn't set, create it. If no definition exists for default, use Stash default (Ephimeral.) Parameters `$originalName` originally requested pool configuration name Returns `Xoops\Core\Cache\Access` object

Properties summary
`protected Xoops\Core\Cache\Access[]`	`$pools` Cache Access objects for pools Cache Access objects for pools	# `array()`
`protected array`	`$poolDefs` Pool definitions Pool definitions	# `array( )`
`protected Xoops`	`$xoops` Xoops instance Xoops instance	#

Namespaces

Classes

Class CacheManager

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns