\phpredis

Summary

Methods

Properties

Constants

__construct()
ping()
setOption()
getOption()
set()
get()
delete()
exists()
deinc()
mset()
ttl()
persist()
strlen()
listPush()
listPop()
listSize()
listSet()
listGet()
listTrim()
listRemove()
listInsert()
rpoplpush()
setAdd()
setMove()
setSearch()
setSize()
setPop()
setInter()
setUnion()
setDiff()
setMembers()
setSort()
setRange()
setDeleteRange()
setScore()
hashSet()
hashGet()
hashLen()
hashDel()
hashExists()
hashInc()
setKeyExpire()
getKeys()
hwSave()
lastSave()
info()
dbSize()
tranStart()
tranCommit()
tranRollback()

$_REDIS

No constants found

No protected methods found

No protected properties found

N/A

connect()

$_HOST
$_PORT
$_TIMEOUT
$_DBNAME
$_CTYPE
$_CAUTH
$_TRANSCATION

N/A

File: application/library/phpredis.php
Package: Default
Class hierarchy: \phpredis

Properties

$_REDIS

$_REDIS :

Type

$_HOST

$_HOST :

Type

$_PORT

$_PORT :

Type

$_TIMEOUT

$_TIMEOUT :

Type

$_DBNAME

$_DBNAME :

Type

$_CTYPE

$_CTYPE :

Type

$_CAUTH

$_CAUTH :

Type

$_TRANSCATION

$_TRANSCATION :

Type

Methods

__construct()

__construct(  $rconfig = '')

Parameters

$rconfig

ping()

ping() : \$return

查看redis连接是否断开

Returns

\$return —

bool true:连接未断开 false:连接已断开

setOption()

setOption(  $option = array()) : \$return

设置redis模式参数

Parameters

$option

array 参数数组键值对

Returns

\$return —

true/false

getOption()

getOption(  $option = array())

获取redis模式参数

Parameters

$option

array 要获取的参数数组

set()

set(  $key,   $value,   $type,   $repeat,   $time,   $old) : \$return

写入key-value

Parameters

	$key	string 要存储的key名
	$value	mixed 要存储的值
	$type	int 写入方式 0:不添加到现有值后面 1:添加到现有值的后面默认0
	$repeat	int 0:不判断重复 1:判断重复
	$time	float 过期时间(S)
	$old	int 1:返回旧的value 默认0

Returns

\$return —

bool true:成功 flase:失败

get()

get(  $key = null,   $start = null,   $end = null) : \$return

获取某个key值如果指定了start end 则返回key值的start跟end之间的字符

Parameters

	$key	string/array 要获取的key或者key数组
	$start	int 字符串开始index
	$end	int 字符串结束index

Returns

\$return —

mixed 如果key存在则返回key值如果不存在返回false

delete()

delete(  $key = array()) : \$return

删除某个key值

Parameters

$key

array key数组

Returns

\$return —

longint 删除成功的key的个数

exists()

exists(  $key)

判断某个key是否存在

Parameters

$key

string 要查询的key名

deinc()

deinc(  $key,   $type = 1,   $n = 1)

key值自增或者自减

Parameters

	$key	string key名
	$type	int 0:自减 1:自增默认为1
	$n	int 自增步长默认为1

mset()

mset(  $data)

同时给多个key赋值

Parameters

$data

array key值数组 array('key0'=>'value0','key1'=>'value1')

ttl()

ttl(  $key)

查询某个key的生存时间

Parameters

$key

string 要查询的key名

persist()

persist(  $key)

删除到期的key

Parameters

$key

string key名

strlen()

strlen(  $key)

获取某一key的value

Parameters

$key

string key名

listPush()

listPush(  $list,   $value,   $direction,   $repeat)

入队列

Parameters

	$list	string 队列名
	$value	mixed 入队元素值
	$direction
	$repeat	int 判断value是否存在 0:不判断存在 1:判断存在如果value存在则不入队列

listPop()

listPop(  $list1,   $deriction,   $list2 = null,   $timeout)

出队列

