Class Fetcher

Fetch records from a model.

ICanBoogie\Facets\Fetcher implements ICanBoogie\Facets\FetcherInterface uses ICanBoogie\Accessor\AccessorTrait (not available) ICanBoogie\Facets\FetcherTrait

Namespace: ICanBoogie\Facets
Located at Fetcher.php

Methods summary


				
				 protected 
				
				

				get_model( void )
				

				: ICanBoogie\ActiveRecord\Model

Return the ICanBoogie\Facets\Fetcher::$model property.


				
				 protected 
				
				

				get_modifiers( void )
				

				: array

Return the ICanBoogie\Facets\Fetcher::$modifiers property.


				
				 protected 
				
				

				get_initial_query( void )
				

				: ICanBoogie\ActiveRecord\Query

Return the $initial_query property.


				
				 protected 
				
				

				get_query( void )
				

				: ICanBoogie\ActiveRecord\Query

Return the query used to fetch the records.


				
				 protected 
				
				

				get_query_string( void )
				

				: ICanBoogie\Facets\QueryString

Return the ICanBoogie\Facets\Fetcher::$query_string property.


				
				 protected 
				
				

				get_conditions( void )
				

				: array

Return the ICanBoogie\Facets\Fetcher::$conditions property.


				
				 protected 
				
				

				get_order( void )
				

				: string|null

Return the ICanBoogie\Facets\Fetcher::$order property.


				
				 protected 
				
				

				get_limit( void )
				

				: integer|null

Return the ICanBoogie\Facets\Fetcher::$limit property.


				
				 protected 
				
				

				get_offset( void )


				
				 protected 
				
				

				get_page( void )


				
				 protected 
				
				

				get_count( void )
				

				: integer

Return the ICanBoogie\Facets\Fetcher::$count property.


				
				 public 
				
				

				__construct( ICanBoogie\ActiveRecord\Model $model, array $options = [] )

Initializes the ICanBoogie\Facets\Fetcher::$model, ICanBoogie\Facets\Fetcher::$options and ICanBoogie\Facets\Fetcher::$criterion_list properties.


				
				 public 
				
				

				__clone( void )

Clones the initial_query, query, and ICanBoogie\Facets\Fetcher::$query_string properties.


				
				 public 
				
				

				__invoke( array $modifiers )
				

				: array

Fetch records according to the specified modifiers.


				
				 protected 
				
				

				create_initial_query( void )
				

				: ICanBoogie\ActiveRecord\Query

Create the initial query.


				
				 protected 
				
				

				parse_modifiers( array $modifiers )
				

				: array

Parse modifiers to extract conditions, and qualifiers.

Methods inherited from ICanBoogie\Facets\FetcherInterface

alter_conditions(), alter_criterion_list(), alter_query(), alter_query_with_conditions(), alter_query_with_limit(), alter_query_with_order(), alter_records(), count_records(), fetch_records(), parse_query_string()

Methods used from ICanBoogie\Facets\FetcherTrait

Properties summary


				
				protected  
				

				
$model				

				: ICanBoogie\ActiveRecord\Model

The model from witch records are fetched.


				
				protected  
				

				
$modifiers				

				: array

Fetch modifiers.


				
				protected  
				

				
$options				

				: array

Options.

[]


				
				protected  
				

				
$query_string				

				: ICanBoogie\Facets\QueryString

Query string resolved from the modifiers.


				
				protected  
				

				
$conditions				

				: array

Conditions resolved from the modifiers.

[]


				
				protected  
				

				
$order				

				: string|null

Order of the records, as found in the modifiers.


				
				protected  
				

				
$limit				

				: string|null

Limit of the number of records to fetch, as found in the modifiers.


				
				protected  
				

				
$offset


				
				protected  
				

				
$count				

				: integer

Number of records matching the query, before they are limited.

Properties used from ICanBoogie\Facets\FetcherTrait

$criterion_list

Magic properties


				
				public  read-only
				

				
$model				

				: ICanBoogie\ActiveRecord\Model

The model from which record are fetched.


				
				public  read-only
				

				
$criterion_list				

				: ICanBoogie\Facets\CriterionList

List of criterion.


				
				public  read-only
				

				
$modifiers				

				: array

An array of key/value used to filter/order/qualify the records.


				
				public  read-only
				

				
$initial_query				

				: ICanBoogie\ActiveRecord\Query

The initial query, before it is altered by the criteria, conditions, order or limit.


				
				public  read-only
				

				
$query				

				: ICanBoogie\ActiveRecord\Query

The query used to fetch the records.


				
				public  read-only
				

				
$query_string				

				: ICanBoogie\Facets\QueryString

A ICanBoogie\Facets\QueryString instance resolved from the q modifier.


				
				public  read-only
				

				
$conditions				

				: array

An array of conditions used to filter the fetched records.


				
				public  read-only
				

				
$order				

				: string

The order in which records are fetched, as defined by the order modifier.


				
				public  read-only
				

				
$count				

				: integer

The number of records matching the query before the offset and limit is applied.


				
				public  read-only
				

				
$limit				

				: integer

The maximum number of records that can be fetched, as defined by the limit modifier.

Class Fetcher

Methods summary

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Parameters

Returns

Returns

Parameters

Returns

Methods inherited from ICanBoogie\Facets\FetcherInterface

Methods used from ICanBoogie\Facets\FetcherTrait

Properties summary

Properties used from ICanBoogie\Facets\FetcherTrait

Magic properties