FileAccess Orion

NodeProviderCollection extends AbstractCollection
in package
implements CollectionInterface

A collection of NodeProviderInterface objects

Interfaces, Classes, Traits and Enums

CollectionInterface
A collection represents a group of objects, known as its elements.

Table of Contents

$data  : array<string|int, mixed>
The items of this array.
__construct()  : mixed
Constructs a new array object.
add()  : bool
Ensures that this collection contains the specified element.
clear()  : void
Removes all items from this array.
column()  : array<string|int, mixed>
Returns the values from given property or method.
contains()  : bool
Returns `true` if this collection contains the specified element.
count()  : int
Returns the number of items in this array.
diff()  : CollectionInterface<mixed, mixed>
Create a new collection with divergent items between current and given collection.
filter()  : CollectionInterface<mixed, mixed>
Returns a filtered collection.
first()  : mixed
Returns the first item of the collection.
getIterator()  : ArrayIterator<mixed, mixed>
Returns an iterator for this array.
getType()  : string
Returns the type associated with this collection.
intersect()  : CollectionInterface<mixed, mixed>
Create a new collection with intersecting item between current and given collection.
isEmpty()  : bool
Returns `true` if this array is empty.
last()  : mixed
Returns the last item of the collection.
map()  : CollectionInterface<mixed, mixed>
Applies a callback to each item of the collection.
merge()  : CollectionInterface<mixed, mixed>
Merge current items and items of given collections into a new one.
offsetExists()  : bool
Returns `true` if the given offset exists in this array.
offsetGet()  : mixed|null
Returns the value at the specified offset.
offsetSet()  : void
Sets the given value to the given offset in the array.
offsetUnset()  : void
Removes the given offset and its value from the array.
remove()  : bool
Removes a single instance of the specified element from this collection, if it is present.
serialize()  : string
Returns a serialized string representation of this array object.
sort()  : CollectionInterface<mixed, mixed>
Returns a sorted collection.
toArray()  : array<string|int, mixed>
Returns a native PHP array representation of this array object.
unserialize()  : void
Re-constructs the object from its serialized form
where()  : CollectionInterface<mixed, mixed>
Returns a collection of matching items.
checkType()  : bool
Returns `true` if value is of the specified type.
extractValue()  : mixed
Extracts the value of the given property or method from the object.
toolValueToString()  : string
Returns a string representation of the value.

Properties

$data

The items of this array.

protected array<string|int, mixed> $data = []

Methods

__construct()

Constructs a new array object.

public __construct([array<string|int, mixed> $data = [] ]) : mixed
Parameters
$data : array<string|int, mixed> = []

The initial items to add to this array.

Return values
mixed —

add()

Ensures that this collection contains the specified element.

public add(mixed $element) : bool
Parameters
$element : mixed

The element to add to the collection.

Tags
throws
InvalidArgumentException

when the element does not match the specified type for this collection.

Return values
bool —

true if this collection changed as a result of the call.

clear()

Removes all items from this array.

public clear() : void
Return values
void —

column()

Returns the values from given property or method.

public column(string $propertyOrMethod) : array<string|int, mixed>
Parameters
$propertyOrMethod : string

The property or method name to filter by.

Tags
throws
ValueExtractionException

if property or method is not defined.

Return values
array<string|int, mixed> —

contains()

Returns `true` if this collection contains the specified element.

public contains(mixed $element[, bool $strict = true ]) : bool
Parameters
$element : mixed

The element to check whether the collection contains.

$strict : bool = true

Whether to perform a strict type check on the value.

Return values
bool —

getType()

Returns the type associated with this collection.

public getType() : string
Return values
string —

isEmpty()

Returns `true` if this array is empty.

public isEmpty() : bool
Return values
bool —

offsetExists()

Returns `true` if the given offset exists in this array.

public offsetExists(mixed $offset) : bool
Parameters
$offset : mixed

The offset to check.

Tags
link

ArrayAccess::offsetExists()
Return values
bool —

offsetGet()

Returns the value at the specified offset.

public offsetGet(mixed $offset) : mixed|null
Parameters
$offset : mixed

The offset for which a value should be returned.

Tags
link

ArrayAccess::offsetGet()
Return values
mixed|null —

the value stored at the offset, or null if the offset does not exist.

offsetSet()

Sets the given value to the given offset in the array.

public offsetSet(mixed|null $offset, mixed $value) : void
Parameters
$offset : mixed|null

The offset to set. If null, the value may be set at a numerically-indexed offset.

$value : mixed

The value to set at the given offset.

Tags
link

ArrayAccess::offsetSet()
Return values
void —

offsetUnset()

Removes the given offset and its value from the array.

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed

The offset to remove from the array.

Tags
link

ArrayAccess::offsetUnset()
Return values
void —

remove()

Removes a single instance of the specified element from this collection, if it is present.

public remove(mixed $element) : bool
Parameters
$element : mixed

The element to remove from the collection.

Return values
bool —

true if an element was removed as a result of this call.

sort()

Returns a sorted collection.

public sort(string $propertyOrMethod[, string $order = self::SORT_ASC ]) : CollectionInterface<mixed, mixed>
Parameters
$propertyOrMethod : string

The property or method to sort by.

$order : string = self::SORT_ASC

The sort order for the resulting collection (one of this interface's SORT_* constants).

Tags
throws
InvalidSortOrderException

if neither "asc" nor "desc" was given as the order.

throws
ValueExtractionException

if property or method is not defined.

Return values
CollectionInterface<mixed, mixed> —

toArray()

Returns a native PHP array representation of this array object.

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —

unserialize()

Re-constructs the object from its serialized form

public unserialize(string $serialized) : void
Parameters
$serialized : string

The serialized PHP string to unserialize into a UuidInterface instance

Tags
phpcsSuppress

SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint

Return values
void —

checkType()

Returns `true` if value is of the specified type.

protected checkType(string $type, mixed $value) : bool
Parameters
$type : string

The type to check the value against.

$value : mixed

The value to check.

Return values
bool —

extractValue()

Extracts the value of the given property or method from the object.

protected extractValue(object $object, string $propertyOrMethod) : mixed
Parameters
$object : object

The object to extract the value from.

$propertyOrMethod : string

The property or method for which the value should be extracted.

Tags
throws
ValueExtractionException

if the method or property is not defined.

Return values
mixed —

the value extracted from the specified property or method.

toolValueToString()

Returns a string representation of the value.

protected toolValueToString(mixed $value) : string
  • null value: 'NULL'
  • boolean: 'TRUE', 'FALSE'
  • array: 'Array'
  • scalar: converted-value
  • resource: '(type resource #number)'
  • object with __toString(): result of __toString()
  • object DateTime: ISO 8601 date
  • object: '(className Object)'
  • anonymous function: same as object
Parameters
$value : mixed

the value to return as a string.

Return values
string —

Search results