Interface ICache

Direct known implementers

MvcCore\Ext\Caches\Redis

Namespace: MvcCore\Ext
Located at ext-cache/src/MvcCore/Ext/ICache.php

Methods summary
`public static MvcCore\Ext\Cache`	# `GetInstance( )` Create or get cached redis cache wrapper instance. Create or get cached redis cache wrapper instance. Returns `MvcCore\Ext\Cache`
`public boolean`	# `Connect( )` Connect to redis server by configuration given in constructor. Return boolean about connection success (not about cache enabled or disabled). Connect to redis server by configuration given in constructor. Return boolean about connection success (not about cache enabled or disabled). Returns boolean
`public resource\|object\|null`	# `GetResource( )` Get resource instance. Get resource instance. Returns resource\|object\|null
`public MvcCore\Ext\Cache`	# `SetResource( resource\|object $resource )` Set resource instance. Set resource instance. Parameters `$resource` Returns `MvcCore\Ext\Cache`
`public stdClass`	# `GetConfig( )` Return initial configuration data. Return initial configuration data. Returns stdClass
`public MvcCore\Ext\Cache`	# `SetEnabled( boolean $enabled )` Enable/disable cache component. Enable/disable cache component. Parameters `$enabled` $enable Returns `MvcCore\Ext\Cache`
`public boolean`	# `GetEnabled( )` Get if cache component is enabled/disabled. Get if cache component is enabled/disabled. Returns boolean
`public array`	# `ProcessTransaction( array $ops = [] )` Process given operations in transaction mode. Process given operations in transaction mode. Parameters `$ops` Keys are client functions names, values are functions arguments. Returns array
`public boolean`	# `Save( string $key, mixed $content, integer $expirationSeconds = NULL, array $cacheTags = [] )` Set content under key with seconds expiration and tag(s). Set content under key with seconds expiration and tag(s). Parameters `$key` `$content` `$expirationSeconds` `$cacheTags` Returns boolean
`public boolean`	# `SaveMultiple( array $keysAndContents, integer $expirationSeconds = NULL, array $cacheTags = [] )` Set multiple contents under keys with seconds expirations and tags. Set multiple contents under keys with seconds expirations and tags. Parameters `$keysAndContents` `$expirationSeconds` `$cacheTags` Returns boolean
`public mixed\|null`	# `Load( string $key, callable $notFoundCallback = NULL )` Return mixed content from cache by key or return `NULL` if content doens't exist in cache for given key. Return mixed content from cache by key or return `NULL` if content doens't exist in cache for given key. Parameters `$key` `$notFoundCallback` function ($cache, $cacheKey) { ... $cache->Save($cacheKey, $data); return $data; } Returns mixed\|null
`public mixed\|null`	# `LoadMultiple( array $keys, callable $notFoundCallback = NULL )` Get content by key. Get content by key. Parameters `$keys` `$notFoundCallback` function ($cache, $cacheKey) { ... $cache->Save($cacheKey, $data); return $data; } Returns mixed\|null
`public boolean`	# `Delete( string $key )` Delete cache record by key. Delete cache record by key. Parameters `$key` Returns boolean
`public integer`	# `DeleteMultiple( array $keys, array $keysTags = [] )` Delete cache record(s) by key(s). Delete cache record(s) by key(s). Parameters `$keys` `$keysTags` Returns integer
`public integer`	# `DeleteByTags( string\|array $tags )` Delete cache record by key. Delete cache record by key. Parameters `$tags` Returns integer
`public integer`	# `Has( string $key )` Return `1` if cache has any record under given key, `0` if not. Return `1` if cache has any record under given key, `0` if not. Parameters `$key` Returns integer
`public integer`	# `HasMultiple( string $keys )` Return `1` if cache has any record under given key, `0` if not. Return `1` if cache has any record under given key, `0` if not. Parameters `$keys` $key Returns integer
`public boolean`	# `Clear( )` Remove everything from used cache database. Remove everything from used cache database. Returns boolean

Constants summary
`string`	`CONNECTION_NAME` Connection `name` key for constructor configuration array. Connection `name` key for constructor configuration array.	# `'name'`
`string`	`CONNECTION_HOST` Connection `host` key for constructor configuration array. Connection `host` key for constructor configuration array.	# `'host'`
`string`	`CONNECTION_PORT` Connection `port` key for constructor configuration array. Connection `port` key for constructor configuration array.	# `'port'`
`string`	`CONNECTION_DATABASE` Connection `database` name key for constructor configuration array. Connection `database` name key for constructor configuration array.	# `'database'`
`string`	`CONNECTION_TIMEOUT` Connection `timeout` key for constructor configuration array. Connection `timeout` key for constructor configuration array.	# `'timeout'`
`string`	`TAG_PREFIX` Cache tag records prefix: `cache.tag.`. Cache tag records prefix: `cache.tag.`.	# `'cache.tag.'`