include/SugarCache/SugarCache.php
inherited
Classes
Functions
check_cache(
)
:
voidInternal -- Determine if there is an external cache available for use.
- Deprecated
external_cache_retrieve_helper(
\unknown_type $key
)
:
\unknownInternal -- This function actually retrieves information from the caches.
It is a helper function that provides that actual cache API abstraction.
| Name | Type | Description |
|---|---|---|
| $key | \unknown_type |
| Type | Description |
|---|---|
| \unknown |
- Deprecated
- See
- \sugar_cache_retrieve
sugar_cache_clear(
String $key
)
:
voidClear a key from the cache. This is used to invalidate a single key.
| Name | Type | Description |
|---|---|---|
| $key | String | -- Key from global namespace |
sugar_cache_put(
String $key, \Serializable $value, $ttl
=
null
)
:
voidPut a value in the cache under a key
| Name | Type | Description |
|---|---|---|
| $key | String | -- Global namespace cache. Key for the data. |
| $value | \Serializable | -- The value to store in the cache. |
| $ttl |
sugar_cache_reset(
)
:
voidTurn off external caching for the rest of this round trip and for all round trips for the next cache timeout. This function should be called when global arrays are affected (studio, module loader, upgrade wizard, ... ) and it is not ok to wait for the cache to expire in order to see the change.
sugar_cache_reset_full(
)
:
voidFlush the cache in its entirety including the local and external store along with the opcodes.
sugar_cache_retrieve(
String $key
)
:
\TheRetrieve a key from cache. For the Zend Platform, a maximum age of 5 minutes is assumed.
| Name | Type | Description |
|---|---|---|
| $key | String | -- The item to retrieve. |
| Type | Description |
|---|---|
| \The | item unserialized |
sugar_cache_validate(
)
:
trueThis function is called once an external cache has been identified to ensure that it is correctly working.
| Type | Description |
|---|---|
| true | for success, false for failure. |
- Deprecated
sugar_clean_opcodes(
)
:
voidClean out whatever opcode cache we may have out there.
\SugarCache
Sugar Cache manager
- Api
Constants
Properties
$_cacheInstance= ''
- Type
- n/a
true
$isCacheReset= 'false'
falseDetails- Type
- true
Methods
__construct(
)
:
void_init(
)
:
voidinitializes the cache in question
cleanOpcodes(
)
:
voidTry to reset any opcode caches we know about
- Todo
- make it so developers can extend this somehow
instance(
)
:
voidReturns the instance of the SugarCacheAbstract object, cooresponding to the external cache being used.