Trait CriterionTrait
Trait for a generic criterion.
Methods summary
protected
get_id( void )
Returns the criterion's identifier.
Returns the criterion's identifier.
protected
get_column_name( void )
Returns the criterion's column name, or if it is empty the criterion's identifier.
Returns the criterion's column name, or if it is empty the criterion's identifier.
public
parse_value( mixed $value )
: mixed
public
alter_conditions( array & $conditions, array $modifiers )
Unset the condition if the modifier is null or an empty string.
Unset the condition if the modifier is null or an empty string.
Parameters
public
alter_query( ICanBoogie\ActiveRecord\Query $query )
public
alter_query_with_value( ICanBoogie\ActiveRecord\Query $query, mixed $value )
: ICanBoogie\ActiveRecord\Query
Alters the query according to the specified value.
Alters the query according to the specified value.
The method handles ICanBoogie\Facets\IntervalCriterionValue and ICanBoogie\Facets\SetCriterionValue instances as well
as plain values, for which a simple {$this->id} = {$value} is done.
Subclasses might want to override the method according to the kind of value they provide.
Parameters
Returns
ICanBoogie\ActiveRecord\Query
public
alter_query_with_order( ICanBoogie\ActiveRecord\Query $query, integer $order_direction )
: ICanBoogie\ActiveRecord\Query
Alters the query with an order.
public
alter_records( array & $records )
Properties summary
protected
$id
: string
The identifier of the criterion.
The identifier of the criterion.
protected
$column_name
: string
The column name of the criterion, as in a SQL table.
The column name of the criterion, as in a SQL table.