PHP Класс Aerospike\LDT\LDT

См. ссылку: http://www.aerospike.com/docs/guide/ldt.html
Автор: Ronen Botzer ([email protected])
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$bin string The name of the bin within the recod that is an LDT
$client Aerospike The Aerospike client instance
$error string The error message for the last operation
$errorno integer The status code for the last operation
$key string The key for the record containing the LDT
$module string The name of the UDF module providing the functionality that this class wraps around
$type string The type of LDT at the bin

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

Метод Описание
config ( array &$config ) : integer Retrieves the LDT configuration data.
destroy ( ) : integer Destroy the LDT at the key and bin the class was initialized to.
error ( ) : string Returns the error message for the previous operation.
errorno ( ) : integer Returns the status code for the previous operation.
isLDT ( ) : boolean Checks whether there actually is an LDT at the key and bin the class was initialized with.
isValid ( ) : boolean Validates whether the LDT at the specified key and bin is in good shape
setPageSize ( integer $size ) : integer Set the page size of the LDT
size ( integer &$num_elements ) : integer Sets $num_elements with the number of elements in the LDT.

Защищенные методы

Метод Описание
__construct ( Aerospike $client, array $key, string $bin, integer $type ) Constructor for the abstract \Aerospike\LDT class. Inherited by LDT types.
processStatusCode ( integer $status ) Process the operation status code into error number and message

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

Метод Описание
getModuleName ( ) : string Finds the name of the UDF module providing the functionality needed by the given LDT

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

__construct() защищенный метод

Constructor for the abstract \Aerospike\LDT class. Inherited by LDT types.
См. также: errorno()
См. также: error()
protected __construct ( Aerospike $client, array $key, string $bin, integer $type )
$client Aerospike
$key array initialized with Aerospike::initKey()
$bin string name
$type integer of the LDT

config() публичный метод

Retrieves the LDT configuration data.
public config ( array &$config ) : integer
$config array will be updated with the configuration data
Результат integer status code of the operation

destroy() публичный метод

Destroy the LDT at the key and bin the class was initialized to.
public destroy ( ) : integer
Результат integer status code of the operation

error() публичный метод

Returns the error message for the previous operation.
public error ( ) : string
Результат string

errorno() публичный метод

Returns the status code for the previous operation.
public errorno ( ) : integer
Результат integer

isLDT() публичный метод

Checks whether there actually is an LDT at the key and bin the class was initialized with.
public isLDT ( ) : boolean
Результат boolean

isValid() публичный метод

Validates whether the LDT at the specified key and bin is in good shape
public isValid ( ) : boolean
Результат boolean

processStatusCode() защищенный метод

Process the operation status code into error number and message
protected processStatusCode ( integer $status )
$status integer code of the operation

setPageSize() публичный метод

Set the page size of the LDT
public setPageSize ( integer $size ) : integer
$size integer
Результат integer status code of the operation

size() публичный метод

Sets $num_elements with the number of elements in the LDT.
public size ( integer &$num_elements ) : integer
$num_elements integer returned
Результат integer status code of the operation

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

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

The name of the bin within the recod that is an LDT
protected string $bin
Результат string

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

The Aerospike client instance
protected Aerospike $client
Результат Aerospike

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

The error message for the last operation
См. также: LDT::error()
protected string $error
Результат string

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

The status code for the last operation
См. также: LDT::errorno()
protected int $errorno
Результат integer

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

The key for the record containing the LDT
protected string $key
Результат string

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

The name of the UDF module providing the functionality that this class wraps around
protected string $module
Результат string

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

The type of LDT at the bin
protected string $type
Результат string