AbstractCache
in package
Implement a cache mechanism / plugin.
Table of Contents
Methods
- excludeAssetsHook() : void|false
- Exclude JavaScript and CSS assets.
- excludeHtmlAttribute() : false|string
- Similar to `excludeAssetsHook`, but instead of using hooks you can use `CacheInvalidator#getExcludeHtmlAttributesString()` to append to your HTML markup so it gets ignored by the cache plugin.
- failureExcludeAssets() : void|bool
- Returns `true` if the plugin does not support excluding assets but has the feature in general.
- invalidate() : mixed
- Trigger a cache invalidation.
- isActive() : bool
- Check if the caching mechanism / plugin is active and available.
- label() : mixed
- Get the label.
- addExcludeHtmlAttributeLoaderTagFilter() : mixed
- Add defined `excludeHtmlAttribute` as HTML attribute to all affected Script/Link tags.
- addExcludeStyleTagFromRucssProcessAttributeTagFilter() : mixed
- Add `skip-rucss` as HTML attribute to all affected link tags.
Methods
excludeAssetsHook()
Exclude JavaScript and CSS assets.
public
excludeAssetsHook(ExcludeAssets $excludeAssets) : void|false
Parameters
- $excludeAssets : ExcludeAssets
Return values
void|false —Returns false if the plugin does not support excluding assets but has the feature in general
excludeHtmlAttribute()
Similar to `excludeAssetsHook`, but instead of using hooks you can use `CacheInvalidator#getExcludeHtmlAttributesString()` to append to your HTML markup so it gets ignored by the cache plugin.
public
excludeHtmlAttribute() : false|string
Return values
false|stringfailureExcludeAssets()
Returns `true` if the plugin does not support excluding assets but has the feature in general.
public
failureExcludeAssets() : void|bool
Returns void if the does not have this feature or when excluding is supported.
Return values
void|boolinvalidate()
Trigger a cache invalidation.
public
abstract invalidate() : mixed
isActive()
Check if the caching mechanism / plugin is active and available.
public
abstract isActive() : bool
Return values
boollabel()
Get the label.
public
abstract label() : mixed
addExcludeHtmlAttributeLoaderTagFilter()
Add defined `excludeHtmlAttribute` as HTML attribute to all affected Script/Link tags.
protected
addExcludeHtmlAttributeLoaderTagFilter(ExcludeAssets $excludeAssets) : mixed
Parameters
- $excludeAssets : ExcludeAssets
addExcludeStyleTagFromRucssProcessAttributeTagFilter()
Add `skip-rucss` as HTML attribute to all affected link tags.
protected
addExcludeStyleTagFromRucssProcessAttributeTagFilter(ExcludeAssets $excludeAssets) : mixed
Parameters
- $excludeAssets : ExcludeAssets