PHP 클래스 Cake\ElasticSearch\ResultSet

상속: extends IteratorIterato\IteratorIterator, implements Countabl\Countable, implements JsonSerializabl\JsonSerializable, use trait Cake\Collection\CollectionTrait
파일 보기 프로젝트 열기: cakephp/elastic-search

보호된 프로퍼티들

프로퍼티 타입 설명
$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