PHP Class Storm\Core\Relational\Criterion

Author: Elliot Levin ([email protected])
Show file Open project: timetoogo/penumbra Class Usage Examples

Public Methods

Method Description
AddGroupByExpression ( Expression $Expression )
AddOrderByExpression ( Expression $Expression, $Ascending )
AddPredicateExpression ( Expression $PredicateExpression )
AddTable ( Storm\Core\Relational\ITable $Table ) : void Add a table to the criterion.
AddTables ( array $Tables ) : void Add an array of tables to the criterion
GetGroupByExpressions ( ) : Expression[]
GetOrderedExpressionsAscendingMap ( ) : SplObjectStorage
GetPredicateExpressions ( ) : Expression[]
GetRangeAmount ( ) : integer | null
GetRangeOffset ( ) : integer
GetTables ( ) : Storm\Core\Relational\ITable[]
IsConstrained ( ) : boolean
IsGrouped ( ) : boolean
IsOrdered ( ) : boolean
IsRanged ( ) : boolean
SetRangeAmount ( type $RangeAmount ) Set the range amount.
SetRangeOffset ( integer $RangeOffset ) Set the range offset.
__construct ( )

Method Details

AddGroupByExpression() final public method

final public AddGroupByExpression ( Expression $Expression )
$Expression Storm\Core\Relational\Expressions\Expression

AddOrderByExpression() final public method

final public AddOrderByExpression ( Expression $Expression, $Ascending )
$Expression Storm\Core\Relational\Expressions\Expression

AddPredicateExpression() final public method

final public AddPredicateExpression ( Expression $PredicateExpression )
$PredicateExpression Storm\Core\Relational\Expressions\Expression

AddTable() final public method

Add a table to the criterion.
final public AddTable ( Storm\Core\Relational\ITable $Table ) : void
$Table Storm\Core\Relational\ITable The table to add
return void

AddTables() final public method

Add an array of tables to the criterion
final public AddTables ( array $Tables ) : void
$Tables array The tables to add
return void

GetGroupByExpressions() final public method

final public GetGroupByExpressions ( ) : Expression[]
return Storm\Core\Relational\Expressions\Expression[]

GetOrderedExpressionsAscendingMap() final public method

final public GetOrderedExpressionsAscendingMap ( ) : SplObjectStorage
return SplObjectStorage

GetPredicateExpressions() final public method

final public GetPredicateExpressions ( ) : Expression[]
return Storm\Core\Relational\Expressions\Expression[]

GetRangeAmount() final public method

final public GetRangeAmount ( ) : integer | null
return integer | null

GetRangeOffset() final public method

final public GetRangeOffset ( ) : integer
return integer

GetTables() final public method

final public GetTables ( ) : Storm\Core\Relational\ITable[]
return Storm\Core\Relational\ITable[]

IsConstrained() final public method

final public IsConstrained ( ) : boolean
return boolean

IsGrouped() final public method

final public IsGrouped ( ) : boolean
return boolean

IsOrdered() final public method

final public IsOrdered ( ) : boolean
return boolean

IsRanged() final public method

final public IsRanged ( ) : boolean
return boolean

SetRangeAmount() final public method

Set the range amount.
final public SetRangeAmount ( type $RangeAmount )
$RangeAmount type Specify null to remove the limit

SetRangeOffset() final public method

Set the range offset.
final public SetRangeOffset ( integer $RangeOffset )
$RangeOffset integer

__construct() public method

public __construct ( )