Overview

Namespaces

  • PHP
  • vierbergenlars
    • Forage
      • ODM
        • HydrationSettings
      • QueryParser
      • SearchIndex
      • SearchQuery
      • SearchResult
      • Transport

Classes

  • Facet
  • Hit
  • SearchResult
  • Overview
  • Namespace
  • Class
  • Tree

Class Facet

A facet

ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, Serializable, Countable
Extended by vierbergenlars\Forage\SearchResult\Facet
Namespace: vierbergenlars\Forage\SearchResult
Located at vierbergenlars/Forage/SearchResult/Facet.php
Methods summary
public
# __construct( string $field, array $results )

Creates a new facet

Creates a new facet

Parameters

$field
string
$field
$results
array
$results

Private

Overrides

ArrayObject::__construct()
public string
# getField( )

Gets the name of the faceted field

Gets the name of the faceted field

Returns

string
public array
# getResults( )

Gets the results of the faceted field

Gets the results of the faceted field

Returns

array
Methods inherited from ArrayObject
append(), asort(), count(), exchangeArray(), getArrayCopy(), getFlags(), getIterator(), getIteratorClass(), ksort(), natcasesort(), natsort(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), serialize(), setFlags(), setIteratorClass(), uasort(), uksort(), unserialize()
Constants inherited from ArrayObject
ARRAY_AS_PROPS, STD_PROP_LIST
Properties summary
protected string $field
#

The name of the faceted field

The name of the faceted field

Forage-PHP-Client API documentation generated by ApiGen 2.8.0