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

Interface HydrationSettingsInterface

Interface for settings for the hydration of search results in objects

Direct known implementers

vierbergenlars\Forage\ODM\HydrationSettings\DeferHydration

Indirect known implementers

vierbergenlars\Forage\ODM\HydrationSettings\SingleObjectHydration
Namespace: vierbergenlars\Forage\ODM
Located at vierbergenlars/Forage/ODM/HydrationSettingsInterface.php
Methods summary
public array
# getDocument( object $document )

Gets the document from an object

Gets the document from an object

Parameters

$document
object
$document

Returns

array
The document to be stored in the database
public string|integer
# getDocumentId( object $document )

Gets the id of the document from the object

Gets the id of the document from the object

Parameters

$document
object
$document

Returns

string|integer
The id of the document to be stored in the database
public vierbergenlars\Forage\ODM\SearchHit
# getObject( vierbergenlars\Forage\ODM\SearchHit $document )

Gets the object from a document

Gets the object from a document

Parameters

$document
array
$document

Returns

vierbergenlars\Forage\ODM\SearchHit
Forage-PHP-Client API documentation generated by ApiGen 2.8.0