Redis Class Reference

Caches data to redis. More...

Inheritance diagram for Redis:

Public Member Functions
	__construct ($location, $name, $options=null)
	Create a new cache object.
	load ()
	Retrieve the data saved to the cache.
	mtime ()
	Retrieve the last modified time for the cache.
	save ($data)
	Save data to the cache.
	setRedisClient (NativeRedis $cache)
	touch ()
	Set the last modified time to the current time.
	unlink ()
	Remove the cache.

Public Attributes
string const	TYPE_FEED = 'spc'
	Feed cache type.
string const	TYPE_IMAGE = 'spi'
	Image cache type.

Protected Attributes
NativeRedis	$cache
	Redis instance.
string	$name
	Cache name.
array	$options
	Options.

Detailed Description

Caches data to redis.

Registered for URLs with the "redis" protocol

For example, redis://localhost:6379/?timeout=3600&prefix=sp_&dbIndex=0 will connect to redis on localhost on port 6379. All tables will be prefixed with simple_primary- and data will expire after 3600 seconds

@subpackage Caching @uses Redis

Deprecated

since SimplePie 1.8.0, use implementation of "Psr::SimpleCache::CacheInterface" instead

Constructor & Destructor Documentation

__construct()

Redis::__construct	(		$location,
			$name,
			$options = null )

Create a new cache object.

Parameters

string	$location	Location string (from SimplePie::$cache_location)
string	$name	Unique ID for the cache
Base::TYPE_FEED | Base::TYPE_IMAGE	$type	Either TYPE_FEED for SimplePie data, or TYPE_IMAGE for image data

Implements Base.

Member Function Documentation

load()

Redis::load

(

)

Retrieve the data saved to the cache.

Return values

array

Data for SimplePie::$data

Implements Base.

mtime()

Redis::mtime

(

)

Retrieve the last modified time for the cache.

Return values

int

Timestamp

Implements Base.

save()

Redis::save

(

$data

)

Save data to the cache.

Parameters

array | SimplePie::SimplePie

$data

Data to store in the cache. If passed a SimplePie object, only cache the $data property

Return values

bool	Successfulness

Implements Base.

setRedisClient()

Redis::setRedisClient

(

NativeRedis

$cache

)

Parameters

NativeRedis

$cache

touch()

Redis::touch

(

)

Set the last modified time to the current time.

Return values

bool	Success status

Implements Base.

unlink()

Redis::unlink

(

)

Remove the cache.

Return values

bool	Success status

Implements Base.

---

The documentation for this class was generated from the following file:

• lib/simplepie/src/Cache/Redis.php