PHP Class Aerospike\LDT\LDT

See link: http://www.aerospike.com/docs/guide/ldt.html

Author: Ronen Botzer ([email protected])

Afficher le fichier Open project: aerospike/aerospike-client-php Class Usage Examples

Protected Properties

Свойство	Type	Description
$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

Méthodes publiques

Méthode	Description
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.

Méthodes protégées

Méthode	Description
__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

Private Methods

Méthode	Description
getModuleName ( ) : string	Finds the name of the UDF module providing the functionality needed by the given LDT

Method Details

__construct() protected méthode

Constructor for the abstract \Aerospike\LDT class. Inherited by LDT types.

config() public méthode

Retrieves the LDT configuration data.

public config ( array &$config ) : integer
$config	array	will be updated with the configuration data
Résultat	integer	status code of the operation

destroy() public méthode

Destroy the LDT at the key and bin the class was initialized to.

public destroy ( ) : integer
Résultat	integer	status code of the operation

error() public méthode

Returns the error message for the previous operation.

public error ( ) : string
Résultat	string

errorno() public méthode

Returns the status code for the previous operation.

public errorno ( ) : integer
Résultat	integer

isLDT() public méthode

Checks whether there actually is an LDT at the key and bin the class was initialized with.

public isLDT ( ) : boolean
Résultat	boolean

isValid() public méthode

Validates whether the LDT at the specified key and bin is in good shape

public isValid ( ) : boolean
Résultat	boolean

processStatusCode() protected méthode

Process the operation status code into error number and message

protected processStatusCode ( integer $status )
$status	integer	code of the operation

setPageSize() public méthode

Set the page size of the LDT

public setPageSize ( integer $size ) : integer
$size	integer
Résultat	integer	status code of the operation

size() public méthode

Sets $num_elements with the number of elements in the LDT.

public size ( integer &$num_elements ) : integer
$num_elements	integer	returned
Résultat	integer	status code of the operation

Property Details

$bin protected_oe property

The name of the bin within the recod that is an LDT

protected string $bin
Résultat	string

$client protected_oe property

The Aerospike client instance

protected Aerospike $client
Résultat	Aerospike

$error protected_oe property

The error message for the last operation

$errorno protected_oe property

The status code for the last operation

$key protected_oe property

The key for the record containing the LDT

protected string $key
Résultat	string

$module protected_oe property

The name of the UDF module providing the functionality that this class wraps around

protected string $module
Résultat	string

$type protected_oe property

The type of LDT at the bin

protected string $type
Résultat	string

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