include/SugarSearchEngine/Elastic/Elastica/Percolator.php

Show: inherited
Table of Contents

Percolator class

Author
Nicolas Ruflin  
Category
Xodoa  
Link
http://www.elasticsearch.org/guide/reference/api/percolate.html  
Package
Elastica  

\Elastica_Percolator

Package: Elastica

Percolator class

Author
Nicolas Ruflin  
Category
Xodoa  
Link
http://www.elasticsearch.org/guide/reference/api/percolate.html  

Properties

Propertyprotected\Elastica_Index  $_index= 'null'

Default valuenullDetails
Type
\Elastica_Index

Methods

methodpublic__construct( \Elastica_Index $index ) : void

Parameters
Name Type Description
$index \Elastica_Index
methodpublicgetIndex( ) : \Elastica_Index

Returns
Type Description
\Elastica_Index
methodpublicmatchDoc( \Elastica_Document $doc, string | \Elastica_Query | \Elastica_Query_Abstract $query = null ) : \Elastica_Resonse

Match a document to percolator queries

Parameters
Name Type Description
$doc \Elastica_Document
$query string | \Elastica_Query | \Elastica_Query_Abstract

Not implemented yet

Returns
Type Description
\Elastica_Resonse
methodpublicregisterQuery( string $name, string | \Elastica_Query | \Elastica_Query_Abstract $query ) : \Elastica_Resonse

Registers a percolator query

Parameters
Name Type Description
$name string

Query name

$query string | \Elastica_Query | \Elastica_Query_Abstract

Query to add

Returns
Type Description
\Elastica_Resonse
Documentation was generated by DocBlox 0.18.1.