PHP Class eZ\Publish\Core\Search\Elasticsearch\Content\Gateway\Native

Inheritance: extends eZ\Publish\Core\Search\Elasticsearch\Content\Gateway
Mostra file Open project: ezsystems/ezpublish-kernel

Protected Properties

Property Type Description
$client eZ\Publish\Core\Search\Elasticsearch\Content\Gateway\HttpClient
$criterionVisitorDispatcher eZ\Publish\Core\Search\Elasticsearch\Content\CriterionVisitorDispatcher Query criterion visitor dispatcher.
$facetBuilderVisitor eZ\Publish\Core\Search\Elasticsearch\Content\FacetBuilderVisitor Query facet builder visitor.
$indexName string Name of the index in the search backend.
$serializer eZ\Publish\Core\Search\Elasticsearch\Content\Serializer Document serializer.
$sortClauseVisitor eZ\Publish\Core\Search\Elasticsearch\Content\SortClauseVisitor Query sort clause visitor.

Public Methods

Method Description
__construct ( eZ\Publish\Core\Search\Elasticsearch\Content\Gateway\HttpClient $client, Serializer $serializer, CriterionVisitorDispatcher $criterionVisitorDispatcher, SortClauseVisitor $sortClauseVisitor, FacetBuilderVisitor $facetBuilderVisitor, string $indexName )
bulkIndex ( array $documents ) Performs bulk index of a given array of documents.
delete ( integer | string $id, string $type ) Deletes a single document of the given $type by given document $id.
deleteByQuery ( string $query, string $type ) Deletes a document(s) of the given $type by given $query string.
find ( eZ\Publish\API\Repository\Values\Content\Query $query, string $type, array $languageFilter = [] ) : mixed Finds and returns documents of a given $type for a given $query object.
findRaw ( string $query, string $type ) : Message Finds and returns documents of a given $type for a given $query string.
flush ( ) Flushes data from memory to the index storage.
index ( Document $document ) Indexes a given $document.
purgeIndex ( string $type ) Deletes all documents of a given $type from the index.

Method Details

__construct() public method

public __construct ( eZ\Publish\Core\Search\Elasticsearch\Content\Gateway\HttpClient $client, Serializer $serializer, CriterionVisitorDispatcher $criterionVisitorDispatcher, SortClauseVisitor $sortClauseVisitor, FacetBuilderVisitor $facetBuilderVisitor, string $indexName )
$client eZ\Publish\Core\Search\Elasticsearch\Content\Gateway\HttpClient
$serializer eZ\Publish\Core\Search\Elasticsearch\Content\Serializer
$criterionVisitorDispatcher eZ\Publish\Core\Search\Elasticsearch\Content\CriterionVisitorDispatcher
$sortClauseVisitor eZ\Publish\Core\Search\Elasticsearch\Content\SortClauseVisitor
$facetBuilderVisitor eZ\Publish\Core\Search\Elasticsearch\Content\FacetBuilderVisitor
$indexName string

bulkIndex() public method

Performs bulk index of a given array of documents.
public bulkIndex ( array $documents )
$documents array

delete() public method

Deletes a single document of the given $type by given document $id.
public delete ( integer | string $id, string $type )
$id integer | string
$type string

deleteByQuery() public method

Deletes a document(s) of the given $type by given $query string.
public deleteByQuery ( string $query, string $type )
$query string
$type string

find() public method

Finds and returns documents of a given $type for a given $query object.
public find ( eZ\Publish\API\Repository\Values\Content\Query $query, string $type, array $languageFilter = [] ) : mixed
$query eZ\Publish\API\Repository\Values\Content\Query
$type string
$languageFilter array
return mixed

findRaw() public method

Finds and returns documents of a given $type for a given $query string.
public findRaw ( string $query, string $type ) : Message
$query string
$type string
return Message

flush() public method

Flushes data from memory to the index storage.
public flush ( )

index() public method

Indexes a given $document.
public index ( Document $document )
$document eZ\Publish\Core\Search\Elasticsearch\Content\Document

purgeIndex() public method

Deletes all documents of a given $type from the index.
public purgeIndex ( string $type )
$type string

Property Details

$client protected_oe property

protected HttpClient,eZ\Publish\Core\Search\Elasticsearch\Content\Gateway $client
return eZ\Publish\Core\Search\Elasticsearch\Content\Gateway\HttpClient

$criterionVisitorDispatcher protected_oe property

Query criterion visitor dispatcher.
protected CriterionVisitorDispatcher,eZ\Publish\Core\Search\Elasticsearch\Content $criterionVisitorDispatcher
return eZ\Publish\Core\Search\Elasticsearch\Content\CriterionVisitorDispatcher

$facetBuilderVisitor protected_oe property

Query facet builder visitor.
protected FacetBuilderVisitor,eZ\Publish\Core\Search\Elasticsearch\Content $facetBuilderVisitor
return eZ\Publish\Core\Search\Elasticsearch\Content\FacetBuilderVisitor

$indexName protected_oe property

Name of the index in the search backend.
protected string $indexName
return string

$serializer protected_oe property

Document serializer.
protected Serializer,eZ\Publish\Core\Search\Elasticsearch\Content $serializer
return eZ\Publish\Core\Search\Elasticsearch\Content\Serializer

$sortClauseVisitor protected_oe property

Query sort clause visitor.
protected SortClauseVisitor,eZ\Publish\Core\Search\Elasticsearch\Content $sortClauseVisitor
return eZ\Publish\Core\Search\Elasticsearch\Content\SortClauseVisitor