[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/objectcache/ -> MemcachedPeclBagOStuff.php (summary)

Object caching using memcached. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size: 273 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

MemcachedPeclBagOStuff:: (11 methods):
  __construct()
  get()
  set()
  cas()
  delete()
  add()
  incr()
  decr()
  checkResult()
  getMulti()
  setMulti()


Class: MemcachedPeclBagOStuff  - X-Ref

A wrapper class for the PECL memcached client

__construct( $params )   X-Ref
Constructor

Available parameters are:
- servers:             The list of IP:port combinations holding the memcached servers.
- persistent:          Whether to use a persistent connection
- compress_threshold:  The minimum size an object must be before it is compressed
- timeout:             The read timeout in microseconds
- connect_timeout:     The connect timeout in seconds
- retry_timeout:       Time in seconds to wait before retrying a failed connect attempt
- server_failure_limit:  Limit for server connect failures before it is removed
- serializer:          May be either "php" or "igbinary". Igbinary produces more compact
values, but serialization is much slower unless the php.ini option
igbinary.compact_strings is off.
param: array $params

get( $key, &$casToken = null )   X-Ref

param: string $key
param: float $casToken [optional]
return: mixed

set( $key, $value, $exptime = 0 )   X-Ref

param: string $key
param: mixed $value
param: int $exptime
return: bool

cas( $casToken, $key, $value, $exptime = 0 )   X-Ref

param: float $casToken
param: string $key
param: mixed $value
param: int $exptime
return: bool

delete( $key, $time = 0 )   X-Ref

param: string $key
param: int $time
return: bool

add( $key, $value, $exptime = 0 )   X-Ref

param: string $key
param: int $value
param: int $exptime
return: mixed

incr( $key, $value = 1 )   X-Ref

param: string $key
param: int $value
return: mixed

decr( $key, $value = 1 )   X-Ref

param: string $key
param: int $value
return: mixed

checkResult( $key, $result )   X-Ref
Check the return value from a client method call and take any necessary
action. Returns the value that the wrapper function should return. At
present, the return value is always the same as the return value from
the client, but some day we might find a case where it should be
different.

param: string $key The key used by the caller, or false if there wasn't one.
param: mixed $result The return value
return: mixed

getMulti( array $keys )   X-Ref

param: array $keys
return: array

setMulti( array $data, $exptime = 0 )   X-Ref

param: array $data
param: int $exptime
return: bool



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1