Index Documentation

XArray

in package

• Index

Provides various helper methods for collections.

Table of Contents

Constants

UNIQUE_NUMBER  = SORT_NUMERIC

Compare items items as numbers.

UNIQUE_STRING  = SORT_STRING

Compare items as strings.

UNIQUE_VALUE  = SORT_REGULAR

Compare items normally without type casting for uniqueness.

Methods

all()  : bool

Checks if all values in the collection match a given predicate.

any()  : bool

Checks if any value in the collection matches a given predicate.

contains()  : bool

Checks if an item occurs in a collection

containsKey()  : bool

Checks if a key occurs in a collection.

count()  : int

Retrieves the amount of items in a collection.

empty()  : bool

Checks if a collection has no items.

extractIterator()  : Iterator

Tries to extract an instance of Iterator from any iterable type.

first()  : mixed

Gets the first item in a collection that matches a given predicate.

firstKey()  : mixed

Retrieves the first key in a collection.

indexOf()  : mixed

Gets the index of a value in a collection.

last()  : mixed

Gets the last item in a collection that matches a given predicate.

lastKey()  : mixed

Retrieves the last key in a collection.

merge()  : array<string|int, mixed>

Merges two collections.

reflow()  : array<string|int, mixed>

Takes values from a collection and discards the keys.

reverse()  : array<string|int, mixed>

Puts a collection in reverse order.

select()  : array<string|int, T2>

Applies a modifier on a collection.

sequenceEquals()  : bool

Checks if two collections are equal in both keys and values.

slice()  : array<string|int, mixed>

Takes a subsection of a collection.

sort()  : array<string|int, T>

Sorts a collection according to a comparer.

toArray()  : array<string|int, mixed>

Converts any iterable to a PHP array.

unique()  : array<string|int, mixed>

Extracts unique values from a collection.

where()  : array<string|int, mixed>

Gets a subset of a collection based on a given predicate.