class TemplateChecker implements ArrayAccess, Iterator

Traits

Allows an object to act as a proxy for a NormalizedCollection stored in $this->collection

Properties

protected TemplateCheckList $collection
protected bool $disabled

Methods

mixed
__call(string $methodName, array $args)

Forward all unknown method calls to $this->collection

bool
offsetExists(string|int $offset)

No description

mixed
offsetGet(string|int $offset)

No description

void
offsetSet(mixed $offset, mixed $value) Custom offsetSet()

implementation to allow assignment with a null offset to append to the

void
offsetUnset(string|int $offset)

No description

int
count()

No description

mixed
current()

No description

int|string
key()

No description

mixed
next()

No description

void
rewind()

No description

bool
valid()

No description

mixed
add(mixed $value, null $void) Add (append)

a value to this list

array
asConfig()

No description

bool
contains(mixed $value)

Test whether a given value is present in this collection

void
delete(string $key)

Delete a value from this list and remove gaps in keys

bool
exists(string $key)

Test whether an item of given key exists

mixed
get(string $key)

Return a value from this collection

mixed
indexOf(mixed $value)

Find the index of a given value

int
normalizeKey(mixed $key)

Ensure that the key is a valid offset

normalizeValue(mixed $check)

Normalize the value to an instance of TemplateCheck

string
onDuplicate(string|null $action) Query and set the action to take when add()

is called with a key that already exists

mixed
set(string $key, mixed $value)

Set and overwrite a value in this collection

__construct()

Constructor

void
checkTag(Tag $tag)

Check a given tag's templates for disallowed content

void
checkTemplate(string $template, Tag|null $tag = null)

Check a given template for disallowed content

void
disable() deprecated

Disable all checks

void
enable() deprecated

Enable all checks

mixed
append(mixed $value)

Append a value to this list

void
clear()

Empty this collection

mixed
insert(int $offset, mixed $value)

Insert a value at an arbitrary 0-based position

mixed
prepend(mixed $value)

Prepend a value to this list

int
remove(mixed $value)

Remove all items matching given value

Details

in CollectionProxy at line 36
mixed __call(string $methodName, array $args)

Forward all unknown method calls to $this->collection

Parameters

string $methodName
array $args

Return Value

mixed

at line 49
bool offsetExists(string|int $offset)

No description

Parameters

string|int $offset

Return Value

bool

at line 49
mixed offsetGet(string|int $offset)

No description

Parameters

string|int $offset

Return Value

mixed

at line 49
void offsetSet(mixed $offset, mixed $value) Custom offsetSet()

implementation to allow assignment with a null offset to append to the

Parameters

mixed $offset
mixed $value) Custom offsetSet(

Return Value

void

at line 49
void offsetUnset(string|int $offset)

No description

Parameters

string|int $offset

Return Value

void

at line 49
int count()

No description

Return Value

int

at line 49
mixed current()

No description

Return Value

mixed

at line 49
int|string key()

No description

Return Value

int|string

at line 49
mixed next()

No description

Return Value

mixed

at line 49
void rewind()

No description

Return Value

void

at line 49
bool valid()

No description

Return Value

bool

at line 49
mixed add(mixed $value, null $void) Add (append)

a value to this list

Parameters

mixed $value
null $void) Add (append

Return Value

mixed

at line 49
array asConfig()

No description

Return Value

array

at line 49
bool contains(mixed $value)

Test whether a given value is present in this collection

Parameters

mixed $value

Return Value

bool

at line 49
void delete(string $key)

Delete a value from this list and remove gaps in keys

Parameters

string $key

Return Value

void

at line 49
bool exists(string $key)

Test whether an item of given key exists

Parameters

string $key

Return Value

bool

at line 49
mixed get(string $key)

Return a value from this collection

Parameters

string $key

Return Value

mixed

at line 49
mixed indexOf(mixed $value)

Find the index of a given value

Parameters

mixed $value

Return Value

mixed

at line 49
int normalizeKey(mixed $key)

Ensure that the key is a valid offset

Parameters

mixed $key

Return Value

int

at line 49
TemplateCheck normalizeValue(mixed $check)

Normalize the value to an instance of TemplateCheck

Parameters

mixed $check

Return Value

TemplateCheck

at line 49
string onDuplicate(string|null $action) Query and set the action to take when add()

is called with a key that already exists

Parameters

string|null $action) Query and set the action to take when add(

Return Value

string

at line 49
mixed set(string $key, mixed $value)

Set and overwrite a value in this collection

Parameters

string $key
mixed $value

Return Value

mixed

at line 68
__construct()

Constructor

Will load the default checks

at line 96
void checkTag(Tag $tag)

Check a given tag's templates for disallowed content

Parameters

Tag $tag

Tag whose templates will be checked

Return Value

void

at line 112
void checkTemplate(string $template, Tag|null $tag = null)

Check a given template for disallowed content

Parameters

string $template Template
Tag|null $tag

Tag this template belongs to

Return Value

void

at line 140
void disable() deprecated

deprecated 2.2.0 Use UnsafeTemplate instead

Disable all checks

Return Value

void

at line 152
void enable() deprecated

deprecated 2.2.0

Enable all checks

Return Value

void

at line 49
mixed append(mixed $value)

Append a value to this list

Parameters

mixed $value

Return Value

mixed

at line 49
void clear()

Empty this collection

Return Value

void

at line 49
mixed insert(int $offset, mixed $value)

Insert a value at an arbitrary 0-based position

Parameters

int $offset
mixed $value

Return Value

mixed

at line 49
mixed prepend(mixed $value)

Prepend a value to this list

Parameters

mixed $value

Return Value

mixed

at line 49
int remove(mixed $value)

Remove all items matching given value

Parameters

mixed $value

Return Value

int