Wrapper for WinCache object caching functions; identical interface to the APC wrapper. More...

Inheritance diagram for WinCacheBagOStuff:

[legend]

Collaboration diagram for WinCacheBagOStuff:

[legend]

Public Member Functions
	add ( $key, $value, $exptime=0, $flags=0)
	Insert an item if it does not already exist.

	delete ( $key, $flags=0)
	Delete an item.

	incr ( $key, $value=1)
	Increase stored value of $key by $value while preserving its original TTL.

	makeKeyInternal ( $keyspace, $args)
	Construct a cache key.

	set ( $key, $value, $expire=0, $flags=0)
	Set an item.

Public Member Functions inherited from BagOStuff
	__construct (array $params=[])
	$params include:

	addBusyCallback (callable $workCallback)
	Let a callback be run to avoid wasting time on special blocking calls.

	changeTTL ( $key, $expiry=0, $flags=0)
	Change the expiration on a key if it exists.

	clearLastError ()
	Clear the "last error" registry.

	decr ( $key, $value=1)
	Decrease stored value of $key by $value while preserving its TTL.

	deleteMulti (array $keys, $flags=0)
	Batch deletion.

	deleteObjectsExpiringBefore ( $date, $progressCallback=false)
	Delete all objects expiring before a certain date.

	get ( $key, $flags=0)
	Get an item with the given key.

	getLastError ()
	Get the "last error" registered; clearLastError() should be called manually.

	getMulti (array $keys, $flags=0)
	Get an associative array containing the item for each of the keys that have items.

	getQoS ( $flag)

	getScopedLock ( $key, $timeout=6, $expiry=30, $rclass='')
	Get a lightweight exclusive self-unlocking lock.

	getWithSetCallback ( $key, $ttl, $callback, $flags=0)
	Get an item with the given key, regenerating and setting it if not found.

	incrWithInit ( $key, $ttl, $value=1, $init=1)
	Increase stored value of $key by $value while preserving its TTL.

	lock ( $key, $timeout=6, $expiry=6, $rclass='')
	Acquire an advisory lock on a key string.

	makeGlobalKey ( $class, $component=null)
	Make a global cache key.

	makeKey ( $class, $component=null)
	Make a cache key, scoped to this instance's keyspace.

	merge ( $key, callable $callback, $exptime=0, $attempts=10, $flags=0)
	Merge changes into the existing cache value (possibly creating a new one)

	setDebug ( $bool)

	setLogger (LoggerInterface $logger)

	setMockTime (&$time)

	setMulti (array $data, $exptime=0, $flags=0)
	Batch insertion/replace.

	unlock ( $key)
	Release an advisory lock on a key string.

Protected Member Functions
	cas ( $casToken, $key, $value, $exptime=0, $flags=0)
	Check and set an item.

	doGet ( $key, $flags=0, &$casToken=null)

Protected Member Functions inherited from BagOStuff
	convertToExpiry ( $exptime)
	Convert an optionally relative time to an absolute time.

	convertToRelative ( $exptime)
	Convert an optionally absolute expiry time to a relative time.

	debug ( $text)

	expiryIsRelative ( $exptime)

	getCurrentTime ()

	isInteger ( $value)
	Check if a value is an integer.

	mergeFlagMaps (array $bags)
	Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map.

	mergeViaCas ( $key, $callback, $exptime=0, $attempts=10, $flags=0)

	setLastError ( $err)
	Set the "last error" registry.

Additional Inherited Members
Public Attributes inherited from BagOStuff
const	READ_LATEST = 1
	Bitfield constants for get()/getMulti()

const	READ_VERIFIED = 2

const	WRITE_CACHE_ONLY = 8

const	WRITE_SYNC = 4
	Bitfield constants for set()/merge()

Public Attributes inherited from IExpiringStore
const	ATTR_EMULATION = 1

const	ATTR_SYNCWRITES = 2

const	ERR_NO_RESPONSE = 1

const	ERR_NONE = 0

const	ERR_UNEXPECTED = 3

const	ERR_UNREACHABLE = 2

const	QOS_EMULATION_SQL = 1

const	QOS_SYNCWRITES_BE = 2

const	QOS_SYNCWRITES_NONE = 1

