Overview

Namespaces

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

Classes

  • Client
  • Overview
  • Namespace
  • Class
  • Tree

Class Client

Direct known subclasses

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

Creates a new Forage client

Creates a new Forage client

Parameters

$transport
vierbergenlars\Forage\Transport\TransportInterface
$transport
public vierbergenlars\Forage\SearchQuery\QueryBuilder
# createQueryBuilder( )

Creates a new query builder

Creates a new query builder

Returns

vierbergenlars\Forage\SearchQuery\QueryBuilder
public vierbergenlars\Forage\SearchIndex\Index
# getIndex( )

Gets the search index

Gets the search index

Returns

vierbergenlars\Forage\SearchIndex\Index
public vierbergenlars\Forage\ODM\DocumentMapper
# createDocumentMapper( vierbergenlars\Forage\ODM\HydrationSettingsInterface $hydrationSettings )

Creates a new document mapper

Creates a new document mapper

Parameters

$hydrationSettings
vierbergenlars\Forage\ODM\HydrationSettingsInterface
$hydrationSettings

Returns

vierbergenlars\Forage\ODM\DocumentMapper
Properties summary
protected vierbergenlars\Forage\Transport\TransportInterface $transport
#

The transport to use

The transport to use

Forage-PHP-Client API documentation generated by ApiGen 2.8.0