Parameters

	$list1	string 队列名
	$deriction	int 0:数据入队列头(左) 1:数据入队列尾(右) 默认为0
	$list2	string 第二个队列名默认null
	$timeout	int timeout为0:只获取list1队列的数据 timeout>0:如果队列list1为空则等待timeout秒如果还是未获取到数据则对list2队列执行pop操作

listSize()

listSize(  $list)

获取队列中元素数

Parameters

$list

string 队列名

listSet()

listSet(  $list,   $index,   $value = null)

为list队列的index位置的元素赋值

Parameters

	$list	string 队列名
	$index	int 队列元素位置
	$value	mixed 元素值

listGet()

listGet(  $list,   $index,   $end = null)

获取list队列的index位置的元素值

Parameters

	$list	string 队列名
	$index	int 队列元素开始位置默认0
	$end	int 队列元素结束位置 $index=0,$end=-1:返回队列所有元素

listTrim()

listTrim(  $list,   $start,   $end = -1)

截取list队列，保留start至end之间的元素

Parameters

	$list	string 队列名
	$start	int 开始位置
	$end	int 结束位置

listRemove()

listRemove(  $list,   $value,   $count)

删除list队列中count个值为value的元素

Parameters

	$list	string 队列名
	$value	int 元素值
	$count	int 删除个数 0:删除所有 >0:从头部开始删除 <0:从尾部开始删除默认为0删除所有

listInsert()

listInsert(  $list,   $location,   $value1,   $value2)

在list中值为$value1的元素前Redis::BEFORE或者后Redis::AFTER插入值为$value2的元素如果list不存在，不会插入，如果$value1不存在，return -1

Parameters

	$list	string 队列名
	$location	int 插入位置 0:之前 1:之后
	$value1	mixed 要查找的元素值
	$value2	mixed 要插入的元素值

rpoplpush()

rpoplpush(  $list1,   $list2)

pop出list1的尾部元素并将该元素push入list2的头部

Parameters

	$list1	string 队列名
	$list2	string 队列名

setAdd()

setAdd(  $set,   $value = null,   $stype,   $score = null)

将value写入set集合如果value存在不写入返回false 如果是有序集合则根据score值更新该元素的顺序

Parameters

	$set	string 集合名
	$value	mixed 值
	$stype	int 集合类型 0:无序集合 1:有序集和默认0
	$score	int 元素排序值

setMove()

setMove(  $set1,   $value = null,   $stype,   $set2 = null)

移除set1中的value元素如果指定了set2 则将该元素写入set2

Parameters

	$set1	string 集合名
	$value	mixed 值
	$stype	int 集合类型 0:无序集合 1:有序集和默认0
	$set2	string 集合名

setSearch()

setSearch(  $set,   $value = null)

查询set中是否有value元素

Parameters

	$set	string 集合名
	$value	mixed 值

setSize()

setSize(  $set,   $stype,   $start,   $end)

返回set中所有元素个数有序集合要指定$stype=1 如果是有序集合并指定了$start和$end 则返回score在start跟end之间的元素个数

Parameters

	$set	string 集合名
	$stype	int 集合类型 0:无序集合 1:有序集和默认0
	$start	int 开始index
	$end	int 结束index

setPop()

setPop(  $set,   $isdel)

随机返回set中一个元素并可选是否删除该元素

Parameters

	$set	string 集合名
	$isdel	int 是否删除该元素 0:不删除 1:删除默认为0

setInter()

setInter(  $set,   $newset = null,   $stype,   $weight = array(1),   $function = 'SUM')

求交集并可选是否将交集保存到新集合

Parameters

	$set	array 集合名数组
	$newset	string 要保存到的集合名默认为null 即不保存交集到新集合
	$stype	int 集合类型 0:无序集合 1:有序集和默认0
	$weight	array 权重执行function操作时要指定的每个集合的相同元素所占的权重默认1
	$function	string 不同集合的相同元素的取值规则函数 SUM:取元素值的和 MAX:取最大值元素 MIN:取最小值元素

setUnion()

setUnion(  $set,   $newset = null,   $stype,   $weight = array(1),   $function = 'SUM')

求并集并可选是否将交集保存到新集合

