SiteDefinitionCollection
class SiteDefinitionCollection extends NormalizedCollection
Properties
| protected array | $items | from Collection | |
| protected | $onDuplicateAction | {@inheritdoc} |
Methods
Query and set the action to take when add() is called with a key that already exists
Return the exception that is thrown when creating an item using a key that already exists
Return the exception that is thrown when accessing an item that does not exist
Validate and normalize a site ID
Normalize a value for storage
Add an item to this collection
Test whether a given value is present in this collection
Set and overwrite a value in this collection
Normalize a regexp / indexed array of regexps
Normalize the "scrape" value
Details
in
Collection at line 25
clear()
Empty this collection
in
NormalizedCollection at line 24
array|Dictionary|null
asConfig()
No description
in
Collection at line 45
int
count()
No description
in
Collection at line 57
mixed
current()
No description
in
Collection at line 66
int|string
key()
No description
in
Collection at line 75
mixed
next()
No description
in
Collection at line 84
void
rewind()
No description
in
Collection at line 92
bool
valid()
No description
in
NormalizedCollection at line 38
string
onDuplicate(string|null $action = null)
Query and set the action to take when add() is called with a key that already exists
at line 24
protected RuntimeException
getAlreadyExistsException(string $key)
Return the exception that is thrown when creating an item using a key that already exists
at line 32
protected RuntimeException
getNotExistException(string $key)
Return the exception that is thrown when accessing an item that does not exist
at line 43
string
normalizeKey(string $siteId)
Validate and normalize a site ID
at line 57
mixed
normalizeValue($siteConfig)
Normalize a value for storage
This method can be overridden to implement value normalization
in
NormalizedCollection at line 118
mixed
add(string $key, mixed $value = null)
Add an item to this collection
NOTE: relies on exists() to check the key for invalid values and on set() to normalize it
in
NormalizedCollection at line 144
bool
contains(mixed $value)
Test whether a given value is present in this collection
in
NormalizedCollection at line 155
void
delete(string $key)
Delete an item from this collection
in
NormalizedCollection at line 175
bool
exists(string $key)
Test whether an item of given key exists
in
NormalizedCollection at line 195
mixed
get(string $key)
Return a value from this collection
in
NormalizedCollection at line 215
mixed
indexOf(mixed $value)
Find the index of a given value
Will return the first key associated with the given value, or FALSE if the value is not found
in
NormalizedCollection at line 227
mixed
set(string $key, mixed $value)
Set and overwrite a value in this collection
in
NormalizedCollection at line 244
bool
offsetExists(string|int $offset)
No description
in
NormalizedCollection at line 253
mixed
offsetGet(string|int $offset)
No description
in
NormalizedCollection at line 264
void
offsetSet(string|int $offset, mixed $value)
No description
in
NormalizedCollection at line 273
void
offsetUnset(string|int $offset)
No description
at line 91
protected array
normalizeRegexp(array|string $value)
Normalize a regexp / indexed array of regexps
at line 102
protected array
normalizeScrape(array $value)
Normalize the "scrape" value