PHP Class Sleimanx2\Plastic\PlasticResult

ファイルを表示 Open project: sleimanx2/plastic Class Usage Examples

Protected Properties

Property 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.

Public Methods

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

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

aggregations() public method

Get the raw hits array from Elasticsearch results.
public aggregations ( ) : array
return array

hits() public method

Get the raw hits array from Elasticsearch results.
public hits ( ) : array
return array

maxScore() public method

Max Score.
public maxScore ( ) : float
return float

setHits() public method

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

shards() public method

Get Shards.
public shards ( ) : array
return array

timedOut() public method

Timed Out.
public timedOut ( ) : boolean
return boolean

took() public method

Took.
public took ( ) : string
return string

totalHits() public method

Total Hits.
public totalHits ( ) : integer
return integer

Property Details

$aggregations protected_oe property

The aggregations result.
protected array|null $aggregations
return 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