PHP Class Elastica\Index\Stats

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-stats.html

Author: Nicolas Ruflin ([email protected])

Show file Open project: ruflin/elastica

Protected Properties

Property	Type	Description
$_data		Stats info.
$_index		Index.
$_response		Response.

Public Methods

Method	Description
__construct ( Index $index )	Construct.
get ( ) : mixed	Returns the entry in the data array based on the params.
getData ( ) : array	Returns the raw stats info.
getIndex ( ) : Index	Returns the index object.
getResponse ( ) : Response	Returns response object.
refresh ( )	Reloads all status data of this object.

Method Details

__construct() public method

Construct.

public __construct ( Index $index )
$index	Elastica\Index	Index object

get() public method

Various params possible.

public get ( ) : mixed
return	mixed	Data array entry or null if not found

getData() public method

Returns the raw stats info.

public getData ( ) : array
return	array	Stats info

getIndex() public method

Returns the index object.

public getIndex ( ) : Index
return	Elastica\Index	Index object

getResponse() public method

Returns response object.

public getResponse ( ) : Response
return	Elastica\Response	Response object

refresh() public method

Reloads all status data of this object.

public refresh ( )

Property Details

$_data protected property

Stats info.

protected $_data

$_index protected property

Index.

protected $_index

$_response protected property

Response.

protected $_response