PHP Класс Elastica\IndexTemplate

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

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

Свойство Тип Описание
$_client Client object.
$_name Index template name.

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

Метод Описание
__construct ( Client $client, string $name ) Creates a new index template object.
create ( array $args = [] ) : Response Creates a new index template with the given arguments.
delete ( ) : Response Deletes the index template.
exists ( ) : boolean Checks if the given index template is already created.
getClient ( ) : Client Returns index template client.
getName ( ) : string Returns the index template name.
request ( string $method, array $data = [] ) : Response Makes calls to the elasticsearch server based on this index template name.

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

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

Creates a new index template object.
public __construct ( Client $client, string $name )
$client Client Client object
$name string Index template name

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

Creates a new index template with the given arguments.
public create ( array $args = [] ) : Response
$args array OPTIONAL Arguments to use
Результат Response

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

Deletes the index template.
public delete ( ) : Response
Результат Response Response object

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

Checks if the given index template is already created.
public exists ( ) : boolean
Результат boolean True if index exists

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

Returns index template client.
public getClient ( ) : Client
Результат Client Index client object

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

Returns the index template name.
public getName ( ) : string
Результат string Index name

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

Makes calls to the elasticsearch server based on this index template name.
public request ( string $method, array $data = [] ) : Response
$method string Rest method to use (GET, POST, DELETE, PUT)
$data array OPTIONAL Arguments as array
Результат Response Response object

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

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

Client object.
protected $_client

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

Index template name.
protected $_name