Class smf_cache

Our Cache API class

cache_api implements cache_api_interface

smf_cache

Package: cacheAPI
Copyright: 2020 Simple Machines and individual contributors
License: BSD
Author: Simple Machines https://www.simplemachines.org
Located at Sources/CacheAPI-smf.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. Overrides `cache_api::__construct()`
`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 Overrides `cache_api::isSupported()`
`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. Overrides `cache_api::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. Overrides `cache_api::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. Overrides `cache_api::cleanCache()`
`public boolean`	# `invalidateCache( )` Invalidate all cached data. Invalidate all cached data. Returns boolean Whether or not we could invalidate the cache. Overrides `cache_api::invalidateCache()`
`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. Overrides `cache_api::cacheSettings()`
`public boolean`	# `setCachedir( string $dir = null )` Sets the $cachedir or uses the SMF default $cachedir.. Sets the $cachedir or uses the SMF default $cachedir.. Parameters `$dir` A valid path Returns boolean If this was successful or not.
`public string`	# `getCachedir( )` Gets the current $cachedir. Gets the current $cachedir. Returns string the value of $ttl.
`public string`	# `getVersion( )` Gets the Version of the Caching API. Gets the Version of the Caching API. Returns string the value of $key. Overrides `cache_api::getVersion()`

Methods inherited from cache_api
`connect(), getCompatibleVersion(), getDefaultTTL(), getMinimumVersion(), getPrefix(), housekeeping(), quit(), setDefaultTTL(), setPrefix()`

Properties inherited from cache_api
`$min_smf_version, $prefix, $ttl, $version_compatible`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class smf_cache

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Returns

Returns

Overrides