Parameters

	$set	array 集合名数组
	$newset	string 要保存到的集合名默认为null 即不保存交集到新集合
	$stype	int 集合类型 0:无序集合 1:有序集和默认0
	$weight	array 权重执行function操作时要指定的每个集合的相同元素所占的权重默认1
	$function	string 不同集合的相同元素的取值规则函数 SUM:取元素值的和 MAX:取最大值元素 MIN:取最小值元素

setDiff()

setDiff(  $set,   $newset = null)

求差集并可选是否将交集保存到新集合

Parameters

	$set	array 集合名数组
	$newset	string 要保存到的集合名默认为null 即不保存交集到新集合

setMembers()

setMembers(  $set)

返回set中所有元素

Parameters

$set

string 集合名

setSort()

setSort(  $set,   $option)

排序分页等

Parameters

	$set	string 集合名
	$option	array 选项

setRange()

setRange(  $set,   $start,   $end,   $order,   $score = false)

***只针对有序集合操作返回set中index从start到end的所有元素

Parameters

	$set	string 集合名
	$start	int 开始Index
	$end	int 结束Index
	$order	int 排序方式 0:从小到大排序 1:从大到小排序默认0
	$score	bool 元素排序值 false:返回数据不带score true:返回数据带score 默认false

setDeleteRange()

setDeleteRange(  $set,   $start,   $end)

***只针对有序集合操作删除set中score从start到end的所有元素

Parameters

	$set	string 集合名
	$start	int 开始score
	$end	int 结束score

setScore()

setScore(  $set,   $value,   $inc = null)

***只针对有序集合操作获取set中某个元素的score 如果指定了inc参数则给该元素的score增加inc值如果没有该元素则将该元素写入集合

Parameters

	$set	string 集合名
	$value	mixed 元素值
	$inc	int 要给score增加的数值默认是null 不执行score增加操作

hashSet()

hashSet(  $hash,   $data)

将key->value写入hash表中

Parameters

	$hash	string 哈希表名
	$data	array 要写入的数据 array('key'=>'value')

hashGet()

hashGet(  $hash,   $key = array(),   $type)

获取hash表的数据

Parameters

	$hash	string 哈希表名
	$key	mixed 表中要存储的key名默认为null 返回所有key>value
	$type	int 要获取的数据类型 0:返回所有key 1:返回所有value 2:返回所有key->value

hashLen()

hashLen(  $hash)

获取hash表中元素个数

Parameters

$hash

string 哈希表名

hashDel()

hashDel(  $hash,   $key)

删除hash表中的key

Parameters

	$hash	string 哈希表名
	$key	mixed 表中存储的key名

hashExists()

hashExists(  $hash,   $key)

查询hash表中某个key是否存在

Parameters

	$hash	string 哈希表名
	$key	mixed 表中存储的key名

hashInc()

hashInc(  $hash,   $key,   $inc)

自增hash表中某个key的值

Parameters

	$hash	string 哈希表名
	$key	mixed 表中存储的key名
	$inc	int 要增加的值

setKeyExpire()

setKeyExpire(  $key,   $time)

自增hash表中某个key的值

Parameters

	$key	string 哈希表名
	$time	mixed 表中存储的key名

getKeys()

getKeys(  $key = null)

获取满足给定pattern的所有key

Parameters

$key

regexp key匹配表达式模式:user* 匹配以user开始的key

hwSave()

hwSave(  $type,   $time)

将数据保存到硬盘同步/异步

Parameters

	$type	int 保存方式 0:同步 1:异步默认0
	$time	int 是否要获取上次成功将数据保存到磁盘的Unix时戳 0:不返回时间 1:返回时间

lastSave()

lastSave()

获取上次成功将数据保存到磁盘的Unix时戳

info()

info()

获取redis版本信息等详情

dbSize()

dbSize()

获取数据库中key的数目

tranStart()

tranStart()

开始进入事务操作

tranCommit()

tranCommit()

提交完成事务

tranRollback()

tranRollback()

回滚事务

connect()

connect(  $host,   $port,   $cauth,   $timeout,   $dbname,   $type)

连接redis服务器

Parameters

	$host
	$port
	$cauth
	$timeout
	$dbname
	$type