const	QOS_SYNCWRITES_QC = 3

const	QOS_SYNCWRITES_SS = 4

const	QOS_UNKNOWN = INF

const	TTL_DAY = 86400

const	TTL_HOUR = 3600

const	TTL_INDEFINITE = 0

const	TTL_MINUTE = 60

const	TTL_MONTH = 2592000

const	TTL_PROC_LONG = 30

const	TTL_PROC_SHORT = 3

const	TTL_SECOND = 1

const	TTL_WEEK = 604800

const	TTL_YEAR = 31536000

Protected Attributes inherited from BagOStuff
callable null	$asyncHandler

int[]	$attrMap = []
	Map of (ATTR_* class constant => QOS_* class constant)

callable[]	$busyCallbacks = []

string	$keyspace = 'local'

int	$lastError = self::ERR_NONE
	ERR_* class constant.

array[]	$locks = []
	Lock tracking.

LoggerInterface	$logger

int	$syncTimeout
	Seconds.

Detailed Description

Wrapper for WinCache object caching functions; identical interface to the APC wrapper.

Definition at line 30 of file WinCacheBagOStuff.php.

Member Function Documentation

◆ add()

WinCacheBagOStuff::add	(	$key,
		$value,
		$exptime = 0,
		$flags = 0 )

Insert an item if it does not already exist.

Parameters

string	$key
mixed	$value
int	$exptime
int	$flags	Bitfield of BagOStuff::WRITE_* constants (since 1.33)

Returns: bool Success

Reimplemented from BagOStuff.

Definition at line 79 of file WinCacheBagOStuff.php.

References $value, and(), and serialize().

◆ cas()

WinCacheBagOStuff::cas	(	$casToken,
		$key,
		$value,
		$exptime = 0,
		$flags = 0 )

protected

Check and set an item.

Parameters

mixed	$casToken
string	$key
mixed	$value
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Exceptions

Exception

Reimplemented from BagOStuff.

Definition at line 47 of file WinCacheBagOStuff.php.

References $success, $value, and(), and doGet().

◆ delete()

WinCacheBagOStuff::delete	(		$key,
			$flags = 0 )

Delete an item.

Parameters

string $key

Returns: bool True if the item was deleted or not found, false on failure

Parameters

int $flags Bitfield of BagOStuff::WRITE_* constants

Reimplemented from BagOStuff.

Definition at line 88 of file WinCacheBagOStuff.php.

References and().

◆ doGet()

WinCacheBagOStuff::doGet	(		$key,
			$flags = 0,
		&	$casToken = null )

protected

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::READ_* constants [optional]
mixed \| null	&$casToken	Token to use for check-and-set comparisons

Returns: mixed Returns false on failure or if the item does not exist

Reimplemented from BagOStuff.

Definition at line 31 of file WinCacheBagOStuff.php.

References $blob, $value, and(), string, and unserialize().

Referenced by cas(), and incr().

◆ incr()

WinCacheBagOStuff::incr	(		$key,
			$value = 1 )

Increase stored value of $key by $value while preserving its original TTL.

Parameters

string	$key	Key to increase
int	$value	Value to add to $key (Default 1)

Returns: int|bool New value or false on failure

Reimplemented from BagOStuff.

Definition at line 136 of file WinCacheBagOStuff.php.

References $value, and(), doGet(), and BagOStuff\isInteger().

◆ makeKeyInternal()

WinCacheBagOStuff::makeKeyInternal	(		$keyspace,
			$args )

Construct a cache key.

Since: 1.27

Parameters

string	$keyspace
array	$args

Returns: string

Reimplemented from BagOStuff.

Definition at line 102 of file WinCacheBagOStuff.php.

References $args, BagOStuff\$keyspace, and and().

◆ set()

WinCacheBagOStuff::set	(	$key,
		$value,
		$exptime = 0,
		$flags = 0 )

Set an item.

Parameters

string	$key
mixed	$value
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Reimplemented from BagOStuff.

Definition at line 70 of file WinCacheBagOStuff.php.

References $value, and(), and serialize().

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

includes/libs/objectcache/WinCacheBagOStuff.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add()

◆ cas()

◆ delete()

◆ doGet()

◆ incr()

◆ makeKeyInternal()

◆ set()