PHP Class Aerospike\LDT\LList

See link: http://www.aerospike.com/docs/guide/llist.html
Author: Ronen Botzer ([email protected])
Inheritance: extends LDT
Show file Open project: aerospike/aerospike-client-php

Public Methods

Method Description
__construct ( Aerospike $client, array $key, string $bin ) Constructor for the \Aerospike\LDT\LList class.
add ( integer | string | array $value ) : integer Adds a value of a supported type to the LList.
addMany ( array $values ) : integer Adds values of a supported type to the LList.
exists ( integer | string $value, boolean &$res ) : integer Finds whether any elements match the given value in the LList.
existsMany ( array $values ) : integer Finds whether any elements match a list of values.
find ( integer | string $value, array &$elements, string | null $module = null, string | null $function = null, array $args = [] ) : integer Finds the elements matching the given value in the LList.
findFirst ( integer $count, array &$elements, string | null $module = null, string | null $function = null, array $args = [] ) : integer Finds the first N elements in the LList.
findLast ( integer $count, array &$elements, string | null $module = null, string | null $function = null, array $args = [] ) : integer Finds the lasst N elements in the LList.
findRange ( integer | string | null $min, integer | string | null $max, array &$elements, string | null $module = null, string | null $function = null, array $args = [] ) : integer Finds the elements whose key is between min and max.
remove ( integer | string $value ) : integer Find and remove an element matching the given value in the LList.
removeMany ( array $values ) : integer Removes several elements in the LList, the plural of remove().
removeRange ( integer | string | null $min = null, integer | string | null $max = null ) : integer Find and remove the elements from the LList matching a given range.
scan ( array &$elements, string | null $module = null, string | null $function = null, array $args = [] ) : integer Returns the elements in the LList
update ( integer | string | array $value ) : integer Inserts a new element into the LList or replaces the matching one.
updateMany ( array $values ) : integer Updates several elements in the LList, the plural of update().

Method Details

__construct() public method

Constructor for the \Aerospike\LDT\LList class.
See also: LDT::__construct()
public __construct ( Aerospike $client, array $key, string $bin )
$client Aerospike
$key array initialized with Aerospike::initKey()
$bin string name

add() public method

The elements added must be consistently the same type (string, integer, array).
public add ( integer | string | array $value ) : integer
$value integer | string | array
return integer status code of the operation

addMany() public method

The elements added must be consistently the same type (string, integer, array).
public addMany ( array $values ) : integer
$values array
return integer status code of the operation

exists() public method

Atomic elements (integer, string) will be directly compared. In complex types (array) the value of a key named 'key' is used for comparison.
public exists ( integer | string $value, boolean &$res ) : integer
$value integer | string
$res boolean
return integer status code of the operation

existsMany() public method

The elements checked must be consistently the same type (string, integer, array).
public existsMany ( array $values ) : integer
$values array
return integer status code of the operation

find() public method

Atomic elements (integer, string) will be directly compared. In complex types (array) the value of a key named 'key' is used for comparison. An optional UDF filter function can be applied to the elements found. The filter function returns nil to filter out the element, otherwise it may transform the element before returning it.
public find ( integer | string $value, array &$elements, string | null $module = null, string | null $function = null, array $args = [] ) : integer
$value integer | string
$elements array matched
$module string | null the name of the UDF module containing the optional filter function
$function string | null name of the UDF filter function to apply
$args array optional arguments for the filter function, passed as a map to the filter function
return integer status code of the operation

findFirst() public method

An optional UDF filter function can be applied to the elements found. The filter function returns nil to filter out the element, otherwise it may transform the element before returning it.
public findFirst ( integer $count, array &$elements, string | null $module = null, string | null $function = null, array $args = [] ) : integer
$count integer
$elements array matched
$module string | null the name of the UDF module containing the optional filter function
$function string | null name of the UDF filter function to apply
$args array optional arguments for the filter function, passed as a map to the filter function
return integer status code of the operation

findLast() public method

An optional UDF filter function can be applied to the elements found. The filter function returns nil to filter out the element, otherwise it may transform the element before returning it.
public findLast ( integer $count, array &$elements, string | null $module = null, string | null $function = null, array $args = [] ) : integer
$count integer
$elements array matched
$module string | null the name of the UDF module containing the optional filter function
$function string | null name of the UDF filter function to apply
$args array optional arguments for the filter function, passed as a map to the filter function
return integer status code of the operation

findRange() public method

A null $min gets all elements less than or equal to $max. A null $max gets all elements greater than or equal to $min. An optional UDF filter function can be applied to the elements found. The filter function returns nil to filter out the element, otherwise it may transform the element before returning it.
public findRange ( integer | string | null $min, integer | string | null $max, array &$elements, string | null $module = null, string | null $function = null, array $args = [] ) : integer
$min integer | string | null
$max integer | string | null
$elements array matched
$module string | null the name of the UDF module containing the optional filter function
$function string | null name of the UDF filter function to apply
$args array optional arguments for the filter function, passed as a map to the filter function
return integer status code of the operation

remove() public method

Atomic elements (integer, string) will be directly compared. In complex types (array) the value of a key named 'key' is used to identify the element which is to be removed.
public remove ( integer | string $value ) : integer
$value integer | string
return integer status code of the operation

removeMany() public method

The elements removed must be consistently the same type (string, integer, array).
public removeMany ( array $values ) : integer
$values array
return integer status code of the operation

removeRange() public method

Atomic elements (integer, string) will be directly compared. In complex types (array) the value of a key named 'key' is used to identify the elements which are to be removed. A null $min gets all elements less than or equal to $max. A null $max gets all elements greater than or equal to $min.
public removeRange ( integer | string | null $min = null, integer | string | null $max = null ) : integer
$min integer | string | null
$max integer | string | null
return integer status code of the operation

scan() public method

An optional UDF filter function can be applied to the elements found. The filter function returns nil to filter out the element, otherwise it may transform the element before returning it.
public scan ( array &$elements, string | null $module = null, string | null $function = null, array $args = [] ) : integer
$elements array returned
$module string | null the name of the UDF module containing the optional filter function
$function string | null name of the UDF filter function to apply
$args array optional arguments for the filter function, passed as a map to the filter function
return integer status code of the operation

update() public method

The elements must be consistently the same type (string, integer, array).
public update ( integer | string | array $value ) : integer
$value integer | string | array
return integer status code of the operation

updateMany() public method

The elements updated must be consistently the same type (string, integer, array).
public updateMany ( array $values ) : integer
$values array
return integer status code of the operation