Documentation

EvalJs extends AbstractPlugin
in package

This plugin registers the selector syntax `eval()`.

div[class="my-div":eval(js={{ .myJs }})]
:$myJs=console.log("test");

Parameters:

  • js (string): JavaScript which gets executed when node gets unblocked
  • [scope=once] (string): Can be node (executed for each unblocked node, use JavaScript variable this to access the HTML node) or once (when content blocker gets unblocked and runs for all unblocked nodes)

Table of Contents

Constants

SCRIPT_PLACEHOLDER  = '<' . self::class . '/>'

Properties

$counters  : mixed
$headlessContentBlocker  : mixed
$i  : mixed
$js  : mixed

Methods

__construct()  : mixed
C'tor.
addScript()  : mixed
Add the `<script` with the proper event listeners to the document.
afterSetup()  : mixed
The content blocker got setup completely.
beforeMatch()  : mixed
Called before a match got found.
blockableStringExpression()  : string
Allows to modify the passed string expression to a blockable.
blockedMatch()  : mixed
Called after a match got blocked.
checkResult()  : BlockedResult
Called after a match got found and the matcher decided, if it should be blocked or not.
fn()  : mixed
Function implementation.
getHeadlessContentBlocker()  : mixed
Getter.
init()  : mixed
Initialize your plugin add e.g. new visual parent definitions.
inlineStyleBlockRule()  : bool
Decide if a URL in a CSS rule should be blocked.
inlineStyleModifyDocuments()  : bool
Allows to modify blocked CSS documents.
inlineStyleShouldBeExtracted()  : bool
Do not extract blocked rules of a CSS inline script to a second document.
keepAlwaysAttributes()  : array<string|int, string>
Keep attributes for a specific match.
modifyHtmlAfterProcessing()  : mixed
Allows to modify the HTML after the content blocker has done its job.
notBlockedMatch()  : mixed
Called after a match got not blocked. Opposite of `blockedMatch`.
setup()  : mixed
Before the content blocker gets setup.
skipInlineScriptVariableAssignment()  : array<string|int, string>
Skip inline script by variable name.
visualParent()  : bool|string|number
Set a visual parent for a specific match.

Constants

SCRIPT_PLACEHOLDER

public mixed SCRIPT_PLACEHOLDER = '<' . self::class . '/>'

Properties

$counters

private mixed $counters = []

$js

private mixed $js = ['code' => [], 'node' => [], 'once' => [], 'blocker' => []]

Methods

addScript()

Add the `<script` with the proper event listeners to the document.

public addScript(string $html) : mixed
Parameters
$html : string

afterSetup()

The content blocker got setup completely.

public afterSetup() : mixed

blockableStringExpression()

Allows to modify the passed string expression to a blockable.

public blockableStringExpression(string $expression, AbstractBlockable $blockable) : string
Parameters
$expression : string
$blockable : AbstractBlockable
Return values
string

fn()

Function implementation.

public fn(SelectorSyntaxAttributeFunction $fn, AbstractMatch $match, mixed $value) : mixed
Parameters
$fn : SelectorSyntaxAttributeFunction
$match : AbstractMatch
$value : mixed

getHeadlessContentBlocker()

Getter.

public final getHeadlessContentBlocker() : mixed

init()

Initialize your plugin add e.g. new visual parent definitions.

public init() : mixed

keepAlwaysAttributes()

Keep attributes for a specific match.

public keepAlwaysAttributes(array<string|int, string> $keepAttributes, AbstractMatcher $matcher, AbstractMatch $match) : array<string|int, string>
Parameters
$keepAttributes : array<string|int, string>
$matcher : AbstractMatcher
$match : AbstractMatch
Return values
array<string|int, string>

modifyHtmlAfterProcessing()

Allows to modify the HTML after the content blocker has done its job.

public modifyHtmlAfterProcessing(string $html) : mixed
Parameters
$html : string

setup()

Before the content blocker gets setup.

public setup() : mixed

skipInlineScriptVariableAssignment()

Skip inline script by variable name.

public skipInlineScriptVariableAssignment(array<string|int, string> $names, ScriptInlineMatcher $matcher, ScriptInlineMatch $match) : array<string|int, string>
Parameters
$names : array<string|int, string>
$matcher : ScriptInlineMatcher
$match : ScriptInlineMatch
Return values
array<string|int, string>

visualParent()

Set a visual parent for a specific match.

public visualParent(bool|string|number $visualParent, AbstractMatcher $matcher, AbstractMatch $match) : bool|string|number
Parameters
$visualParent : bool|string|number
$matcher : AbstractMatcher
$match : AbstractMatch
Return values
bool|string|number 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results