Interface FetcherInterface

Interface for an active record fetcher that supports external conditions.

Direct known implementers

ICanBoogie\Facets\Fetcher

Namespace: ICanBoogie\Facets
Located at FetcherInterface.php

Methods summary

`public`	# `alter_criterion_list( ICanBoogie\Facets\CriterionList $criterion_list )` Alter the `ICanBoogie\Facets\CriterionList` instance usually provided during construct. Alter the `ICanBoogie\Facets\CriterionList` instance usually provided during construct. Parameters `$criterion_list`
`public array`	# `alter_conditions( array & $conditions, array $modifiers )` Alter the conditions with the specified modifiers. Alter the conditions with the specified modifiers. A `ICanBoogie\Facets\CriterionList` instance is usually used to alter the conditions. Parameters `$conditions` The conditions to alter, usually initialized `$modifiers` Returns array The altered conditions.
`public`	# `parse_query_string( ICanBoogie\Facets\QueryString $q )` Parse the query string. Parse the query string. The query string is usually specified by the `q` condition. The conditions extracted from the query string are merged in the conditions. A `ICanBoogie\Facets\CriterionList` instance is usually used to parse the query string. Parameters `$q`
`public ICanBoogie\ActiveRecord\Query`	# `alter_query( ICanBoogie\ActiveRecord\Query $query )` Alter the initial query. Alter the initial query. A `ICanBoogie\Facets\CriterionList` instance is usually used to alter the initial query. Parameters `$query` Returns ICanBoogie\ActiveRecord\Query The altered initial query.
`public ICanBoogie\ActiveRecord\Query`	# `alter_query_with_conditions( ICanBoogie\ActiveRecord\Query $query, array $conditions )` Alter the query with conditions. Alter the query with conditions. A `ICanBoogie\Facets\CriterionList` instance is usually used to alter the query with conditions. Parameters `$query` `$conditions` Returns ICanBoogie\ActiveRecord\Query The altered query.
`public ICanBoogie\ActiveRecord\Query`	# `alter_query_with_order( ICanBoogie\ActiveRecord\Query $query, string $criterion_id, integer $order_direction = 1 )` Alter the query with an order. Alter the query with an order. A `ICanBoogie\Facets\CriterionList` instance is usually used to alter the query with an order. Parameters `$query` `$criterion_id` `$order_direction` Returns ICanBoogie\ActiveRecord\Query The altered query.
`public integer`	# `count_records( ICanBoogie\ActiveRecord\Query $query )` Counts the number of records that are matching the query. Counts the number of records that are matching the query. The method is invoked before the query is altered with a limit, thus the number returned is the total number of records matching the query. Parameters `$query` Returns integer
`public ICanBoogie\ActiveRecord\Query`	# `alter_query_with_limit( ICanBoogie\ActiveRecord\Query $query, integer $offset, integer $limit )` Alter the query with an offset and limit. Alter the query with an offset and limit. Parameters `$query` `$offset` `$limit` Returns ICanBoogie\ActiveRecord\Query The altered query.
`public array`	# `fetch_records( ICanBoogie\ActiveRecord\Query $query )` Fetch the records matching the query. Fetch the records matching the query. Parameters `$query` Returns array
`public`	# `alter_records( array & $records )` Alter the fetched records. Alter the fetched records. A `ICanBoogie\Facets\CriterionList` instance is usually used to alter the records. Parameters `$records`