PHPLinq_LinqToObjects

category PHPLinq
package PHPLinq
copyright Copyright (c) 2008 - 2009 PHPLinq (http://www.codeplex.com/PHPLinq)

 Methods

Create a new class instance

__construct(string $name, \PHPLinq_ILinqProvider $parentProvider) : \PHPLinq_ILinqProvider

Parameters

$name

string

$parentProvider

\PHPLinq_ILinqProvider

Optional parent PHPLinq_ILinqProvider instance, used with join conditions

Returns

Class destructor

__destruct() 

Is object destructing?

__isDestructing() : bool

Returns

bool

Add child provider, used with joins

addChildProvider(\PHPLinq_ILinqProvider $provider) 

Parameters

Aggregate

aggregate(int $seed, string $expression) : mixed

Example: Equivalent of count(): $this->aggregate(0, '$s, $t => $s + 1');

Parameters

$seed

int

Seed

$expression

string

Expression defining the aggregate

Returns

mixedaggregate

All

all(string $expression) : boolean

Parameters

$expression

string

Expression checking if an all elements are contained

Returns

boolean

Any

any(string $expression) : boolean

Parameters

$expression

string

Expression checking if an element is contained

Returns

boolean

Average of elements

average() : mixed

Returns

mixedAverage of elements

Concatenate data

concat(mixed $source) : \PHPLinq_ILinqProvider

Parameters

$source

mixed

Returns

Contains

contains(mixed $element) : boolean

Parameters

$element

mixed

Is the $element contained?

Returns

boolean

Count elements

count() : int

Returns

intElement count

Distinct

distinct(string $expression) : \PHPLinq_ILinqProvider

Parameters

$expression

string

Expression to retrieve the key value.

Returns

Element at index

elementAt(mixed $index) : mixed

Parameters

$index

mixed

Index

Returns

mixedElement at $index

Element at index or default

elementAtOrDefault(mixed $index, mixed $defaultValue) : mixed

Parameters

$index

mixed

Index

$defaultValue

mixed

Default value to return if nothing is found

Returns

mixedElement at $index

First

first(string $expression) : mixed

Parameters

$expression

string

Expression which creates a resulting element

Returns

mixed

FirstOrDefault

firstOrDefault(string $expression, mixed $defaultValue) : mixed

Parameters

$expression

string

Expression which creates a resulting element

$defaultValue

mixed

Default value to return if nothing is found

Returns

mixed

Retrieve "from" name

getFromName() : string

Returns

string

Get join condition

getJoinCondition() : \PHPLinq_Expression

Retrieve data in data source

getSource() : mixed

Returns

mixed

Can this provider type handle data in $source?

handles(mixed $source) : bool
Static

Parameters

$source

mixed

Returns

bool

Set source of data

in(mixed $source) : \PHPLinq_ILinqProvider

Parameters

$source

mixed

Returns

Join

join(string $name) : \PHPLinq_Initiator

Parameters

$name

string

Returns

Last

last(string $expression) : mixed

Parameters

$expression

string

Expression which creates a resulting element

Returns

mixed

LastOrDefault

lastOrDefault(string $expression, mixed $defaultValue) : mixed

Parameters

$expression

string

Expression which creates a resulting element

$defaultValue

mixed

Default value to return if nothing is found

Returns

mixed

Maximum of elements

max() : mixed

Returns

mixedMaximum of elements

Minimum of elements

min() : mixed

Returns

mixedMinimum of elements

Select the elements of a certain type

ofType(string $type) 

Parameters

$type

string

Type name

On

on(string $expression) : \PHPLinq_ILinqProvider

Parameters

$expression

string

Expression representing join condition

Returns

OrderBy

orderBy(string $expression, string $comparer) : \PHPLinq_ILinqProvider

Parameters

$expression

string

Expression to order elements by

$comparer

string

Comparer function (taking 2 arguments, returning -1, 0, 1)

Returns

OrderByDescending

orderByDescending(string $expression, string $comparer) : \PHPLinq_ILinqProvider

Parameters

$expression

string

Expression to order elements by

$comparer

string

Comparer function (taking 2 arguments, returning -1, 0, 1)

Returns

Reverse elements

reverse(bool $preserveKeys) : \PHPLinq_ILinqProvider

Parameters

$preserveKeys

bool

Preserve keys?

Returns

Select

select(string $expression) : mixed

Parameters

$expression

string

Expression which creates a resulting element

Returns

mixed

Single

single(string $expression) : mixed

Parameters

$expression

string

Expression which creates a resulting element

Returns

mixed

SingleOrDefault

singleOrDefault(string $expression, mixed $defaultValue) : mixed

Parameters

$expression

string

Expression which creates a resulting element

$defaultValue

mixed

Default value to return if nothing is found

Returns

mixed

Skip $n elements

skip(int $n) : \PHPLinq_ILinqProvider

Parameters

$n

int

Returns

Skip elements while $expression evaluates to true

skipWhile(string $expression) : \PHPLinq_ILinqProvider

Parameters

$expression

string

Expression to evaluate

Returns

Sum elements

sum() : mixed

Returns

mixedSum of elements

Take $n elements

take(int $n) : \PHPLinq_ILinqProvider

Parameters

$n

int

Returns

Take elements while $expression evaluates to true

takeWhile(string $expression) : \PHPLinq_ILinqProvider

Parameters

$expression

string

Expression to evaluate

Returns

ThenBy

thenBy(string $expression, string $comparer) : \PHPLinq_ILinqProvider

Parameters

$expression

string

Expression to order elements by

$comparer

string

Comparer function (taking 2 arguments, returning -1, 0, 1)

Returns

ThenByDescending

thenByDescending(string $expression, string $comparer) : \PHPLinq_ILinqProvider

Parameters

$expression

string

Expression to order elements by

$comparer

string

Comparer function (taking 2 arguments, returning -1, 0, 1)

Returns

Where

where(string $expression) : \PHPLinq_ILinqProvider

Parameters

$expression

string

Expression checking if an element should be contained

Returns

 Properties

 

$_childProviders : \PHPLinq_ILinqProvider[]
 

$_data : mixed
 

$_distinct : \PHPLinq_Expression
 

$_from : string
 

$_isDestructing : bool
 

$_joinCondition : \PHPLinq_Expression
 

$_ofType : \PHPLinq_Expression
 

$_orderBy : \PHPLinq_Expression[]
 

$_parentProvider : \PHPLinq_ILinqProvider
 

$_skip : \int?
 

$_skipWhile : \PHPLinq_Expression
 

$_take : \int?
 

$_takeWhile : \PHPLinq_Expression
 

$_where : \PHPLinq_Expression