Interface Criterion
An interface common to Criteria.
Direct known implementers
Indirect known implementers
ICanBoogie\Facets\Criterion\BooleanCriterion,
ICanBoogie\Facets\Criterion\DateCriterion
Methods summary
public
parse_query_string( ICanBoogie\Facets\QueryString $q )
: ICanBoogie\Facets\QueryString
Parses the query string and marks words matched by the criterion.
Parses the query string and marks words matched by the criterion.
Parameters
$q
Returns
public
parse_value( mixed $value )
Parses a criterion value.
Parses a criterion value.
Parameters
$value
public
alter_conditions( array & $conditions, array $modifiers )
Alters the conditions according to the specified modifiers.
Alters the conditions according to the specified modifiers.
Parameters
$conditions- The conditions to alter.
$modifiers- The modifiers.
public
alter_query( ICanBoogie\ActiveRecord\Query $query )
: ICanBoogie\ActiveRecord\Query
Alters the initial query.
Alters the initial query.
Parameters
$query
Returns
$query The altered query.
public
alter_query_with_value( ICanBoogie\ActiveRecord\Query $query, mixed $value )
: ICanBoogie\ActiveRecord\Query
Alters the query according to the value specified.
Alters the query according to the value specified.
Note: The method is only invoked if a value key matches the criterion identifier.
Parameters
$query$value
Returns
public
alter_query_with_order( ICanBoogie\ActiveRecord\Query $query, integer $order_direction )
: ICanBoogie\ActiveRecord\Query
Alters the ORDER clause of the query according to the column identifier and the order direction.
Alters the ORDER clause of the query according to the column identifier and the order direction.
Note: The method is only invoked if the ordering column matches the criterion identifier.
Parameters
$query$order_direction