TokyoTyrant::add

Adds to a numeric key

Description

public number TokyoTyrant::add ( string $key , number $increment [, int $type = 0 ] )

Adds to an int or double value. This increments the value by the given amount and returns the new value. If the key does not exist a new key is created with initial value of the increment parameter.

Parameters

key

The string key

increment

The amount to increment

type

TokyoTyrant::RDBREC_INT or TokyoTyrant::RDBREC_DBL constant. If this parameter is omitted the type is guessed from the increment parameters type.

Return Values

Returns the new value on success

Examples

Example #1 TokyoTyrant::add example

<?php
$tt 
= new TokyoTyrant("localhost"TokyoTyrant::RDBDEF_PORT);
/* Adds integer 3 to key and creates a new key */
$tt->add("test"3);

/* String value is converted to double */
echo $tt->add("test""3.5"TokyoTyrant::RDBREC_DBL);
?>

The above example will output something similar to:

6.5

See Also

  • TokyoTyrant::put
  • TokyoTyrant::putcat
  • TokyoTyrant::putkeep