[ Index ]

PHP Cross Reference of phpBB-3.3.2-deutsch

title

Body

[close]

/vendor/s9e/text-formatter/src/Configurator/Collections/ -> NormalizedCollection.php (summary)

(no description)

File Size: 262 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

NormalizedCollection:: (17 methods):
  asConfig()
  onDuplicate()
  getAlreadyExistsException()
  getNotExistException()
  normalizeKey()
  normalizeValue()
  add()
  contains()
  delete()
  exists()
  get()
  indexOf()
  set()
  offsetExists()
  offsetGet()
  offsetSet()
  offsetUnset()


Class: NormalizedCollection  - X-Ref


asConfig()   X-Ref
{@inheritdoc}


onDuplicate($action = null)   X-Ref
Query and set the action to take when add() is called with a key that already exists

param: string|null $action If specified: either "error", "ignore" or "replace"
return: string              Old action

getAlreadyExistsException($key)   X-Ref
Return the exception that is thrown when creating an item using a key that already exists

param: string           $key Item's key
return: RuntimeException

getNotExistException($key)   X-Ref
Return the exception that is thrown when accessing an item that does not exist

param: string           $key Item's key
return: RuntimeException

normalizeKey($key)   X-Ref
Normalize an item's key

This method can be overridden to implement keys normalization or implement constraints

param: string $key Original key
return: string      Normalized key

normalizeValue($value)   X-Ref
Normalize a value for storage

This method can be overridden to implement value normalization

param: mixed $value Original value
return: mixed        Normalized value

add($key, $value = null)   X-Ref
Add an item to this collection

NOTE: relies on exists() to check the key for invalid values and on set() to normalize it

param: string $key   Item's key
param: mixed  $value Item's value
return: mixed         Normalized value

contains($value)   X-Ref
Test whether a given value is present in this collection

param: mixed $value Original value
return: bool         Whether the normalized value was found in this collection

delete($key)   X-Ref
Delete an item from this collection

param: string $key Item's key
return: void

exists($key)   X-Ref
Test whether an item of given key exists

param: string $key Item's key
return: bool        Whether this key exists in this collection

get($key)   X-Ref
Return a value from this collection

param: string $key Item's key
return: mixed       Normalized value

indexOf($value)   X-Ref
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

param: mixed $value Original value
return: mixed        Index of the value, or FALSE if not found

set($key, $value)   X-Ref
Set and overwrite a value in this collection

param: string $key   Item's key
param: mixed  $value Item's value
return: mixed         Normalized value

offsetExists($offset)   X-Ref

param: string|integer $offset
return: bool

offsetGet($offset)   X-Ref

param: string|integer $offset
return: mixed

offsetSet($offset, $value)   X-Ref

param: string|integer $offset
param: mixed          $value
return: void

offsetUnset($offset)   X-Ref

param: string|integer $offset
return: void



Generated: Wed Nov 11 20:28:18 2020 Cross-referenced by PHPXref 0.7.1