Class SearchIndex

A search index that can index object

vierbergenlars\Forage\SearchIndex\Index

Extended by

vierbergenlars\Forage\ODM\SearchIndex

Namespace: vierbergenlars\Forage\ODM
Located at vierbergenlars/Forage/ODM/SearchIndex.php

Methods summary
`public vierbergenlars\Forage\ODM\SearchIndex`	# `addDocument( object $document, null $_ = null )` Adds a new document to the index Adds a new document to the index Parameters `$document` `object` $document `$_` `null` $_ Unused parameter Returns `vierbergenlars\Forage\ODM\SearchIndex` Overrides `vierbergenlars\Forage\SearchIndex\Index::addDocument()`
`public vierbergenlars\Forage\ODM\SearchIndex`	# `removeDocument( object\|string\|integer $document, null $_ = null )` Removes a document from the index Removes a document from the index Parameters `$document` `object\|string\|integer` $document When the document to remove is given as a string or an integer, it is used as an id. If it is an object, `vierbergenlars\Forage\ODM\HydrationSettingsInterface::getDocument()` gets called, and the document id will be determined from the returned array. `$_` `null` $_ Unused parameter Returns `vierbergenlars\Forage\ODM\SearchIndex` Overrides `vierbergenlars\Forage\SearchIndex\Index::removeDocument()`

Methods inherited from vierbergenlars\Forage\SearchIndex\Index
`__construct(), addFacetField(), flush(), removeFacetField()`

Properties summary
`protected vierbergenlars\Forage\ODM\HydrationSettingsInterface`	`$hydrationSettings`		# The hydration settings The hydration settings

Properties inherited from vierbergenlars\Forage\SearchIndex\Index
`$facetFields, $removedDocuments, $transport, $uploadedDocuments`