Class CaptureCache

Summary

Fully Qualified Name: Laminas\Cache\Pattern\CaptureCache
Extends: AbstractPattern

Description

Methods

Name Description Defined By
clearByGlob() Clear cached pages matching glob pattern CaptureCache
get() Get from cache CaptureCache
getFilename() Returns the generated file name. CaptureCache
getOptions() Get all pattern options AbstractPattern
has() Checks if a cache with given id exists CaptureCache
remove() Remove from cache CaptureCache
set() Write content to page identity CaptureCache
setOptions() Set pattern options AbstractPattern
start() Start the cache CaptureCache

Method Details

clearByGlob()

Clear cached pages matching glob pattern

Parameter Name Type Description
$pattern string

Returns:

get()

Get from cache

Parameter Name Type Description
$pageId null|string

Returns: string|null

getFilename()

Returns the generated file name.

Parameter Name Type Description
$pageId null|string

Returns: string

getOptions()

Get all pattern options

Returns: \PatternOptions

has()

Checks if a cache with given id exists

Parameter Name Type Description
$pageId null|string

Returns: bool

remove()

Remove from cache

Parameter Name Type Description
$pageId null|string

Returns: bool

set()

Write content to page identity

Parameter Name Type Description
$content string
$pageId null|string

Returns:

setOptions()

Set pattern options

Parameter Name Type Description
$options \PatternOptions

Returns: \AbstractPattern Provides a fluent interface

start()

Start the cache

Parameter Name Type Description
$pageId string Page

Returns: void

Top