Output Cache Functions

Note:

These functions are deprecated

output_cache_disable()

• Description: Disables output caching for currently running scripts.

• Return Values: none

• Parameters: none

output_cache_fetch()

string output_cache_fetch(string key, string function, int lifetime)

• Description: Gets the code’s return value from the cache if it is there, if not - run function and cache the value.

• Return Values: function's return

• Parameters: key - cache key, function - PHP expression, lifetime - data lifetime in cache (seconds)

output_cache_output()

string output_cache_output(string key, string function, int lifetime)

• Description: If the cache for the key exists, output it, otherwise capture expression output, cache and pass it out.

• Return Values: expression output

• Parameters: key - cache key, function - PHP expression, lifetime - data lifetime in cache (seconds)

output_cache_remove_key

bool output_cache_remove_key(string key)

• Description: Remove item from PHP API cache by key

• Return Values: true if OK

• Parameters: key - cache key as given to output_cache_get/output_cache_put

output_cache_put

bool output_cache_put(string key, mixed data)

• Description: Puts data in cache according to the assigned key.

• Return Values: true if OK

• Parameters: key - cache key, data - cached data (must not contain objects or resources)

output_cache_get

mixed output_cache_get(string key, int lifetime)

• Description: Gets cached data according to the assigned key.

• Return Values: cached data if cache exists, false otherwise

• Parameters: key - cache key, lifetime - cache validity time (seconds)

output_cache_exists

bool output_cache_exists(string key, int lifetime)

• Description: If data for assigned key exists, this function outputs it and returns a value of true. If not, it starts capturing the output. To be used in pair with output_cache_stop.

• Return Values: true if cached data exists

• Parameters: key - cache key, lifetime - cache data validity time (seconds)

output_cache_stop

• Description: If output was captured by output_cache_exists, this function stops the output capture and stores the data under the key that was given to output_cache_exists().