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

Mostra file Open project: ezsystems/ezpublish-kernel Class Usage Examples

Public Methods

Method Description
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

bulkIndex() abstract public method

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

delete() abstract public method

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

deleteByQuery() abstract public method

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

find() abstract public method

Finds and returns documents of a given $type for a given $query object.
abstract 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() abstract public method

Finds and returns documents of a given $type for a given $query string.
abstract public findRaw ( string $query, string $type ) : Message
$query string
$type string
return eZ\Publish\Core\Search\Elasticsearch\Content\Gateway\Message

flush() abstract public method

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

index() abstract public method

Indexes a given $document.
abstract public index ( Document $document )
$document Document

purgeIndex() abstract public method

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