PHP Interface Storm\Core\Object\ICriterion

Author: Elliot Levin ([email protected])
ファイルを表示 Open project: timetoogo/penumbra Interface Usage Examples

Public Methods

Method Description
GetEntityType ( ) : string The type of entities which the criterion represents.
GetGroupByExpressions ( ) : Expression[]
GetOrderByExpressionsAscendingMap ( ) : SplObjectStorage Returns a SplObjectStorage with the an Expression to order by mapped to a boolean representing whether or not the it is ascending.
GetPredicateExpressions ( ) : Expression[]
GetRangeAmount ( ) return int|null
GetRangeOffset ( ) return int
IsConstrained ( ) Whether or not the criterion contains any predicates.
IsGrouped ( ) Whether or not the criterion contains any group by expressions.
IsOrdered ( ) Whether or not the criterion contains any order by expressions.
IsRanged ( ) Whether or not the criterion contains an offset other than zero or a limit.

Method Details

GetEntityType() public method

The type of entities which the criterion represents.
public GetEntityType ( ) : string
return string

GetGroupByExpressions() public method

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

GetOrderByExpressionsAscendingMap() public method

Returns a SplObjectStorage with the an Expression to order by mapped to a boolean representing whether or not the it is ascending.
public GetOrderByExpressionsAscendingMap ( ) : SplObjectStorage
return SplObjectStorage

GetPredicateExpressions() public method

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

GetRangeAmount() public method

return int|null
public GetRangeAmount ( )

GetRangeOffset() public method

return int
public GetRangeOffset ( )

IsConstrained() public method

return boolean
public IsConstrained ( )

IsGrouped() public method

return boolean
public IsGrouped ( )

IsOrdered() public method

return boolean
public IsOrdered ( )

IsRanged() public method

return boolean
public IsRanged ( )