PHP Класс Elastica\Status

Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$_client Client object.
$_data Data.
$_response Contains all status infos.

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

Метод Описание
__construct ( Client $client ) Constructs Status object.
aliasExists ( string $name ) : boolean Checks if the given alias exists.
getData ( ) : array Returns status data.
getIndexNames ( ) : array Returns a list of the existing index names.
getIndicesWithAlias ( string $alias ) : array | Index[] Returns an array with all indices that the given alias name points to.
getResponse ( ) : Response Returns response object.
getShards ( ) : array Return shards info.
indexExists ( string $name ) : boolean Checks if the given index exists.
refresh ( ) Refresh status object.

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

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

Constructs Status object.
public __construct ( Client $client )
$client Client Client object

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

Checks if the given alias exists.
public aliasExists ( string $name ) : boolean
$name string Alias name
Результат boolean True if alias exists

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

Returns status data.
public getData ( ) : array
Результат array Status data

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

Returns a list of the existing index names.
public getIndexNames ( ) : array
Результат array Index names list

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

Returns an array with all indices that the given alias name points to.
public getIndicesWithAlias ( string $alias ) : array | Index[]
$alias string Alias name
Результат array | Index[] List of Elastica\Index

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

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

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

Return shards info.
public getShards ( ) : array
Результат array Shards info

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

Checks if the given index exists.
public indexExists ( string $name ) : boolean
$name string Index name to check
Результат boolean True if index exists

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

Refresh status object.
public refresh ( )

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

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

Client object.
protected $_client

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

Data.
protected $_data

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

Contains all status infos.
protected $_response