PHP Class Sleimanx2\Plastic\PlasticResult

Afficher le fichier Open project: sleimanx2/plastic Class Usage Examples

Protected Properties

Свойство Type Description
$aggregations array | null The aggregations result.
$hits Result of the query.
$maxScore Highest document score.
$shards
$timed_out Check if the query timed out.
$took Time needed to execute the query.
$totalHits Total number of hits.

Méthodes publiques

Méthode Description
__construct ( array $results ) _construct.
aggregations ( ) : array Get aggregations.
hits ( ) : array Get Hits.
maxScore ( ) : float Max Score.
setHits ( $values ) Set the hits value.
shards ( ) : array Get Shards.
timedOut ( ) : boolean Timed Out.
took ( ) : string Took.
totalHits ( ) : integer Total Hits.

Method Details

__construct() public méthode

_construct.
public __construct ( array $results )
$results array

aggregations() public méthode

Get the raw hits array from Elasticsearch results.
public aggregations ( ) : array
Résultat array

hits() public méthode

Get the raw hits array from Elasticsearch results.
public hits ( ) : array
Résultat array

maxScore() public méthode

Max Score.
public maxScore ( ) : float
Résultat float

setHits() public méthode

Set the hits value.
public setHits ( $values )
$values

shards() public méthode

Get Shards.
public shards ( ) : array
Résultat array

timedOut() public méthode

Timed Out.
public timedOut ( ) : boolean
Résultat boolean

took() public méthode

Took.
public took ( ) : string
Résultat string

totalHits() public méthode

Total Hits.
public totalHits ( ) : integer
Résultat integer

Property Details

$aggregations protected_oe property

The aggregations result.
protected array|null $aggregations
Résultat array | null

$hits protected_oe property

Result of the query.
protected $hits

$maxScore protected_oe property

Highest document score.
protected $maxScore

$shards protected_oe property

protected $shards

$timed_out protected_oe property

Check if the query timed out.
protected $timed_out

$took protected_oe property

Time needed to execute the query.
protected $took

$totalHits protected_oe property

Total number of hits.
protected $totalHits