PHP Класс LinkORB\Component\Etcd\Client

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

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

Метод Описание
__construct ( $server = '', $version = 'v2' )
doRequest ( string $uri ) : mixed Do a server request
get ( string $key, array $flags = null ) : string Retrieve the value of a key
getKeysValue ( $root = '/', boolean $recursive = true, string $key = null ) : array Get all key-value pair that the key is not directory.
getNode ( string $key, array $flags = null ) : array Retrieve the value of a key
listDir ( string $key = '/', boolean $recursive = false ) : mixed Retrieve a directory
ls ( string $key = '/', boolean $recursive = false ) : array Retrieve a directories key
mk ( string $key, string $value, integer $ttl ) : array make a new key with a given value
mkdir ( string $key, integer $ttl ) : array make a new directory
mkdirWithInOrderKey ( string $dir, integer $ttl ) : array create a new directory with auto generated id
rm ( string $key ) : array | stdClas\stdClass remove a key
rmdir ( string $key, boolean $recursive = false ) : mixed Removes the key if it is directory
set ( string $key, string $value, integer $ttl = null, array $condition = [] ) : stdClass Set the value of a key
setRoot ( string $root ) : Client Set the default root directory. the default is / If the root is others e.g. /linkorb when you set new key, or set dir, all of the key is under the root e.g.
setWithInOrderKey ( string $dir, string $value, integer $ttl, array $condition = [] ) : array create a new key in a directory with auto generated id
update ( strint $key, string $value, integer $ttl, array $condition = [] ) : array Update an existing key with a given value.
updateDir ( string $key, integer $ttl ) : array Update directory

Приватные методы

Метод Описание
buildKeyUri ( string $key ) : string Build key space operations
traversalDir ( RecursiveArrayIterator $iterator ) : array Traversal the directory to get the keys.

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

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

public __construct ( $server = '', $version = 'v2' )

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

Do a server request
public doRequest ( string $uri ) : mixed
$uri string
Результат mixed

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

Retrieve the value of a key
public get ( string $key, array $flags = null ) : string
$key string
$flags array the extra query params
Результат string the value of the key.

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

Get all key-value pair that the key is not directory.
public getKeysValue ( $root = '/', boolean $recursive = true, string $key = null ) : array
$recursive boolean
$key string
Результат array

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

Retrieve the value of a key
public getNode ( string $key, array $flags = null ) : array
$key string
$flags array the extra query params
Результат array

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

Retrieve a directory
public listDir ( string $key = '/', boolean $recursive = false ) : mixed
$key string
$recursive boolean
Результат mixed

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

Retrieve a directories key
public ls ( string $key = '/', boolean $recursive = false ) : array
$key string
$recursive boolean
Результат array

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

make a new key with a given value
public mk ( string $key, string $value, integer $ttl ) : array
$key string
$value string
$ttl integer
Результат array $body

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

make a new directory
public mkdir ( string $key, integer $ttl ) : array
$key string
$ttl integer
Результат array $body

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

create a new directory with auto generated id
public mkdirWithInOrderKey ( string $dir, integer $ttl ) : array
$dir string
$ttl integer
Результат array $body

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

remove a key
public rm ( string $key ) : array | stdClas\stdClass
$key string
Результат array | stdClas\stdClass

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

Removes the key if it is directory
public rmdir ( string $key, boolean $recursive = false ) : mixed
$key string
$recursive boolean
Результат mixed

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

Set the value of a key
public set ( string $key, string $value, integer $ttl = null, array $condition = [] ) : stdClass
$key string
$value string
$ttl integer
$condition array
Результат stdClass

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

$client->setRoot('/linkorb'); $client->set('key1, 'value1'); the new key is /linkorb/key1
public setRoot ( string $root ) : Client
$root string
Результат Client

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

create a new key in a directory with auto generated id
public setWithInOrderKey ( string $dir, string $value, integer $ttl, array $condition = [] ) : array
$dir string
$value string
$ttl integer
$condition array
Результат array $body

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

Update an existing key with a given value.
public update ( strint $key, string $value, integer $ttl, array $condition = [] ) : array
$key strint
$value string
$ttl integer
$condition array The extra condition for updating
Результат array $body

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

Update directory
public updateDir ( string $key, integer $ttl ) : array
$key string
$ttl integer
Результат array $body