\DevOwl\HeadlessContentBlockerBlockedResult

A blocked result defines a "blocked" content while processing the content blocker itself.

Summary

Methods
Properties
Constants
__construct()
disableBlocking()
setBlocked()
addBlocked()
setBlockedExpressions()
addBlockedExpression()
setData()
getData()
isBlocked()
getBlocked()
getFirstBlocked()
getBlockedExpressions()
getTag()
getAttributes()
getMarkup()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$blocked
$blockedExpressions
$tag
$attributes
$markup
$data
N/A

Properties

$blocked

$blocked :

Type

$blockedExpressions

$blockedExpressions :

Type

$tag

$tag :

Type

$attributes

$attributes :

Type

$markup

$markup :

Type

$data

$data :

Type

Methods

__construct()

__construct(string  $tag,array  $attributes,string  $markup)

C'tor.

Parameters

string $tag
array $attributes
string $markup

disableBlocking()

disableBlocking()

Disable blocking.

setBlocked()

setBlocked(array<mixed,\DevOwl\HeadlessContentBlocker\AbstractBlockable>  $blocked)

Mark the content to be blocked.

Parameters

array<mixed,\DevOwl\HeadlessContentBlocker\AbstractBlockable> $blocked

Can also be [] to deactivate blocking

setBlockedExpressions()

setBlockedExpressions(array<mixed,string>  $expressions)

Mark the content to be blocked through given expressions.

Parameters

array<mixed,string> $expressions

Can also be []

addBlockedExpression()

addBlockedExpression(string  $expression)

Mark the content to be blocked through a given expression.

Parameters

string $expression

setData()

setData(string  $key,mixed  $data)

Allows to set additional data for this blocked result.

Parameters

string $key
mixed $data

getData()

getData(string  $key)

Get additional blocking data.

Parameters

string $key

isBlocked()

isBlocked()

Should this content be blocked?

getBlocked()

getBlocked()

Getter.

getFirstBlocked()

getFirstBlocked()

Getter.

getBlockedExpressions()

getBlockedExpressions()

Getter.

getTag()

getTag()

Getter.

getAttributes()

getAttributes()

Getter.

getMarkup()

getMarkup()

Getter.