• Home
• yii
• caching
• MemCache

PHP Class yii\caching\MemCache

MemCache supports both memcache and memcached. By setting [[useMemcached]] to be true or false, one can let MemCache to use either memcached or memcache, respectively. MemCache can be configured with a list of memcache servers by settings its [[servers]] property. By default, MemCache assumes there is a memcache server running on localhost at port 11211. See Cache for common cache operations that MemCache supports. Note, there is no security measure to protected data in memcache. All data in memcache can be accessed by any process running in the system. To use MemCache as the cache application component, configure the application as follows, php [ 'components' => [ 'cache' => [ 'class' => 'yii\caching\MemCache', 'servers' => [ [ 'host' => 'server1', 'port' => 11211, 'weight' => 60, ], [ 'host' => 'server2', 'port' => 11211, 'weight' => 40, ], ], ], ], ] In the above, two memcache servers are used: server1 and server2. You can configure more properties of each server, such as persistent, weight, timeout. Please see MemCacheServer for available options. For more details and usage information on Cache, see the guide article on caching. Show file Open project: yiisoft/yii2 Class Usage Examples

Public Properties

Property	Type	Description
$options		options for Memcached. This property is used only when [[useMemcached]] is true.
$password		memcached sasl password. This property is used only when [[useMemcached]] is true.
$persistentId		an ID that identifies a Memcached instance. This property is used only when [[useMemcached]] is true. By default the Memcached instances are destroyed at the end of the request. To create an instance that persists between requests, you may specify a unique ID for the instance. All instances created with the same ID will share the same connection.
$useMemcached		whether to use memcached or memcache as the underlying caching extension. If true, memcached will be used. If false, memcache will be used. Defaults to false.
$username		memcached sasl username. This property is used only when [[useMemcached]] is true.

Public Methods

Method	Description
getMemcache ( ) : Memcache | Memcached	Returns the underlying memcache (or memcached) object.
getServers ( ) : MemCacheServer[]	Returns the memcache or memcached server configurations.
init ( )	Initializes this application component.
setServers ( array $config )

Protected Methods

Method	Description
addMemcacheServers ( Memcache $cache, MemCacheServer[] $servers )	Add servers to the server pool of the cache specified Used for memcache PECL extension.
addMemcachedServers ( Memcached $cache, MemCacheServer[] $servers )	Add servers to the server pool of the cache specified Used for memcached PECL extension.
addServers ( Memcache | Memcached $cache, MemCacheServer[] $servers )	Add servers to the server pool of the cache specified
addValue ( string $key, mixed $value, integer $duration ) : boolean	Stores a value identified by a key into cache if the cache does not contain this key.
deleteValue ( string $key ) : boolean	Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.
flushValues ( ) : boolean	Deletes all values from cache.
getValue ( string $key ) : mixed | false	Retrieves a value from cache with a specified key.
getValues ( array $keys ) : array	Retrieves multiple values from cache with the specified keys.
setValue ( string $key, mixed $value, integer $duration ) : boolean	Stores a value identified by a key in cache.
setValues ( array $data, integer $duration ) : array	Stores multiple key-value pairs in cache.

Method Details

Property Details