Docs For Class PHPLinq

static bool handles(
mixed
$source)

Can this provider type handle data in $source?

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::handles(): Can this provider type handle data in $source?

Parameters:

mixed

$source

[ Top ]

PHPLinq_ILinqProvider __construct(
string
$name, [PHPLinq_ILinqProvider
$parentProvider = null])

Create a new class instance

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::__construct(): Create a new class instance

Parameters:

string	$name
PHPLinq_ILinqProvider	$parentProvider	Optional parent PHPLinq_ILinqProvider instance, used with join conditions

[ Top ]

void __destruct(
)

Class destructor

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::__destruct(): Class destructor

[ Top ]

void addChildProvider(
PHPLinq_ILinqProvider
$provider)

Add child provider, used with joins

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::addChildProvider(): Add child provider, used with joins

Parameters:

PHPLinq_ILinqProvider

$provider

[ Top ]

mixed aggregate(
[int
$seed = 0], string
$expression)

Aggregate

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

Tags:

return:	aggregate
access:	public

Implementation of:

PHPLinq_ILinqProvider::aggregate(): Aggregate

Parameters:

int	$seed	Seed
string	$expression	Expression defining the aggregate

[ Top ]

boolean all(
string
$expression)

All

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::all(): All

Parameters:

string

$expression

Expression checking if an all elements are contained

[ Top ]

boolean any(
string
$expression)

Any

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::any(): Any

Parameters:

string

$expression

Expression checking if an element is contained

[ Top ]

mixed average(
)

Average of elements

Tags:

return:	Average of elements
access:	public

Implementation of:

PHPLinq_ILinqProvider::average(): Average of elements

[ Top ]

PHPLinq_ILinqProvider concat(
mixed
$source)

Concatenate data

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::concat(): Concatenate data

Parameters:

mixed

$source

[ Top ]

boolean contains(
mixed
$element)

Contains

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::contains(): Contains

Parameters:

mixed

$element

Is the $element contained?

[ Top ]

int count(
)

Count elements

Tags:

return:	Element count
access:	public

Implementation of:

PHPLinq_ILinqProvider::count(): Count elements

[ Top ]

PHPLinq_ILinqProvider distinct(
string
$expression)

Distinct

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::distinct(): Distinct

Parameters:

string

$expression

Expression to retrieve the key value.

[ Top ]

mixed elementAt(
[mixed
$index = null])

Element at index

Tags:

return:	Element at $index
access:	public

Implementation of:

PHPLinq_ILinqProvider::elementAt(): Element at index

Parameters:

mixed

$index

Index

[ Top ]

mixed elementAtOrDefault(
[mixed
$index = null], [mixed
$defaultValue = null])

Element at index or default

Tags:

return:	Element at $index
access:	public

Implementation of:

PHPLinq_ILinqProvider::elementAtOrDefault(): Element at index or default

Parameters:

mixed	$index	Index
mixed	$defaultValue	Default value to return if nothing is found

[ Top ]

mixed first(
[string
$expression = null])

First

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::first(): First

Parameters:

string

$expression

Expression which creates a resulting element

[ Top ]

mixed firstOrDefault(
[string
$expression = null], [mixed
$defaultValue = null])

FirstOrDefault

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::firstOrDefault(): FirstOrDefault

Parameters:

string	$expression	Expression which creates a resulting element
mixed	$defaultValue	Default value to return if nothing is found

[ Top ]

string getFromName(
)

Retrieve "from" name

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::getFromName(): Retrieve "from" name

[ Top ]

PHPLinq_Expression getJoinCondition(
)

Get join condition

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::getJoinCondition(): Get join condition

[ Top ]

mixed getSource(
)

Retrieve data in data source

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::getSource(): Retrieve data in data source

[ Top ]

PHPLinq_ILinqProvider in(
mixed
$source)

Set source of data

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::in(): Set source of data

Parameters:

mixed

$source

[ Top ]

PHPLinq_Initiator join(
string
$name)

Join

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::join(): Join

Parameters:

string

$name

[ Top ]

mixed last(
[string
$expression = null])

Last

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::last(): Last

Parameters:

string

$expression

Expression which creates a resulting element

[ Top ]

mixed lastOrDefault(
[string
$expression = null], [mixed
$defaultValue = null])

LastOrDefault

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::lastOrDefault(): LastOrDefault

Parameters:

string	$expression	Expression which creates a resulting element
mixed	$defaultValue	Default value to return if nothing is found

[ Top ]

mixed max(
)

Maximum of elements

Tags:

return:	Maximum of elements
access:	public

Implementation of:

PHPLinq_ILinqProvider::max(): Maximum of elements

[ Top ]

mixed min(
)

Minimum of elements

Tags:

return:	Minimum of elements
access:	public

Implementation of:

PHPLinq_ILinqProvider::min(): Minimum of elements

[ Top ]

void ofType(
string
$type)

Select the elements of a certain type

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::ofType(): Select the elements of a certain type

Parameters:

