PHP Class MongoHybrid\Client

Show file Open project: sjardim/Hugopit

Protected Properties

Property Type Description
$driver

Public Methods

Method Description
__call ( $method, $args )
__construct ( $server, $options = [] )
decrKey ( string $collection, string $key, integer $by = 1 ) : integer Decrement value by x
dropCollection ( $name, $db = null )
getKey ( string $collection, string $key, mixed $default = null ) : mixed Get value for specific key
hdel ( string $key ) : integer Delete one or more hash fields
hexists ( string $collection, string $key, string $field ) : boolean Determine if a hash field exists
hget ( string $collection, string $key, string $field, mixed $default = null ) : mixed Get the value of a hash field
hgetall ( string $key ) : array Get all the fields and values in a hash
hincrby ( $collection, string $key, string $field, integer $by = 1 ) : integer Increment the integer value of a hash field by the given number
hkeys ( string $key ) : array Get all the fields in a hash
hlen ( string $key ) : integer Get the number of fields in a hash
hmget ( string $key ) : array Get the values of all the given hash fields
hmset ( string $key ) Set multiple hash fields to multiple values
hset ( string $collection, string $key, string $field, mixed $value ) Set the string value of a hash field
hvals ( string $key ) : array Get all the values in a hash
incrKey ( string $collection, string $key, integer $by = 1 ) : integer Increment value by x
insert ( $collection, &$doc )
keyExists ( string $collection, string $key ) Check if key exists
lindex ( string $collection, string $key, integer $index ) : mixed Get an element from a list by its index
lpush ( string $collection, string $key, mixed $value ) : integer Add item to a value (left)
lset ( string $collection, string $key, integer $index, mixed $value ) : boolean Set the value of an element in a list by its index
removeKey ( string $collection, string $key ) : integer Delete Key(s)
renameCollection ( $newname, $db = null )
rpush ( string $collection, string $key, mixed $value ) : integer Add item to a value (right)
save ( $collection, &$data )
setKey ( string $collection, string $key, mixed $value ) Set value for specific key

Method Details

__call() public method

public __call ( $method, $args )

__construct() public method

public __construct ( $server, $options = [] )

decrKey() public method

Decrement value by x
public decrKey ( string $collection, string $key, integer $by = 1 ) : integer
$collection string
$key string
$by integer
return integer

dropCollection() public method

public dropCollection ( $name, $db = null )

getKey() public method

Get value for specific key
public getKey ( string $collection, string $key, mixed $default = null ) : mixed
$collection string
$key string
$default mixed
return mixed

hdel() public method

Delete one or more hash fields
public hdel ( string $key ) : integer
$key string
return integer

hexists() public method

Determine if a hash field exists
public hexists ( string $collection, string $key, string $field ) : boolean
$collection string
$key string
$field string
return boolean

hget() public method

Get the value of a hash field
public hget ( string $collection, string $key, string $field, mixed $default = null ) : mixed
$collection string
$key string
$field string
$default mixed
return mixed

hgetall() public method

Get all the fields and values in a hash
public hgetall ( string $key ) : array
$key string
return array

hincrby() public method

Increment the integer value of a hash field by the given number
public hincrby ( $collection, string $key, string $field, integer $by = 1 ) : integer
$key string
$field string
$by integer
return integer

hkeys() public method

Get all the fields in a hash
public hkeys ( string $key ) : array
$key string
return array

hlen() public method

Get the number of fields in a hash
public hlen ( string $key ) : integer
$key string
return integer

hmget() public method

Get the values of all the given hash fields
public hmget ( string $key ) : array
$key string
return array

hmset() public method

Set multiple hash fields to multiple values
public hmset ( string $key )
$key string

hset() public method

Set the string value of a hash field
public hset ( string $collection, string $key, string $field, mixed $value )
$collection string
$key string
$field string
$value mixed

hvals() public method

Get all the values in a hash
public hvals ( string $key ) : array
$key string
return array

incrKey() public method

Increment value by x
public incrKey ( string $collection, string $key, integer $by = 1 ) : integer
$collection string
$key string
$by integer
return integer

insert() public method

public insert ( $collection, &$doc )

keyExists() public method

Check if key exists
public keyExists ( string $collection, string $key )
$collection string @param string $collection
$key string

lindex() public method

Get an element from a list by its index
public lindex ( string $collection, string $key, integer $index ) : mixed
$collection string
$key string
$index integer
return mixed

lpush() public method

Add item to a value (left)
public lpush ( string $collection, string $key, mixed $value ) : integer
$collection string @param string $collection
$key string
$value mixed
return integer

lset() public method

Set the value of an element in a list by its index
public lset ( string $collection, string $key, integer $index, mixed $value ) : boolean
$collection string
$key string
$index integer
$value mixed
return boolean

removeKey() public method

Delete Key(s)
public removeKey ( string $collection, string $key ) : integer
$collection string
$key string
return integer

renameCollection() public method

public renameCollection ( $newname, $db = null )

rpush() public method

Add item to a value (right)
public rpush ( string $collection, string $key, mixed $value ) : integer
$collection string @param string $collection
$key string
$value mixed
return integer

save() public method

public save ( $collection, &$data )

setKey() public method

Set value for specific key
public setKey ( string $collection, string $key, mixed $value )
$collection string
$key string
$value mixed

Property Details

$driver protected property

protected $driver