PHP Class Elastica\Query\Percolate

Inheritance: extends AbstractQuery
Datei anzeigen Open project: ruflin/elastica

Public Methods

Method Description
setDocument ( $document ) The source of the document being percolated.
setDocumentId ( $id ) The id of the document to fetch.
setDocumentIndex ( $index ) The index the document resides in.
setDocumentPreference ( $preference ) Optionally, preference to be used to fetch document to percolate.
setDocumentRouting ( $routing ) Optionally, routing to be used to fetch document to percolate.
setDocumentType ( $documentType ) The type / mapping of the document being percolated. This is a required parameter.
setDocumentVersion ( $version ) Optionally, the expected version of the document to be fetched.
setExistingDocumentType ( $type ) The type of the document to fetch.
setField ( $field ) The field of type percolator and that holds the indexed queries. This is a required parameter.

Method Details

setDocument() public method

The source of the document being percolated.
public setDocument ( $document )
$document

setDocumentId() public method

The id of the document to fetch.
public setDocumentId ( $id )
$id

setDocumentIndex() public method

The index the document resides in.
public setDocumentIndex ( $index )
$index

setDocumentPreference() public method

Optionally, preference to be used to fetch document to percolate.
public setDocumentPreference ( $preference )
$preference

setDocumentRouting() public method

Optionally, routing to be used to fetch document to percolate.
public setDocumentRouting ( $routing )
$routing

setDocumentType() public method

The type / mapping of the document being percolated. This is a required parameter.
public setDocumentType ( $documentType )
$documentType

setDocumentVersion() public method

Optionally, the expected version of the document to be fetched.
public setDocumentVersion ( $version )
$version

setExistingDocumentType() public method

The type of the document to fetch.
public setExistingDocumentType ( $type )
$type

setField() public method

The field of type percolator and that holds the indexed queries. This is a required parameter.
public setField ( $field )
$field