\DevOwl\HeadlessContentBlocker\plugins\scannerScannableBlockable

__construct()

__construct(\DevOwl\HeadlessContentBlocker\HeadlessContentBlocker  $headlessContentBlocker,string  $identifier,string  $extended = null,array<mixed,\DevOwl\HeadlessContentBlocker\plugins\scanner\Rule>|array<mixed,array>  $rules = array())

C'tor.

Example array for $rules:

[
    [
         'expression' => "*google.com/recaptcha*",
         // If you want to configure group resolving, you need to configure the appropriated group via `$hostGroups`.
         // Otherwise, defaults of the group are considered. Means: Without group configured it will be marked as
         // "one rule within the group must-be-resolved".
         'assignedToGroups' => 'script', // can be string[]
         'queryArgs' => [
              [
                  'queryArg' => 'id',
                  'isOptional' => true,
                  'regexp' => '/^UA-/'
              ]
         ]
    ]
]

Parameters

appendFromStringArray()

appendFromStringArray(array<mixed,string>  $blockers)

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

Parameters

findSelectorSyntaxFinderForMatch()

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

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

Parameters

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

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

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

hasBlockerId()

hasBlockerId()

Determine if this blockable should be blocked.

getSelectorSyntaxFinder()

getSelectorSyntaxFinder()

Getter.

getRegularExpressions()

getRegularExpressions(): array<mixed,string>

Getter.

Returns

getContainsRegularExpressions()

getContainsRegularExpressions(): array<mixed,string>

Getter.

Returns

checkExpressionsMatchesGroups()

checkExpressionsMatchesGroups(array<mixed,string[]>  $expressionsMap)

Check if a set of expressions matches our configured groups.

Parameters

getGroupsWithExpressionsMap()

getGroupsWithExpressionsMap()

Get a map of `Record<string (group), string[] (expressions)>`.

getIdentifier()

getIdentifier()

Getter.

getOriginalExpressions()

getOriginalExpressions()

Getter.

getExtended()

getExtended()

Getter.

getRules()

getRules()

Getter.

getRulesByExpression()

getRulesByExpression(string  $expression): array<mixed,\DevOwl\HeadlessContentBlocker\plugins\scanner\Rule>

Getter.

Parameters

Returns