Overview

Namespaces

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

Classes

  • DeferHydration
  • SingleObjectHydration
  • Overview
  • Namespace
  • Class
  • Tree

Class DeferHydration

Base class for hydration strategies that use vierbergenlars/defer to hydrate their objects

vierbergenlars\Forage\ODM\HydrationSettings\DeferHydration implements vierbergenlars\Forage\ODM\HydrationSettingsInterface

Direct known subclasses

vierbergenlars\Forage\ODM\HydrationSettings\SingleObjectHydration
Abstract
Namespace: vierbergenlars\Forage\ODM\HydrationSettings
Located at vierbergenlars/Forage/ODM/HydrationSettings/DeferHydration.php
Methods summary
abstract public array
# getParameters( string|integer $id, array $document )

Gets the properties to be injected in the object

Gets the properties to be injected in the object

Parameters

$id
string|integer
$id The id of the document received from the search query
$document
array
$document The document received from the search query

Returns

array
A map of object properties to values
abstract public string
# getClass( string|integer $id, array $document )

Gets the class name of the object that will be hydrated

Gets the class name of the object that will be hydrated

Parameters

$id
string|integer
$id The id of the document received from the search query
$document
array
$document The document received from the search query

Returns

string
A fully qualified class name. (Should implement Defer\Object\Deferrable)
public object
# getObject( vierbergenlars\Forage\ODM\SearchHit $hit )

Gets the object from a document

Gets the object from a document

Parameters

$hit
array
$document

Returns

object

Implementation of

vierbergenlars\Forage\ODM\HydrationSettingsInterface::getObject()
Methods inherited from vierbergenlars\Forage\ODM\HydrationSettingsInterface
getDocument(), getDocumentId()
Forage-PHP-Client API documentation generated by ApiGen 2.8.0