PHP Class Pinq\Collection

Author: Elliot Levin ([email protected])

Inheritance: extends Traversable, implements pinq\ICollection, implements Pinq\Interfaces\IOrderedCollection

Show file Open project: timetoogo/pinq Class Usage Examples

Protected Properties

Property	Type	Description
$source	Collection \| null	The source collection.

Public Methods

Method	Description
__construct ( $values = [], Pinq\Iterators\IIteratorScheme $scheme = null, Collection $source = null )
addRange ( $values )
apply ( callable $function )
asTraversable ( )
clear ( )
from ( $elements, Pinq\Iterators\IIteratorScheme $scheme = null, Traversable $source = null )	{@inheritDoc}
groupJoin ( $values )
join ( $values )
offsetGet ( $key )
offsetSet ( $index, $value )
offsetUnset ( $index )
remove ( $value )
removeRange ( $values )
removeWhere ( callable $predicate )

Protected Methods

Method	Description
toOrderedMap ( ) : Pinq\Iterators\IOrderedMap
updateElements ( Traversable $elements )

Method Details

__construct() public method

public __construct ( $values = [], Pinq\Iterators\IIteratorScheme $scheme = null, Collection $source = null )
$scheme	Pinq\Iterators\IIteratorScheme
$source	Collection

addRange() public method

public addRange ( $values )

apply() public method

public apply ( callable $function )
$function	callable

asTraversable() public method

public asTraversable ( )

clear() public method

public clear ( )

from() public static method

{@inheritDoc}

public static from ( $elements, Pinq\Iterators\IIteratorScheme $scheme = null, Traversable $source = null )
$scheme	Pinq\Iterators\IIteratorScheme
$source	Traversable

groupJoin() public method

public groupJoin ( $values )

join() public method

public join ( $values )

offsetGet() public method

public offsetGet ( $key )

offsetSet() public method

public offsetSet ( $index, $value )

offsetUnset() public method

public offsetUnset ( $index )

remove() public method

public remove ( $value )

removeRange() public method

public removeRange ( $values )

removeWhere() public method

public removeWhere ( callable $predicate )
$predicate	callable

toOrderedMap() protected method

protected toOrderedMap ( ) : Pinq\Iterators\IOrderedMap
return	Pinq\Iterators\IOrderedMap

updateElements() protected method

protected updateElements ( Traversable $elements )
$elements	Traversable

Property Details

$source protected property

The source collection.

protected Collection,pinq\|null $source
return	Collection \| null