Overview

Namespaces

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

Classes

  • DocumentMapper
  • SearchHit
  • SearchIndex
  • SearchQuery
  • SearchResult

Interfaces

  • HydrationSettingsInterface
  • Indexable
  • Overview
  • Namespace
  • Class
  • Tree

Class DocumentMapper

The document mapper

vierbergenlars\Forage\Client
Extended by vierbergenlars\Forage\ODM\DocumentMapper
Namespace: vierbergenlars\Forage\ODM
Located at vierbergenlars/Forage/ODM/DocumentMapper.php
Methods summary
public
# __construct( vierbergenlars\Forage\Transport\TransportInterface $transport, vierbergenlars\Forage\ODM\HydrationSettingsInterface $hydrationSettings )

Creates a new document mapper

Creates a new document mapper

Parameters

$transport
vierbergenlars\Forage\Transport\TransportInterface
$transport The transport to use
$hydrationSettings
vierbergenlars\Forage\ODM\HydrationSettingsInterface
$hydrationSettings

Overrides

vierbergenlars\Forage\Client::__construct()
public vierbergenlars\Forage\SearchQuery\QueryBuilder
# createQueryBuilder( )

Creates a new query builder, with a search result that is automatically hydrated.

Creates a new query builder, with a search result that is automatically hydrated.

Returns

vierbergenlars\Forage\SearchQuery\QueryBuilder

Overrides

vierbergenlars\Forage\Client::createQueryBuilder()
public vierbergenlars\Forage\ODM\SearchIndex
# getIndex( )

Gets the search index

Gets the search index

Returns

vierbergenlars\Forage\ODM\SearchIndex

Overrides

vierbergenlars\Forage\Client::getIndex()
Methods inherited from vierbergenlars\Forage\Client
createDocumentMapper()
Properties summary
protected vierbergenlars\Forage\ODM\HydrationSettingsInterface $hydrationSettings
#

Settings for parameter injection

Settings for parameter injection

Properties inherited from vierbergenlars\Forage\Client
$transport
Forage-PHP-Client API documentation generated by ApiGen 2.8.0