Overview

Namespaces

  • None
  • Wei
    • Validator

Classes

  • Apc
  • App
  • ArrayCache
  • Asset
  • Base
  • BaseCache
  • BaseController
  • Bicache
  • Cache
  • Config
  • Cookie
  • Couchbase
  • Counter
  • Db
  • DbCache
  • E
  • Env
  • Error
  • FileCache
  • Gravatar
  • Http
  • Lock
  • Logger
  • Memcache
  • Memcached
  • MongoCache
  • Password
  • PhpError
  • PhpFileCache
  • Pinyin
  • Record
  • Redis
  • Request
  • Response
  • Router
  • SafeUrl
  • Session
  • Soap
  • T
  • Ua
  • Upload
  • Url
  • Uuid
  • Validate
  • View
  • WeChatApp
  • Wei
  • Overview
  • Namespace
  • Class

Class Memcached

A cache service that stored data in Memcached

Wei\Base
Extended by Wei\BaseCache
Extended by Wei\Memcached
Namespace: Wei
Author: Twin Huang twinhuang@qq.com
Located at Memcached.php
Methods summary
public
# __construct( array $options = array() )

Constructor

Constructor

Parameters

$options

Throws

InvalidArgumentException
When option "wei" is not an instance of "Wei\Wei"

Overrides

Wei\Base::__construct()
public mixed
# __invoke( string $key = null, mixed $value = null, integer $expire = 0 )

Returns the memcached object, retrieve or store an item

Returns the memcached object, retrieve or store an item

Parameters

$key
The name of item
$value
The value of item
$expire
The expire seconds, defaults to 0, means never expired

Returns

mixed

Overrides

Wei\BaseCache::__invoke()
public mixed
# get( string $key, integer $expire = null, callable $fn = null )

Retrieve an item

Retrieve an item

Parameters

$key
The name of item
$expire
The expire seconds of callback return value
$fn
The callback to execute when cache not found

Returns

mixed

Throws

RuntimeException
When set cache return false
public boolean
# set( string $key, mixed $value, integer $expire = 0 )

Store an item

Store an item

Parameters

$key
The name of item
$value
The value of item
$expire
The expire seconds, defaults to 0, means never expired

Returns

boolean
public array
# getMulti( array $keys )

Retrieve multiple items

Retrieve multiple items

Note: setMulti method is not reimplemented for it returning only one "true" or "false" for all items

Parameters

$keys
The name of items

Returns

array

Link

http://www.php.net/manual/en/memcached.setmulti.php
https://github.com/php-memcached-dev/php-memcached/blob/master/php_memcached.c#L1219

Overrides

Wei\BaseCache::getMulti()
public boolean
# remove( string $key )

Remove an item

Remove an item

Parameters

$key
The name of item

Returns

boolean
public boolean
# exists( string $key )

Check if an item is exists

Check if an item is exists

Parameters

$key

Returns

boolean
public boolean
# add( string $key, mixed $value, integer $expire = 0 )

Add an item

Add an item

Parameters

$key
The name of item
$value
The value of item
$expire
The expire seconds, defaults to 0, means never expired

Returns

boolean
public boolean
# replace( string $key, mixed $value, integer $expire = 0 )

Replace an existing item

Replace an existing item

Parameters

$key
The name of item
$value
The value of item
$expire
The expire seconds, defaults to 0, means never expired

Returns

boolean
public integer|false
# incr( string $key, integer $offset = 1 )

Increment an item

Increment an item

Parameters

$key
The name of item
$offset
The value to increased

Returns

integer|false
Returns the new value on success, or false on failure
public integer|false
# decr( string $key, integer $offset = 1 )

Decrement an item

Decrement an item

Parameters

$key
The name of item
$offset
The value to be decreased

Returns

integer|false
Returns the new value on success, or false on failure

Overrides

Wei\BaseCache::decr()
protected integer|false
# incDec( string $key, integer $offset, boolean $inc = true )

Increment/Decrement an item

Increment/Decrement an item

Memcached do not allow negative number as $offset parameter

Parameters

$key
The name of item
$offset
The value to be increased/decreased
$inc
The operation is increase or decrease

Returns

integer|false
Returns the new value on success, or false on failure

Link

https://github.com/php-memcached-dev/php-memcached/blob/master/php_memcached.c#L1746
public boolean
# clear( )

Clear all items

Clear all items

Returns

boolean
public Memcached
# getObject( )

Get memcached object

Get memcached object

Returns

Memcached
public
# setObject( Wei\Memcached $object )

Set memcached object

Set memcached object

Parameters

$object

Returns


$this
Methods inherited from Wei\BaseCache
getFileContent(), getNamespace(), processGetResult(), setMulti(), setNamespace()
Methods inherited from Wei\Base
__call(), __get(), getOption(), setOption()
Properties summary
protected Memcached $object

The memcached object

The memcached object

#
protected array $servers

The memcached server configurations

The memcached server configurations

See

\Memcached::addServers
# array( array( 'host' => '127.0.0.1', 'port' => 11211, ) )
Properties inherited from Wei\BaseCache
$namespace
Properties inherited from Wei\Base
$providers, $wei
Wei Framework API documentation generated by ApiGen