Documentation

AbstractBlockable

in package

• Application

implements SelectorSyntaxAttributeFunctionVariableResolver

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

Table of Contents

Interfaces

SelectorSyntaxAttributeFunctionVariableResolver

Properties

$expressionToStrposCache  : mixed

$headlessContentBlocker  : mixed

$originalExpressions  : array<string|int, string>

Original rules from string rules.

$regexp  : mixed

$selectorSyntaxFinder  : array<string|int, SelectorSyntaxFinder>

See `SelectorSyntaxFinder`.

$variables  : array<string|int, string>

Variables can be passed as rule in format `:$myVar=...` and can be reused in selector syntax function arguments.

Methods

__construct()  : mixed

C'tor.

appendFromStringArray()  : mixed

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

findSelectorSyntaxFinderForMatch()  : mixed

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

getBlockerId()  : int|string|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.

getContainsRegularExpressions()  : array<string|int, string>

Getter.

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`.

getOriginalExpressions()  : array<string|int, string>

Getter.

getRegularExpressions()  : array<string|int, string>

Getter.

getRequiredIds()  : array<string|int, int|string>

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.

getSelectorSyntaxFinder()  : mixed

Getter.

getVariable()  : mixed

getVariables()  : mixed

hasBlockerId()  : mixed

Determine if this blockable should be blocked.

matchesExpressionLoose()  : mixed

It is a performance-boost to extract the searchable strings for this expression, so we can first check for simple `contains` pattern with `strpos` instead of expensive `preg_match`.