PHP Класс Cake\ElasticSearch\ResultSet

Наследование: extends IteratorIterato\IteratorIterator, implements Countabl\Countable, implements JsonSerializabl\JsonSerializable, use trait Cake\Collection\CollectionTrait
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$embeds array Embedded type references
$entityClass Document The full class name of the document class to wrap the results
$repoName string Name of the type that the originating query came from.
$resultSet string Holds the original instance of the result set

Открытые методы

Метод Описание
__construct ( ResultSet $resultSet, Query $query ) Decorator's constructor
__debugInfo ( ) : array Debug output hook method.
count ( ) : integer Returns size of current set
countSuggests ( ) : integer Returns size of current suggests
current ( ) : Document Returns the current document for the iteration
getAggregation ( string $name ) : array Retrieve a specific aggregation from this result set
getAggregations ( ) : array Returns all aggregation results
getFacets ( ) : array Returns all facets results
getMaxScore ( ) : float Returns the max score of the results found
getQuery ( ) : Query Returns the original \Elastica\Query instance
getResponse ( ) : Response Returns response object
getResults ( ) : Result[] Returns all results
getSuggests ( ) : array Return all suggests
getTotalHits ( ) : integer Returns the total number of found hits
getTotalTime ( ) : integer Returns the total number of ms for this search to complete
hasFacets ( ) : boolean Returns whether facets exist
hasSuggests ( ) : boolean Returns true if the response contains suggestion results; false otherwise
hasTimedOut ( ) : boolean Returns true if the query has timed out

Описание методов

__construct() публичный Метод

Decorator's constructor
public __construct ( ResultSet $resultSet, Query $query )
$resultSet Elastica\ResultSet The results from Elastica to wrap
$query Elastica\Query The Elasticsearch Query object

__debugInfo() публичный Метод

Debug output hook method.
public __debugInfo ( ) : array
Результат array

count() публичный Метод

Returns size of current set
public count ( ) : integer
Результат integer Size of set

countSuggests() публичный Метод

Returns size of current suggests
public countSuggests ( ) : integer
Результат integer Size of suggests

current() публичный Метод

Returns the current document for the iteration
public current ( ) : Document
Результат Document

getAggregation() публичный Метод

Retrieve a specific aggregation from this result set
public getAggregation ( string $name ) : array
$name string the name of the desired aggregation
Результат array

getAggregations() публичный Метод

Returns all aggregation results
public getAggregations ( ) : array
Результат array

getFacets() публичный Метод

Returns all facets results
public getFacets ( ) : array
Результат array Facet results

getMaxScore() публичный Метод

Returns the max score of the results found
public getMaxScore ( ) : float
Результат float Max Score

getQuery() публичный Метод

Returns the original \Elastica\Query instance
public getQuery ( ) : Query
Результат Elastica\Query

getResponse() публичный Метод

Returns response object
public getResponse ( ) : Response
Результат Elastica\Response Response object

getResults() публичный Метод

Returns all results
public getResults ( ) : Result[]
Результат Result[] Results

getSuggests() публичный Метод

Return all suggests
public getSuggests ( ) : array
Результат array suggest results

getTotalHits() публичный Метод

Returns the total number of found hits
public getTotalHits ( ) : integer
Результат integer Total hits

getTotalTime() публичный Метод

Returns the total number of ms for this search to complete
public getTotalTime ( ) : integer
Результат integer Total time

hasFacets() публичный Метод

Returns whether facets exist
public hasFacets ( ) : boolean
Результат boolean Facet existence

hasSuggests() публичный Метод

Returns true if the response contains suggestion results; false otherwise
public hasSuggests ( ) : boolean
Результат boolean

hasTimedOut() публичный Метод

Returns true if the query has timed out
public hasTimedOut ( ) : boolean
Результат boolean Timed out

Описание свойств

$embeds защищенное свойство

Embedded type references
protected array $embeds
Результат array

$entityClass защищенное свойство

The full class name of the document class to wrap the results
protected Document,Cake\ElasticSearch $entityClass
Результат Document

$repoName защищенное свойство

Name of the type that the originating query came from.
protected string $repoName
Результат string

$resultSet защищенное свойство

Holds the original instance of the result set
protected string $resultSet
Результат string