Methods

Clear cached pages matching glob pattern

clearByGlob(string $pattern) 

Parameters

$pattern

string

Exceptions

\Zend\Cache\Exception\LogicException

Get from cache

get(null | string $pageId) : bool | string

Parameters

$pageId

nullstring

Exceptions

\Zend\Cache\Exception\LogicException
\Zend\Cache\Exception\RuntimeException

Returns

boolstring

Get all pattern options

getOptions() : \Zend\Cache\Pattern\PatternOptions
Inherited

inherited_from \Zend\Cache\Pattern\AbstractPattern::getOptions()

Returns

Checks if a cache with given id exists

has(null | string $pageId) : bool

Parameters

$pageId

nullstring

Exceptions

\Zend\Cache\Exception\LogicException

Returns

bool

Remove from cache

remove(null | string $pageId) : bool

Parameters

$pageId

nullstring

Exceptions

\Zend\Cache\Exception\LogicException
\Zend\Cache\Exception\RuntimeException

Returns

bool

Write content to page identity

set(string $content, null | string $pageId) 

Parameters

$content

string

$pageId

nullstring

Exceptions

\Zend\Cache\Exception\LogicException

Set pattern options

setOptions(\Zend\Cache\Pattern\PatternOptions $options) : \Zend\Cache\Pattern\AbstractPattern
Inherited

inherited_from \Zend\Cache\Pattern\AbstractPattern::setOptions()

Parameters

$options

array\Traversable\Zend\Cache\Pattern\PatternOptions

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

Start the cache

start(string $pageId) : void

Parameters

$pageId

string

Page identifier

Creates directory if not already done.

createDirectoryStructure(string $pathname) : void

Parameters

$pathname

string

Exceptions

\Zend\Cache\Exception\RuntimeException

Determine the page to save from the request

detectPageId() : string

Exceptions

\Zend\Cache\Exception\RuntimeException

Returns

string

Get filename for page id

pageId2Filename(string $pageId) : string

Parameters

$pageId

string

Returns

string

Get path for page id

pageId2Path(string $pageId) : string

Parameters

$pageId

string

Returns

string

Write content to a file

putFileContent(string $file, string $data) : void

Parameters

$file

string

File complete path

$data

string

Data to write

Exceptions

\Zend\Cache\Exception\RuntimeException

 Properties

 

$options

$options : \Zend\Cache\Pattern\PatternOptions
Inherited

inherited_from \Zend\Cache\Pattern\AbstractPattern::$$options