BlockedResult
in package
A blocked result defines a "blocked" content while processing the content blocker itself.
Table of Contents
Properties
- $attributes : mixed
- $blocked : mixed
- $blockedExpressions : mixed
- $data : mixed
- $markup : mixed
- $tag : mixed
Methods
- __construct() : mixed
- C'tor.
- addBlocked() : mixed
- Add blocked description (to allow multiple blockables cover this blocked content).
- addBlockedExpression() : mixed
- Mark the content to be blocked through a given expression.
- disableBlocking() : mixed
- Disable blocking.
- getAttributes() : mixed
- Getter.
- getBlocked() : mixed
- Getter.
- getBlockedExpressions() : mixed
- Getter.
- getData() : mixed
- Get additional blocking data.
- getFirstBlocked() : mixed
- Getter.
- getMarkup() : mixed
- Getter.
- getTag() : mixed
- Getter.
- isBlocked() : mixed
- Should this content be blocked?
- setBlocked() : mixed
- Mark the content to be blocked.
- setBlockedExpressions() : mixed
- Mark the content to be blocked through given expressions.
- setData() : mixed
- Allows to set additional data for this blocked result.
Properties
$attributes
private
mixed
$attributes
$blocked
private
mixed
$blocked
= []
$blockedExpressions
private
mixed
$blockedExpressions
= []
$data
private
mixed
$data
= []
$markup
private
mixed
$markup
$tag
private
mixed
$tag
Methods
__construct()
C'tor.
public
__construct(string $tag, array<string|int, mixed> $attributes, Markup $markup) : mixed
Parameters
- $tag : string
- $attributes : array<string|int, mixed>
- $markup : Markup
addBlocked()
Add blocked description (to allow multiple blockables cover this blocked content).
public
addBlocked(AbstractBlockable $blocked) : mixed
Parameters
- $blocked : AbstractBlockable
addBlockedExpression()
Mark the content to be blocked through a given expression.
public
addBlockedExpression(string $expression) : mixed
Parameters
- $expression : string
disableBlocking()
Disable blocking.
public
disableBlocking() : mixed
getAttributes()
Getter.
public
getAttributes() : mixed
Tags
getBlocked()
Getter.
public
getBlocked() : mixed
getBlockedExpressions()
Getter.
public
getBlockedExpressions() : mixed
getData()
Get additional blocking data.
public
getData(string $key) : mixed
Parameters
- $key : string
getFirstBlocked()
Getter.
public
getFirstBlocked() : mixed
getMarkup()
Getter.
public
getMarkup() : mixed
getTag()
Getter.
public
getTag() : mixed
isBlocked()
Should this content be blocked?
public
isBlocked() : mixed
setBlocked()
Mark the content to be blocked.
public
setBlocked(array<string|int, AbstractBlockable> $blocked) : mixed
Parameters
- $blocked : array<string|int, AbstractBlockable>
-
Can also be
[]to deactivate blocking
setBlockedExpressions()
Mark the content to be blocked through given expressions.
public
setBlockedExpressions(array<string|int, string> $expressions) : mixed
Parameters
- $expressions : array<string|int, string>
-
Can also be
[]
setData()
Allows to set additional data for this blocked result.
public
setData(string $key, mixed $data) : mixed
Parameters
- $key : string
- $data : mixed