ICanBoogie/Facets master
  • Namespace
  • Class

Namespaces

  • ICanBoogie
    • Facets
      • Criterion
      • CriterionValue
      • Fetcher
      • RecordCollection

Classes

  • CriterionList
  • CriterionNotDefined
  • CriterionValue
  • QueryString
  • QueryStringWord
  • RecordCollection

Interfaces

  • Criterion
  • Fetcher

Traits

  • CriterionTrait
  • FetcherTrait
  • ModelBindings

Interface Criterion

An interface common to Criteria.

Direct known implementers

ICanBoogie\Facets\Criterion\BasicCriterion

Indirect known implementers

ICanBoogie\Facets\Criterion\BooleanCriterion, ICanBoogie\Facets\Criterion\DateCriterion

Namespace: ICanBoogie\Facets
Located at Criterion.php

Methods summary

public ICanBoogie\Facets\QueryString
# parse_query_string( ICanBoogie\Facets\QueryString $q )

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

ICanBoogie\Facets\QueryString
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 ICanBoogie\ActiveRecord\Query
# alter_query( ICanBoogie\ActiveRecord\Query $query )

Alters the initial query.

Alters the initial query.

Parameters

$query

Returns

ICanBoogie\ActiveRecord\Query
$query The altered query.
public ICanBoogie\ActiveRecord\Query
# alter_query_with_value( ICanBoogie\ActiveRecord\Query $query, mixed $value )

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

ICanBoogie\ActiveRecord\Query
public ICanBoogie\ActiveRecord\Query
# alter_query_with_order( ICanBoogie\ActiveRecord\Query $query, integer $order_direction )

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

Returns

ICanBoogie\ActiveRecord\Query
public ICanBoogie\ActiveRecord[]
# alter_records( array & $records )

Alters the records.

Alters the records.

Parameters

$records

Returns

ICanBoogie\ActiveRecord[]
ICanBoogie/Facets master API documentation generated by ApiGen