ICanBoogie
  • Documentation
  • API Reference
  • Facets v0.3.1
Namespaces
  • ICanBoogie
    • Facets
      • RecordCollection
Classes
  • BooleanCriterion
  • Criterion
  • CriterionList
  • CriterionNotDefined
  • CriterionValue
  • Fetcher
  • IntervalCriterionValue
  • QueryString
  • QueryStringWord
  • RecordCollection
  • SetCriterionValue
Interfaces
  • CriterionInterface
  • FetcherInterface
Traits
  • CriterionTrait
  • FetcherTrait
  • HumanizePairsTrait
  • ParseQueryStringTrait

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 alter_conditions( array & $conditions, array $modifiers ) : array

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 alter_query( ICanBoogie\ActiveRecord\Query $query ) : ICanBoogie\ActiveRecord\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 alter_query_with_conditions( ICanBoogie\ActiveRecord\Query $query, array $conditions ) : ICanBoogie\ActiveRecord\Query

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 alter_query_with_order( ICanBoogie\ActiveRecord\Query $query, string $criterion_id, integer $order_direction = 1 ) : ICanBoogie\ActiveRecord\Query

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 count_records( ICanBoogie\ActiveRecord\Query $query ) : integer

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 alter_query_with_limit( ICanBoogie\ActiveRecord\Query $query, integer $offset, integer $limit ) : ICanBoogie\ActiveRecord\Query

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 fetch_records( ICanBoogie\ActiveRecord\Query $query ) : array

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
Facets v0.3.1 – Check on GitHub – API documentation generated by ApiGen