Method |
Description |
|
append ( array | Traversable $values ) : pinq\ITraversable |
Returns values from the original and supplied values, keys will be reindexed. |
|
asArray ( ) : array |
Returns the values as an array. |
|
asCollection ( ) : pinq\ICollection |
Returns the values as a collection. |
|
asTraversable ( ) : pinq\ITraversable |
Returns the values as a traversable. |
|
contains ( mixed $value ) : boolean |
Returns whether the supplied value is contained within the aggregate |
|
difference ( array | Traversable $values ) : pinq\ITraversable |
Returns unique values from the original not present in the supplied values. |
|
except ( array | Traversable $values ) : pinq\ITraversable |
Returns values all values from the original not present in the supplied values. |
|
first ( ) : mixed |
Returns the first value, null if empty |
|
getIterator ( ) : Traversable |
Returns an array compatible iterator for the elements. |
|
getIteratorScheme ( ) : Pinq\Iterators\IIteratorScheme |
Returns the underlying iterator scheme used by the implementation. |
|
getSource ( ) : pinq\ITraversable |
Returns the source traversable or itself if the current traversable
is the source. |
|
getTrueIterator ( ) : Traversable |
Returns an iterator for all the elements. |
|
groupBy ( callable $function ) : pinq\ITraversable |
Groups values according the supplied function. (Uses strict equality '===')
The values will be grouped into instances of the traversable. |
|
groupJoin ( array | Traversable $values ) : Pinq\Interfaces\IJoiningOnTraversable |
Matches the values with the supplied values according to the supplied filter,
groups the the joined values for every original and then maps into as
according to the supplied function. |
|
indexBy ( callable $function ) : pinq\ITraversable |
Index the values according to the supplied mapping function. |
|
intersect ( array | Traversable $values ) : pinq\ITraversable |
Returns unique values the are present in the original and supplied values. |
|
isSource ( ) : boolean |
Returns whether the traversable is the source of the elements. |
|
iterate ( callable $function ) : void |
Iterates the elements with the supplied function. |
|
join ( array | Traversable $values ) : Pinq\Interfaces\IJoiningOnTraversable |
Matches the values with the supplied values according to the supplied filter
then maps the results into as according to the supplied function. |
|
keys ( ) : pinq\ITraversable |
Selects the keys as the values (indexed by their 0-based position). |
|
last ( ) : mixed |
Returns the last value, null if empty |
|
orderBy ( callable $function, integer $direction ) : Pinq\Interfaces\IOrderedTraversable |
Orders the values mapped from the supplied function according the supplied
direction. |
|
orderByAscending ( callable $function ) : Pinq\Interfaces\IOrderedTraversable |
Orders the values mapped from the supplied function ascendingly
Example function: |
|
orderByDescending ( callable $function ) : Pinq\Interfaces\IOrderedTraversable |
Orders the values mapped from the supplied function descendingly
Example expression function: |
|
reindex ( ) : pinq\ITraversable |
Indexes the values by their 0-based position. |
|
select ( callable $function ) : pinq\ITraversable |
Returns the values mapped by the supplied function. |
|
selectMany ( callable $function ) : pinq\ITraversable |
Returns the values mapped by the supplied function and then flattens
the values into a single traversable. Keys will be reindexed. |
|
skip ( integer $amount ) : pinq\ITraversable |
Skip the amount of values from the start. |
|
slice ( integer $start, integer | null $amount ) : pinq\ITraversable |
Retrieve a slice of the values. |
|
take ( integer | null $amount ) : pinq\ITraversable |
Limits the amount of values by the supplied amount |
|
union ( array | Traversable $values ) : pinq\ITraversable |
Returns unique results present in both the original and supplied values,
keys will be reindexed. |
|
unique ( ) : pinq\ITraversable |
Only return unique values. (Uses strict equality '===') |
|
where ( callable $predicate ) : pinq\ITraversable |
Filters the values by a supplied predicate. |
|
whereIn ( array | Traversable $values ) : pinq\ITraversable |
Returns all values from the original present in the supplied values. |
|