Interface

cache_api_interface

Interface cache_api_interface

Known implementers

apc_cache , apcu_cache , cache_api , memcache_cache , memcached_cache , postgres_cache , smf_cache , sqlite_cache , xcache_cache , zend_cache

Open source code

Methods Summary
`public`	# `isSupported( bool $test = false )` Checks whether we can use the cache method performed by this API. access
`public`	# `connect( )` Connects to the cache method. This defines our $key. If this fails, we return false, otherwise we return true. access
`public`	# `setPrefix( string $key = '' )` Overrides the default prefix. If left alone, this will use the default key defined in the class. access
`public`	# `getPrefix( )` Gets the prefix as defined from set or the default. access
`public`	# `setDefaultTTL( int $ttl = 120 )` Sets a default Time To Live, if this isn't specified we let the class define it. access
`public`	# `getDefaultTTL( )` Gets the TTL as defined from set or the default. access
`public`	# `getData( string $key , string $ttl = NULL )` Gets data from the cache. access
`public`	# `putData( string $key , mixed $value , string $ttl = NULL )` Saves to data the cache. access
`public`	# `cleanCache( string $type = '' )` Clean out the cache.
`public`	# `invalidateCache( )` Invalidate all cached data.
`public`	# `quit( )` Closes connections to the cache method. access
`public`	# `cacheSettings( array & $config_vars )` Specify custom settings that the cache API supports. access
`public`	# `getCompatibleVersion( )` Gets the latest version of SMF this is compatible with. access
`public`	# `getMiniumnVersion( )` Gets the min version that we support. access
`public`	# `getVersion( )` Gets the Version of the Caching API. access
`public`	# `housekeeping( )` Run housekeeping of this cache exp. clean up old data or do optimization access