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

CacheableOmission

final class CacheableOmission extends CacheableNormalization (View source)

internal  JSON:API maintains no PHP API since its API is the HTTP API. This class may change at any time and this will break any dependencies on it.
 

Represents the cacheability associated with the omission of a value.

Traits

CacheableDependencyTrait

Trait for \Drupal\Core\Cache\CacheableDependencyInterface.

Properties

protected string[] $cacheContexts

Cache contexts.

 from  CacheableDependencyTrait
protected string[] $cacheTags

Cache tags.

 from  CacheableDependencyTrait
protected int $cacheMaxAge

Cache max-age.

 from  CacheableDependencyTrait
protected mixed $normalization

A normalized value.

 from  CacheableNormalization

Methods

void
append(mixed $value)

Append a value to the ArrayObject.

from  TemporaryArrayObjectThrowingExceptions
bool
asort(int $flags = SORT_REGULAR)

Sort the ArrayObject.

from  TemporaryArrayObjectThrowingExceptions
int
count()

Count the ArrayObject.

from  TemporaryArrayObjectThrowingExceptions
array
exchangeArray(array|object $array)

Exchange the current array with another array or object.

from  TemporaryArrayObjectThrowingExceptions
array
getArrayCopy()

Exports the \ArrayObject to an array.

from  TemporaryArrayObjectThrowingExceptions
int
getFlags()

Gets the behavior flags of the \ArrayObject.

from  TemporaryArrayObjectThrowingExceptions
Iterator
getIterator()

Create a new iterator from an ArrayObject instance.

from  TemporaryArrayObjectThrowingExceptions
string
getIteratorClass()

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

from  TemporaryArrayObjectThrowingExceptions
bool
ksort(int $flags = SORT_REGULAR)

Sort the entries by key.

from  TemporaryArrayObjectThrowingExceptions
bool
natcasesort()

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

from  TemporaryArrayObjectThrowingExceptions
bool
natsort()

Sort entries using a "natural order" algorithm.

from  TemporaryArrayObjectThrowingExceptions
bool
offsetExists(mixed $key)

Returns whether the requested index exists.

from  TemporaryArrayObjectThrowingExceptions
mixed
offsetGet(mixed $key)

Returns the value at the specified index.

from  TemporaryArrayObjectThrowingExceptions
void
offsetSet(mixed $key, mixed $value)

Sets the value at the specified index to new value.

from  TemporaryArrayObjectThrowingExceptions
void
offsetUnset(mixed $key)

Unsets the value at the specified index.

from  TemporaryArrayObjectThrowingExceptions
void
setFlags(int $flags)

Sets the behavior flags for the \ArrayObject.

from  TemporaryArrayObjectThrowingExceptions
void
setIteratorClass(string $iteratorClass)

Sets the iterator classname for the \ArrayObject.

from  TemporaryArrayObjectThrowingExceptions
bool
uasort(callable $callback)

Sort the entries with a user-defined comparison function.

from  TemporaryArrayObjectThrowingExceptions
bool
uksort(callable $callback)

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

from  TemporaryArrayObjectThrowingExceptions
$this
setCacheability(CacheableDependencyInterface $cacheability)

Sets cacheability; useful for value object constructors.

from  CacheableDependencyTrait
getCacheTags()

{@inheritdoc}

from  CacheableDependencyTrait
getCacheContexts()

{@inheritdoc}

from  CacheableDependencyTrait
getCacheMaxAge()

{@inheritdoc}

from  CacheableDependencyTrait
__construct(CacheableDependencyInterface $cacheability)

CacheableOmission constructor.

static CacheableNormalization
permanent($no_op = NULL)

Creates a CacheableNormalization instance without any special cacheability.

array|string|int|float|bool|null
getNormalization()

A CacheableOmission should never have its normalization retrieved.

CacheableNormalization|CacheableOmission
omitIfEmpty()

Converts the object to a CacheableOmission if the normalization is empty.

from  CacheableNormalization
CacheableNormalization
withCacheableDependency(CacheableDependencyInterface $dependency)

Gets a new CacheableNormalization with an additional dependency.

from  CacheableNormalization
static CacheableNormalization
aggregate(array $cacheable_normalizations)

Collects an array of CacheableNormalizations into a single instance.

from  CacheableNormalization
static bool
hasNoNestedInstances(array|Traversable $array)

Ensures that no nested values are instances of this class.

