Class cache_api

cache_api implements cache_api_interface

Direct known subclasses

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

Abstract
Package: SMF
Copyright: 2020 Simple Machines and individual contributors
License: BSD
Author: Simple Machines https://www.simplemachines.org
Located at Sources/Class-CacheAPI.php

Methods summary
`public`	# `__construct( )` Does basic setup of a cache method when we create the object but before we call connect. Does basic setup of a cache method when we create the object but before we call connect.
`public boolean`	# `isSupported( boolean $test = false )` Checks whether we can use the cache method performed by this API. Checks whether we can use the cache method performed by this API. Parameters `$test` Test if this is supported or enabled. Returns boolean Whether or not the cache is supported Implementation of `cache_api_interface::isSupported()`
`public boolean`	# `connect( )` Connects to the cache method. This defines our $key. If this fails, we return false, otherwise we return true. Connects to the cache method. This defines our $key. If this fails, we return false, otherwise we return true. Returns boolean Whether or not the cache method was connected to. Implementation of `cache_api_interface::connect()`
`public boolean`	# `setPrefix( string $prefix = '' )` Overrides the default prefix. If left alone, this will use the default key defined in the class. Overrides the default prefix. If left alone, this will use the default key defined in the class. Parameters `$prefix` $key The key to use Returns boolean If this was successful or not. Implementation of `cache_api_interface::setPrefix()`
`public string`	# `getPrefix( )` Gets the prefix as defined from set or the default. Gets the prefix as defined from set or the default. Returns string the value of $key. Implementation of `cache_api_interface::getPrefix()`
`public boolean`	# `setDefaultTTL( integer $ttl = 120 )` Sets a default Time To Live, if this isn't specified we let the class define it. Sets a default Time To Live, if this isn't specified we let the class define it. Parameters `$ttl` The default TTL Returns boolean If this was successful or not. Implementation of `cache_api_interface::setDefaultTTL()`
`public string`	# `getDefaultTTL( )` Gets the TTL as defined from set or the default. Gets the TTL as defined from set or the default. Returns string the value of $ttl. Implementation of `cache_api_interface::getDefaultTTL()`
`public mixed`	# `getData( string $key, string $ttl = null )` Gets data from the cache. Gets data from the cache. Parameters `$key` The key to use, the prefix is applied to the key name. `$ttl` Overrides the default TTL. Returns mixed The result from the cache, if there is no data or it is invalid, we return null. Implementation of `cache_api_interface::getData()`
`public boolean`	# `putData( string $key, mixed $value, string $ttl = null )` Saves to data the cache. Saves to data the cache. Parameters `$key` The key to use, the prefix is applied to the key name. `$value` The data we wish to save. `$ttl` Overrides the default TTL. Returns boolean Whether or not we could save this to the cache. Implementation of `cache_api_interface::putData()`
`public boolean`	# `cleanCache( string $type = '' )` Clean out the cache. Clean out the cache. Parameters `$type` If supported, the type of cache to clear, blank/data or user. Returns boolean Whether or not we could clean the cache. Implementation of `cache_api_interface::cleanCache()`
`public boolean`	# `invalidateCache( )` Invalidate all cached data. Invalidate all cached data. Returns boolean Whether or not we could invalidate the cache. Implementation of `cache_api_interface::invalidateCache()`
`public boolean`	# `quit( )` Closes connections to the cache method. Closes connections to the cache method. Returns boolean Whether or not we could close connections. Implementation of `cache_api_interface::quit()`
`public`	# `cacheSettings( array & $config_vars )` Specify custom settings that the cache API supports. Specify custom settings that the cache API supports. Parameters `$config_vars` Additional config_vars, see ManageSettings.php for usage. Returns No return is needed. Implementation of `cache_api_interface::cacheSettings()`
`public string`	# `getCompatibleVersion( )` Gets the latest version of SMF this is compatible with. Gets the latest version of SMF this is compatible with. Returns string the value of $key. Implementation of `cache_api_interface::getCompatibleVersion()`
`public string`	# `getMinimumVersion( )` Gets the min version that we support. Gets the min version that we support. Returns string the value of $key. Implementation of `cache_api_interface::getMinimumVersion()`
`public string`	# `getVersion( )` Gets the Version of the Caching API. Gets the Version of the Caching API. Returns string the value of $key. Implementation of `cache_api_interface::getVersion()`
`public`	# `housekeeping( )` Run housekeeping of this cache exp. clean up old data or do optimization Run housekeeping of this cache exp. clean up old data or do optimization Implementation of `cache_api_interface::housekeeping()`

Properties summary
`protected string`	`$version_compatible` The maximum SMF version that this will work with. The maximum SMF version that this will work with.	# `'2.1.999'`
`protected string`	`$min_smf_version` The minimum SMF version that this will work with. The minimum SMF version that this will work with.	# `'2.1 RC1'`
`protected string`	`$prefix` The prefix for all keys. The prefix for all keys.	# `''`
`protected integer`	`$ttl` The default TTL. The default TTL.	# `120`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class cache_api

Direct known subclasses

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Implementation of