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\HeadlessContentBlockerAbstractBlockable

Describe a blockable item by selector syntax and regular expressions (e.g. to be used in `href` and `src`).

Summary

Methods
Properties
Constants
__construct()
appendFromStringArray()
findSelectorSyntaxFinderForMatch()
getBlockerId()
getRequiredIds()
getCriteria()
hasBlockerId()
getSelectorSyntaxFinder()
getRegularExpressions()
getContainsRegularExpressions()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$selectorSyntaxFinder
$regexp
$headlessContentBlocker
N/A

Properties

$regexp

$regexp :

Type

$headlessContentBlocker

$headlessContentBlocker :

Type

Methods

appendFromStringArray()

appendFromStringArray(array<mixed,string>  $blockers)

Generate the custom element blockers and regular expressions and append it to this blockable instance.

Parameters

array<mixed,string> $blockers

findSelectorSyntaxFinderForMatch()

findSelectorSyntaxFinderForMatch(\DevOwl\FastHtmlTag\finder\match\AbstractMatch  $match)

Find a `SyntaxSelectorFinder` for a given `AbstractMatch`.

Parameters

\DevOwl\FastHtmlTag\finder\match\AbstractMatch $match

getBlockerId()

getBlockerId(): integer|null

Get the blocker ID. This is added as a custom HTML attribute to the blocked element so your frontend can e.g. add a visual content blocker.

Returns

integer|null

getRequiredIds()

getRequiredIds(): array<mixed,integer>

Get required IDs. This is added as a custom HTML attribute to the blocked element so your frontend can determine which items by ID are needed so the item can be unblocked.

Returns

array<mixed,integer>

getCriteria()

getCriteria(): string

The criteria type. This is added as a custom HTML attribute to the blocked element so your frontend can determine the origin for the `getRequiredIds`.

E.g. differ between TCF vendors and another custom criteria.

Returns

string

hasBlockerId()

hasBlockerId()

Determine if this blockable should be blocked.

getSelectorSyntaxFinder()

getSelectorSyntaxFinder()

Getter.

getRegularExpressions()

getRegularExpressions(): array<mixed,string>

Getter.

Returns

array<mixed,string>

getContainsRegularExpressions()

getContainsRegularExpressions(): array<mixed,string>

Getter.

Returns

array<mixed,string>