PHP Класс Elastica\Cluster\Settings

Автор: Nicolas Ruflin ([email protected])

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

Свойство	Тип	Описание
$_client		Client object

Метод	Описание
__construct ( Client $client )	Creates a cluster object.
get ( ) : array	Returns settings data.
getClient ( ) : Client	Get the client.
getPersistent ( string $setting = '' ) : array \| string \| null	Returns the current persistent settings of the cluster.
getTransient ( string $setting = '' ) : array \| string \| null	Returns the current transient settings of the cluster.
request ( array $data = [], string $method = Request::GET ) : Response	Sends settings request.
set ( array $settings ) : Response	Set settings for cluster.
setPersistent ( string $key, string $value ) : Response	Sets persistent setting.
setReadOnly ( boolean $readOnly = true, boolean $persistent = false ) : Response	Sets the cluster to read only.
setTransient ( string $key, string $value ) : Response	Sets transient settings.

Creates a cluster object.

public __construct ( Client $client )
$client	Elastica\Client	Connection client object

Returns settings data.

public get ( ) : array
Результат	array	Settings data (persistent and transient)

Get the client.

public getClient ( ) : Client
Результат	Elastica\Client

If param is set, only specified setting is return.

public getPersistent ( string $setting = '' ) : array \| string \| null
$setting	string	OPTIONAL Setting name to return
Результат	array \| string \| null	Settings data

If param is set, only specified setting is return.

public getTransient ( string $setting = '' ) : array \| string \| null
$setting	string	OPTIONAL Setting name to return
Результат	array \| string \| null	Settings data

Sends settings request.

public request ( array $data = [], string $method = Request::GET ) : Response
$data	array	OPTIONAL Data array
$method	string	OPTIONAL Transfer method (default = \Elastica\Request::GET)
Результат	Elastica\Response	Response object

Set settings for cluster.

public set ( array $settings ) : Response
$settings	array	Raw settings (including persistent or transient)
Результат	Elastica\Response

Sets persistent setting.

public setPersistent ( string $key, string $value ) : Response
$key	string
$value	string
Результат	Elastica\Response

Second param can be used to set it persistent

public setReadOnly ( boolean $readOnly = true, boolean $persistent = false ) : Response
$readOnly	boolean
$persistent	boolean
Результат	Elastica\Response	$response

Sets transient settings.

public setTransient ( string $key, string $value ) : Response
$key	string
$value	string
Результат	Elastica\Response

Client object

protected $_client