from  CacheableNormalization

Details

in TemporaryArrayObjectThrowingExceptions 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

in TemporaryArrayObjectThrowingExceptions 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

in TemporaryArrayObjectThrowingExceptions at line 54
int count()

Count the ArrayObject.

Return Value

int

The number of public properties in the \ArrayObject.

Exceptions

Exception

in TemporaryArrayObjectThrowingExceptions 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

in TemporaryArrayObjectThrowingExceptions at line 85
array getArrayCopy()

Exports the \ArrayObject to an array.

Return Value

array

Returns a copy of the array.

Exceptions

Exception

in TemporaryArrayObjectThrowingExceptions at line 99
int getFlags()

Gets the behavior flags of the \ArrayObject.

Return Value

int

Returns the behavior flags of the \ArrayObject.

Exceptions

Exception

in TemporaryArrayObjectThrowingExceptions at line 113
Iterator getIterator()

Create a new iterator from an ArrayObject instance.

Return Value

Iterator

An iterator from the ArrayObject.

Exceptions

Exception

in TemporaryArrayObjectThrowingExceptions 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

in TemporaryArrayObjectThrowingExceptions 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

in TemporaryArrayObjectThrowingExceptions 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

in TemporaryArrayObjectThrowingExceptions at line 172
bool natsort()

Sort entries using a "natural order" algorithm.

Return Value

bool

This method always returns TRUE.

Exceptions

Exception

in TemporaryArrayObjectThrowingExceptions 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

in TemporaryArrayObjectThrowingExceptions 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

in TemporaryArrayObjectThrowingExceptions 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

in TemporaryArrayObjectThrowingExceptions 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

in TemporaryArrayObjectThrowingExceptions 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

in TemporaryArrayObjectThrowingExceptions 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

in TemporaryArrayObjectThrowingExceptions 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

in TemporaryArrayObjectThrowingExceptions 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

in CacheableDependencyTrait at line 39
protected $this setCacheability(CacheableDependencyInterface $cacheability)

Sets cacheability; useful for value object constructors.

Parameters

CacheableDependencyInterface $cacheability

The cacheability to set.

Return Value

$this

in CacheableDependencyTrait at line 49
getCacheTags()

{@inheritdoc}

in CacheableDependencyTrait at line 56
getCacheContexts()

{@inheritdoc}

in CacheableDependencyTrait at line 63
getCacheMaxAge()

{@inheritdoc}

at line 28
__construct(CacheableDependencyInterface $cacheability)

CacheableOmission constructor.

Parameters

CacheableDependencyInterface $cacheability

The cacheability metadata for the normalized data.

at line 35
static CacheableNormalization permanent($no_op = NULL)

Creates a CacheableNormalization instance without any special cacheability.

Parameters

$no_op

Return Value

CacheableNormalization

The CacheableNormalization.

at line 42
array|string|int|float|bool|null getNormalization()

A CacheableOmission should never have its normalization retrieved.

Return Value

array|string|int|float|bool|null

The normalization.

in CacheableNormalization at line 76
CacheableNormalization|CacheableOmission omitIfEmpty()

Converts the object to a CacheableOmission if the normalization is empty.

Return Value

CacheableNormalization|CacheableOmission

A CacheableOmission if the normalization is considered empty, self otherwise.

in CacheableNormalization at line 90
CacheableNormalization withCacheableDependency(CacheableDependencyInterface $dependency)

Gets a new CacheableNormalization with an additional dependency.

Parameters

CacheableDependencyInterface $dependency

The new cacheable dependency.

Return Value

CacheableNormalization

A new object based on the current value with an additional cacheable dependency.

in CacheableNormalization at line 106
static CacheableNormalization aggregate(array $cacheable_normalizations)

Collects an array of CacheableNormalizations into a single instance.

Parameters

array $cacheable_normalizations

An array of CacheableNormalizations.

Return Value

CacheableNormalization

A new CacheableNormalization. Each input value's cacheability will be merged into the return value's cacheability. The return value's normalization will be an array of the input's normalizations. This method does not behave like array_merge() or NestedArray::mergeDeep().

in CacheableNormalization at line 131
static protected bool hasNoNestedInstances(array|Traversable $array)

Ensures that no nested values are instances of this class.

Parameters

array|Traversable $array

The traversable object which may contain instance of this object.

Return Value

bool

Whether the given object or its children have CacheableNormalizations in them.