1. class
  2. Drupal
  3. \
  4. jsonapi
  5. \
  6. Normalizer
  7. \
  8. Value
  9. \
  10. TemporaryArrayObjectThrowingExceptions

TemporaryArrayObjectThrowingExceptions

class TemporaryArrayObjectThrowingExceptions extends ArrayObject (View source)

internal  This class implements all methods for class \ArrayObject and throws an \Exception when one of those methods is called.
 

An \ArrayObject that throws an exception when used as an ArrayObject.

Methods

void
append(mixed $value)

Append a value to the ArrayObject.

bool
asort(int $flags = SORT_REGULAR)

Sort the ArrayObject.

int
count()

Count the ArrayObject.

array
exchangeArray(array|object $array)

Exchange the current array with another array or object.

array
getArrayCopy()

Exports the \ArrayObject to an array.

int
getFlags()

Gets the behavior flags of the \ArrayObject.

Iterator
getIterator()

Create a new iterator from an ArrayObject instance.

string
getIteratorClass()

Gets the class name of the array iterator that is used by \ArrayObject::getIterator().

bool
ksort(int $flags = SORT_REGULAR)

Sort the entries by key.

bool
natcasesort()

Sort an array using a case insensitive "natural order" algorithm.

bool
natsort()

Sort entries using a "natural order" algorithm.

bool
offsetExists(mixed $key)

Returns whether the requested index exists.

mixed
offsetGet(mixed $key)

Returns the value at the specified index.

void
offsetSet(mixed $key, mixed $value)

Sets the value at the specified index to new value.

void
offsetUnset(mixed $key)

Unsets the value at the specified index.

void
setFlags(int $flags)

Sets the behavior flags for the \ArrayObject.

void
setIteratorClass(string $iteratorClass)

Sets the iterator classname for the \ArrayObject.

bool
uasort(callable $callback)

Sort the entries with a user-defined comparison function.

bool
uksort(callable $callback)

Sort the entries by keys using a user-defined comparison function.

Details

at line 23
void append(mixed $value)

Append a value to the ArrayObject.

Parameters

mixed $value

The value to append to the ArrayObject.

Return Value

void

Exceptions

Exception

at line 40
bool asort(int $flags = SORT_REGULAR)

Sort the ArrayObject.

Parameters

int $flags

The flags to sort the ArrayObject by.

Return Value

bool

This method always returns TRUE.

Exceptions

Exception

at line 54
int count()

Count the ArrayObject.

Return Value

int

The number of public properties in the \ArrayObject.

Exceptions

Exception

at line 71
array exchangeArray(array|object $array)

Exchange the current array with another array or object.

Parameters

array|object $array

The array to replace for the current array.

Return Value

array

The new array or object to exchange with the current array.

Exceptions

Exception

at line 85
array getArrayCopy()

Exports the \ArrayObject to an array.

Return Value

array

Returns a copy of the array.

Exceptions

Exception

at line 99
int getFlags()

Gets the behavior flags of the \ArrayObject.

Return Value

int

Returns the behavior flags of the \ArrayObject.

Exceptions

Exception

at line 113
Iterator getIterator()

Create a new iterator from an ArrayObject instance.

Return Value

Iterator

An iterator from the ArrayObject.

Exceptions

Exception

at line 127
string getIteratorClass()

Gets the class name of the array iterator that is used by \ArrayObject::getIterator().

Return Value

string

Returns the iterator class name that is used to iterate over this object.

Exceptions

Exception

at line 144
bool ksort(int $flags = SORT_REGULAR)

Sort the entries by key.

Parameters

int $flags

The flags to sort the ArrayObject by.

Return Value

bool

This method always returns TRUE.

Exceptions

Exception

at line 158
bool natcasesort()

Sort an array using a case insensitive "natural order" algorithm.

Return Value

bool

This method always returns TRUE.

Exceptions

Exception

at line 172
bool natsort()

Sort entries using a "natural order" algorithm.

Return Value

bool

This method always returns TRUE.

Exceptions

Exception

at line 189
bool offsetExists(mixed $key)

Returns whether the requested index exists.

Parameters

mixed $key

The index being checked.

Return Value

bool

Return TRUE if the requested index exists, otherwise FALSE.

Exceptions

Exception

at line 206
mixed offsetGet(mixed $key)

Returns the value at the specified index.

Parameters

mixed $key

The index with the value.

Return Value

mixed

The value at the specified index or null.

Exceptions

Exception

at line 223
void offsetSet(mixed $key, mixed $value)

Sets the value at the specified index to new value.

Parameters

mixed $key

The index being set.
mixed $value

The new value for the key.

Return Value

void

Exceptions

Exception

at line 237
void offsetUnset(mixed $key)

Unsets the value at the specified index.

Parameters

mixed $key

The index being unset.

Return Value

void

Exceptions

Exception

at line 251
void setFlags(int $flags)

Sets the behavior flags for the \ArrayObject.

Parameters

int $flags

Set the flags that change the behavior of the \ArrayObject.

Return Value

void

Exceptions

Exception

at line 266
void setIteratorClass(string $iteratorClass)

Sets the iterator classname for the \ArrayObject.

Parameters

string $iteratorClass

The classname of the array iterator to use when iterating over this object.

Return Value

void

Exceptions

Exception

at line 285
bool uasort(callable $callback)

Sort the entries with a user-defined comparison function.

Parameters

callable $callback

The comparison function must return an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second.

Return Value

bool

This method always returns TRUE.

Exceptions

Exception

at line 304
bool uksort(callable $callback)

Sort the entries by keys using a user-defined comparison function.

Parameters

callable $callback

The comparison function must return an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second.

Return Value

bool

This method always returns TRUE.

Exceptions

Exception