OutputCache
extends AbstractPattern
in package
Table of Contents
- $keyStack : array<string|int, mixed>
- The key stack
- $options : PatternOptions
- end() : bool
- Stops buffering output, write buffered data to cache using the given key on start() and displays the buffer.
- getOptions() : PatternOptions
- Get all pattern options
- setOptions() : OutputCache
- Set options
- start() : bool
- if there is a cached item with the given key display it's data and return true else start buffering output until end() is called or the script ends.
Properties
$keyStack
The key stack
protected
array<string|int, mixed>
$keyStack
= []
$options
protected
PatternOptions
$options
Methods
end()
Stops buffering output, write buffered data to cache using the given key on start() and displays the buffer.
public
end() : bool
Tags
Return values
bool —TRUE on success, FALSE on failure writing to cache
getOptions()
Get all pattern options
public
getOptions() : PatternOptions
Return values
PatternOptions —setOptions()
Set options
public
setOptions(PatternOptions $options) : OutputCache
Parameters
- $options : PatternOptions
Tags
Return values
OutputCache —Provides a fluent interface
start()
if there is a cached item with the given key display it's data and return true else start buffering output until end() is called or the script ends.
public
start(string $key) : bool
Parameters
- $key : string
-
Key