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

Class RecordCollection

A collection of records fetched by a ICanBoogie\Facets\Fetcher instance.

ICanBoogie\Facets\RecordCollection implements IteratorAggregate, Countable uses ICanBoogie\Accessor\AccessorTrait (not available)
Namespace: ICanBoogie\Facets
Located at RecordCollection.php

Methods summary

protected get_fetcher( void )
protected get_one( void ) : ICanBoogie\ActiveRecord

Returns the first record in the collection.

Returns the first record in the collection.

Returns

ICanBoogie\ActiveRecord
protected get_total_count( void ) : integer

Returns the number of records matching the query, without range limitation.

Returns the number of records matching the query, without range limitation.

Returns

integer
public __construct( array $records, ICanBoogie\Facets\Fetcher $fetcher )
public __get( $property )
public getIterator( void ) : ArrayIterator

Returns

ArrayIterator

Implementation of

IteratorAggregate::getIterator()
public count( void )

Inheritdoc

Implementation of

Countable::count()

Properties summary

Magic properties

public read-only $fetcher : ICanBoogie\Facets\Fetcher
public read-only $conditions : array

The conditions used to fetch the records.

public read-only $limit : integer

The maximum number of records.

public read-only $page : integer

The current page.

public read-only $total_count : integer

The number of records matching the query, without range limitation.

public read-only $initial_query : ICanBoogie\ActiveRecord\Query
public read-only $query : ICanBoogie\ActiveRecord\Query
public read-only $one : ICanBoogie\ActiveRecord

The first record in the collection.

Facets v0.3.1 – Check on GitHub – API documentation generated by ApiGen