API Documentation
\
DevOwl
CacheInvalidate
caches
Customize
controls
DeliverAnonymousAsset
FastHtmlTag
finder
match
Freemium
HeadlessContentBlocker
finder
match
matcher
plugins
imagePreview
scanner
Multilingual
RealCookieBanner
base
comp
language
migration
import
lite
comp
language
presets
blocker
rest
settings
view
blocker
customize
banner
overrides
interfce
settings
presets
free
blocker
middleware
pro
blocker
rest
scanner
settings
view
blockable
blocker
checklist
customize
banner
individual
navmenu
shortcode
RealProductManagerWpClient
announcement
client
license
rest
view
RealQueue
queue
rest
RealUtils
cross
view
TcfVendorListNormalize
MatthiasWeb
Utils

\DevOwl\CacheInvalidate\cachesNginxHelperImpl

Nginx Helper.

Summary

Methods
Properties
Constants
isActive()
invalidate()
failureExcludeAssets()
excludeAssetsHook()
excludeHtmlAttribute()
label()
No public properties found
IDENTIFIER
AVAILABLE_PURGE_CLASSES
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

IDENTIFIER

IDENTIFIER ='nginx-helper'

AVAILABLE_PURGE_CLASSES

AVAILABLE_PURGE_CLASSES =array('FastCGI_Purger', 'PhpRedis_Purger', 'Predis_Purger')

Methods

isActive()

isActive(): boolean

Check if the caching mechanism / plugin is active and available.

Returns

boolean

invalidate()

invalidate(): mixed

Trigger a cache invalidation.

Returns

mixed

failureExcludeAssets()

failureExcludeAssets(): void|boolean

Returns `true` if the plugin does not support excluding assets but has the feature in general.

Returns void if the does not have this feature or when excluding is supported.

Returns

void|boolean

excludeAssetsHook()

excludeAssetsHook(\DevOwl\CacheInvalidate\ExcludeAssets  $excludeAssets): void|false

Exclude JavaScript and CSS assets.

Parameters

\DevOwl\CacheInvalidate\ExcludeAssets $excludeAssets

Returns

void|false —

Returns false if the plugin does not support excluding assets but has the feature in general

excludeHtmlAttribute()

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.

Returns

false|string

label()

label()

Get the label.