class RulesGenerator implements ArrayAccess, Iterator

Traits

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

Properties

protected RulesGeneratorList $collection

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

TargetedRulesGenerator
normalizeValue(TargetedRulesGenerator $generator)

Normalize the value to an object

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

array
getRules(TagCollection $tags)

Generate rules for given tag collection

array
generateTagRules(array $tagInspectors)

Generate and return rules based on a set of TemplateInspector

array
generateRootRules(array $tagInspectors)

Generate a set of rules to be applied at the root of a document

array
generateRuleset(TemplateInspector $srcInspector, array $trgInspectors)

Generate a set of rules for a single TemplateInspector instance

array
getTagInspectors(TagCollection $tags)

Inspect given list of tags

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 48
bool offsetExists(string|int $offset)

No description

Parameters

string|int $offset

Return Value

bool

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

No description

Parameters

string|int $offset

Return Value

mixed

at line 48
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 48
void offsetUnset(string|int $offset)

No description

Parameters

string|int $offset

Return Value

void

at line 48
int count()

No description

Return Value

int

at line 48
mixed current()

No description

Return Value

mixed

at line 48
int|string key()

No description

Return Value

int|string

at line 48
mixed next()

No description

Return Value

mixed

at line 48
void rewind()

No description

Return Value

void

at line 48
bool valid()

No description

Return Value

bool

at line 48
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 48
array asConfig()

No description

Return Value

array

at line 48
bool contains(mixed $value)

Test whether a given value is present in this collection

Parameters

mixed $value

Return Value

bool

at line 48
void delete(string $key)

Delete a value from this list and remove gaps in keys

Parameters

string $key

Return Value

void

at line 48
bool exists(string $key)

Test whether an item of given key exists

Parameters

string $key

Return Value

bool

at line 48
mixed get(string $key)

Return a value from this collection

Parameters

string $key

Return Value

mixed

at line 48
mixed indexOf(mixed $value)

Find the index of a given value

Parameters

mixed $value

Return Value

mixed

at line 48
int normalizeKey(mixed $key)

Ensure that the key is a valid offset

Parameters

mixed $key

Return Value

int

at line 48
TargetedRulesGenerator normalizeValue(TargetedRulesGenerator $generator)

Normalize the value to an object

Parameters

TargetedRulesGenerator $generator

Return Value

TargetedRulesGenerator

at line 48
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 48
mixed set(string $key, mixed $value)

Set and overwrite a value in this collection

Parameters

string $key
mixed $value

Return Value

mixed

at line 62
__construct()

Constructor

Will load the default rule generators

at line 84
array getRules(TagCollection $tags)

Generate rules for given tag collection

Parameters

TagCollection $tags

Tags collection

Return Value

array

at line 100
protected array generateTagRules(array $tagInspectors)

Generate and return rules based on a set of TemplateInspector

Parameters

array $tagInspectors

Array of [tagName => TemplateInspector]

Return Value

array

Array of [tagName => []]

at line 117
protected array generateRootRules(array $tagInspectors)

Generate a set of rules to be applied at the root of a document

Parameters

array $tagInspectors

Array of [tagName => TemplateInspector]

Return Value

array

at line 146
protected array generateRuleset(TemplateInspector $srcInspector, array $trgInspectors)

Generate a set of rules for a single TemplateInspector instance

Parameters

TemplateInspector $srcInspector

Source of the rules

array $trgInspectors

Array of [tagName => TemplateInspector]

Return Value

array

at line 181
protected array getTagInspectors(TagCollection $tags)

Inspect given list of tags

Parameters

TagCollection $tags

Tags collection

Return Value

array

Array of [tagName => TemplateInspector]

at line 48
mixed append(mixed $value)

Append a value to this list

Parameters

mixed $value

Return Value

mixed

at line 48
void clear()

Empty this collection

Return Value

void

at line 48
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 48
mixed prepend(mixed $value)

Prepend a value to this list

Parameters

mixed $value

Return Value

mixed

at line 48
int remove(mixed $value)

Remove all items matching given value

Parameters

mixed $value

Return Value

int