Wikibase\Lib\StatslibRecordingSimpleCache Class Reference

Simple CacheInterface that increments a stats metric based on the number of cache misses that occur. More...

Inheritance diagram for Wikibase\Lib\StatslibRecordingSimpleCache:

Collaboration diagram for Wikibase\Lib\StatslibRecordingSimpleCache:

Public Member Functions
	__construct (CacheInterface $inner, StatsFactory $statsFactory, array $statsdKeys, string $statsKey)
	get ( $key, $default=null)
	set ( $key, $value, $ttl=null)
	delete ( $key)
	clear ()
	getMultiple ( $keys, $default=null)
	setMultiple ( $values, $ttl=null)
	deleteMultiple ( $keys)
	has ( $key)

Private Member Functions
	recordMisses (int $count)
	recordHits (int $count)

Private Attributes
const	DEFAULT_VALUE = __CLASS__ . '-default'
	$inner
	$statsFactory
	$statsdKeys
	$statsKey

Detailed Description

Simple CacheInterface that increments a stats metric based on the number of cache misses that occur.

Copyright

GPL-2.0-or-later

Constructor & Destructor Documentation

__construct()

Wikibase\Lib\StatslibRecordingSimpleCache::__construct	(	CacheInterface	$inner,
		StatsFactory	$statsFactory,
		array	$statsdKeys,
		string	$statsKey )

Parameters

CacheInterface	$inner
StatsFactory	$statsFactory
string[]	$statsdKeys
string	$statsKey

Member Function Documentation

clear()

Wikibase\Lib\StatslibRecordingSimpleCache::clear

(

)

Returns

bool

delete()

Wikibase\Lib\StatslibRecordingSimpleCache::delete

(

$key

)

Parameters

string

$key

Returns

bool

Exceptions

Psr\SimpleCache\InvalidArgumentException

deleteMultiple()

Wikibase\Lib\StatslibRecordingSimpleCache::deleteMultiple

(

$keys

)

Parameters

iterable

$keys

Returns

bool

Exceptions

Psr\SimpleCache\InvalidArgumentException

get()

Wikibase\Lib\StatslibRecordingSimpleCache::get	(		$key,
			$default = null )

Parameters

string	$key
mixed	$default

Returns

mixed

Exceptions

Psr\SimpleCache\InvalidArgumentException

getMultiple()

Wikibase\Lib\StatslibRecordingSimpleCache::getMultiple	(		$keys,
			$default = null )

Parameters

iterable	$keys
mixed	$default

Returns

iterable

Exceptions

Psr\SimpleCache\InvalidArgumentException

has()

Wikibase\Lib\StatslibRecordingSimpleCache::has

(

$key

)

Parameters

string

$key

Returns

bool

Exceptions

Psr\SimpleCache\InvalidArgumentException

recordHits()

Wikibase\Lib\StatslibRecordingSimpleCache::recordHits ( int $count )

private

recordMisses()

Wikibase\Lib\StatslibRecordingSimpleCache::recordMisses ( int $count )

private

set()

Wikibase\Lib\StatslibRecordingSimpleCache::set	(		$key,
			$value,
			$ttl = null )

Parameters

string	$key
mixed	$value
null | int | \DateInterval	$ttl

Returns

bool

Exceptions

Psr\SimpleCache\InvalidArgumentException

setMultiple()

Wikibase\Lib\StatslibRecordingSimpleCache::setMultiple	(		$values,
			$ttl = null )

Parameters

iterable	$values
null | int | \DateInterval	$ttl

Returns

bool

Exceptions

Psr\SimpleCache\InvalidArgumentException

Member Data Documentation

$inner

Wikibase\Lib\StatslibRecordingSimpleCache::$inner

private

$statsdKeys

Wikibase\Lib\StatslibRecordingSimpleCache::$statsdKeys

private

$statsFactory

Wikibase\Lib\StatslibRecordingSimpleCache::$statsFactory

private

$statsKey

Wikibase\Lib\StatslibRecordingSimpleCache::$statsKey

private

DEFAULT_VALUE

const Wikibase\Lib\StatslibRecordingSimpleCache::DEFAULT_VALUE = __CLASS__ . '-default'

private

---

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

• lib/includes/StatslibRecordingSimpleCache.php