string

$type

Type name

[ Top ]

PHPLinq_ILinqProvider on(
string
$expression)

On

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::on(): On

Parameters:

string

$expression

Expression representing join condition

[ Top ]

PHPLinq_ILinqProvider orderBy(
string
$expression, [string
$comparer = null])

OrderBy

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::orderBy(): OrderBy

Parameters:

string	$expression	Expression to order elements by
string	$comparer	Comparer function (taking 2 arguments, returning -1, 0, 1)

[ Top ]

PHPLinq_ILinqProvider orderByDescending(
string
$expression, [string
$comparer = null])

OrderByDescending

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::orderByDescending(): OrderByDescending

Parameters:

string	$expression	Expression to order elements by
string	$comparer	Comparer function (taking 2 arguments, returning -1, 0, 1)

[ Top ]

PHPLinq_ILinqProvider reverse(
[bool
$preserveKeys = null])

Reverse elements

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::reverse(): Reverse elements

Parameters:

bool

$preserveKeys

Preserve keys?

[ Top ]

mixed select(
[string
$expression = null])

Select

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::select(): Select

Parameters:

string

$expression

Expression which creates a resulting element

[ Top ]

mixed single(
[string
$expression = null])

Single

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::single(): Single

Parameters:

string

$expression

Expression which creates a resulting element

[ Top ]

mixed singleOrDefault(
[string
$expression = null], [mixed
$defaultValue = null])

SingleOrDefault

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::singleOrDefault(): SingleOrDefault

Parameters:

string	$expression	Expression which creates a resulting element
mixed	$defaultValue	Default value to return if nothing is found

[ Top ]

PHPLinq_ILinqProvider skip(
int
$n)

Skip $n elements

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::skip(): Skip $n elements

Parameters:

int

$n

[ Top ]

PHPLinq_ILinqProvider skipWhile(
string
$expression)

Skip elements while $expression evaluates to true

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::skipWhile(): Skip elements while $expression evaluates to true

Parameters:

string

$expression

Expression to evaluate

[ Top ]

mixed sum(
)

Sum elements

Tags:

return:	Sum of elements
access:	public

Implementation of:

PHPLinq_ILinqProvider::sum(): Sum elements

[ Top ]

PHPLinq_ILinqProvider take(
int
$n)

Take $n elements

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::take(): Take $n elements

Parameters:

int

$n

[ Top ]

PHPLinq_ILinqProvider takeWhile(
string
$expression)

Take elements while $expression evaluates to true

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::takeWhile(): Take elements while $expression evaluates to true

Parameters:

string

$expression

Expression to evaluate

[ Top ]

PHPLinq_ILinqProvider thenBy(
string
$expression, [string
$comparer = null])

ThenBy

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::thenBy(): ThenBy

Parameters:

string	$expression	Expression to order elements by
string	$comparer	Comparer function (taking 2 arguments, returning -1, 0, 1)

[ Top ]

PHPLinq_ILinqProvider thenByDescending(
string
$expression, [string
$comparer = null])

ThenByDescending

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::thenByDescending(): ThenByDescending

Parameters:

string	$expression	Expression to order elements by
string	$comparer	Comparer function (taking 2 arguments, returning -1, 0, 1)

[ Top ]

PHPLinq_ILinqProvider where(
string
$expression)

Where

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::where(): Where

Parameters:

string

$expression

Expression checking if an element should be contained

[ Top ]

bool __isDestructing(
)

Is object destructing?

Tags:

access:

public

Implementation of:

PHPLinq_ILinqProvider::__isDestructing(): Is object destructing?

[ Top ]

Class: PHPLinq_LinqToObjects

Class Overview

Author(s):

Copyright:

Variables

Methods

Class Details

Tags:

Class Variables

$_childProviders = array()

Tags:

$_data = null

Tags:

$_distinct = null

Tags:

$_from = ''

Tags:

$_isDestructing =

Tags:

$_joinCondition = null

Tags:

$_ofType = null

Tags:

$_orderBy = array()

Tags:

$_parentProvider = null

Tags:

$_skip = null

Tags:

$_skipWhile = null

Tags:

$_take = null

Tags:

$_takeWhile = null

Tags:

$_where = null

Tags:

Class Methods

static method handles [line 160]

Tags:

Parameters:

constructor __construct [line 171]

Tags:

Parameters:

destructor __destruct [line 185]

Tags:

method addChildProvider [line 228]

Tags:

Parameters:

method aggregate [line 858]

Tags:

Parameters:

method all [line 623]

Tags:

Parameters:

method any [line 607]

Tags:

Parameters:

method average [line 845]

Tags:

method concat [line 695]

Tags:

Parameters:

method contains [line 639]

Tags:

Parameters:

method count [line 809]

Tags:

method distinct [line 560]

Tags:

Parameters:

method elementAt [line 660]

Tags:

Parameters:

method elementAtOrDefault [line 680]

Tags:

Parameters:

method first [line 706]

Tags:

Parameters: