MatchPluginCallbacks
in package
Provide an object for a given match with match-callbacks which can be used within plugins.
This is similar to callback of HeadlessContentBlocker, but individual to a match.
This class does not contain yet all plugin APIs as from AbstractPlugin, but will be
implemented as needed.
Table of Contents
Properties
- $blockedMatchCallbacks : mixed
- $keepAlwaysAttributes : mixed
- $match : mixed
- $transaction : null|array<string|int, callable>
- See `startTransaction()`.
Methods
- __construct() : mixed
- C'tor.
- addBlockedMatchCallback() : mixed
- Add a callable after a blocked match got found so you can alter the match again. Parameters: `BlockedResult $result, MatchPluginCallbacks $matchPluginCallbacks, AbstractMatcher $matcher`.
- addKeepAlwaysAttributes() : mixed
- In some cases we need to keep the attributes as original instead of prefix it with `consent-original-`.
- commit() : mixed
- Commit a transaction. This means, all changes within the transaction will be applied.
- getFromMatch() : MatchPluginCallbacks
- We are using `AbstractMatch#data` to retrieve and set the plugin callbacks instance, lazily.
- getKeepAlwaysAttributes() : mixed
- Getter.
- getMatch() : mixed
- Getter.
- rollback() : mixed
- Rollback a transaction. This means, all changes within the transaction will be discarded.
- runBlockedMatchCallback() : mixed
- Run registered blocked-match callbacks.
- startTransaction() : mixed
- Start a transaction. This allows to "delay" the addition of new callbacks through e.g. `addBlockedMatchCallback()` until the transaction is rolled back or committed.
Properties
$blockedMatchCallbacks
private
mixed
$blockedMatchCallbacks
= []
$keepAlwaysAttributes
private
mixed
$keepAlwaysAttributes
= []
$match
private
mixed
$match
$transaction
See `startTransaction()`.
private
null|array<string|int, callable>
$transaction
= null
Methods
__construct()
C'tor.
public
__construct(AbstractMatch $match) : mixed
Parameters
- $match : AbstractMatch
addBlockedMatchCallback()
Add a callable after a blocked match got found so you can alter the match again. Parameters: `BlockedResult $result, MatchPluginCallbacks $matchPluginCallbacks, AbstractMatcher $matcher`.
public
addBlockedMatchCallback(callable $callback) : mixed
Parameters
- $callback : callable
addKeepAlwaysAttributes()
In some cases we need to keep the attributes as original instead of prefix it with `consent-original-`.
public
addKeepAlwaysAttributes(array<string|int, string> $attributes) : mixed
Keep in mind, that no external data should be loaded if the attribute is set!
Parameters
- $attributes : array<string|int, string>
commit()
Commit a transaction. This means, all changes within the transaction will be applied.
public
commit() : mixed
getFromMatch()
We are using `AbstractMatch#data` to retrieve and set the plugin callbacks instance, lazily.
public
static getFromMatch(AbstractMatch $match) : MatchPluginCallbacks
Parameters
- $match : AbstractMatch
Return values
MatchPluginCallbacksgetKeepAlwaysAttributes()
Getter.
public
getKeepAlwaysAttributes() : mixed
getMatch()
Getter.
public
getMatch() : mixed
Tags
rollback()
Rollback a transaction. This means, all changes within the transaction will be discarded.
public
rollback() : mixed
runBlockedMatchCallback()
Run registered blocked-match callbacks.
public
runBlockedMatchCallback(BlockedResult $result, AbstractMatcher $matcher) : mixed
Parameters
- $result : BlockedResult
- $matcher : AbstractMatcher
startTransaction()
Start a transaction. This allows to "delay" the addition of new callbacks through e.g. `addBlockedMatchCallback()` until the transaction is rolled back or committed.
public
startTransaction() : mixed