Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class MemcachedStorage - list of methods

Memcached cache storage handler

Extends

CacheStorage
Package: Joomla\CMS\Cache\Storage
Copyright: (C) 2012 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Cache/Storage/MemcachedStorage.php
Project: Joomla

Method Summary

public
__construct
(mixed $options = array())

Constructor
Parameters
  • array $options Optional parameters.
Since
  • 3.0.0
Show source code of this method: __construct Source Code

protected void
()

Create the Memcached connection
Returns
  • void
Since
  • 3.0.0
-
  • \RuntimeException
Show source code of this method: getConnection Source Code

protected string
_getCacheId
(mixed $id, mixed $group)

Get a cache_id string from an id/group pair
Parameters
  • string $id The cache data id
  • string $group The cache data group
Returns
  • string The cache_id string
Since
  • 1.7.0
Show source code of this method: _getCacheId Source Code

public bool
(mixed $id, mixed $group)

Check if the cache contains data stored by ID and group
Parameters
  • string $id The cache data ID
  • string $group The cache data group
Returns
  • bool
Since
  • 3.7.0
Show source code of this method: contains Source Code

public mixed
(mixed $id, mixed $group, mixed $checkTime = true)

Get cached data by ID and group
Parameters
  • string $id The cache data ID
  • string $group The cache data group
  • bool $checkTime True to verify cache time expiration threshold
Returns
  • mixed Boolean false on failure or a cached data object
Since
  • 3.0.0
Show source code of this method: get Source Code

public mixed
()

Get all cached data
Returns
  • mixed Boolean false on failure or a cached data object
Since
  • 3.0.0
Show source code of this method: getAll Source Code

public bool
(mixed $id, mixed $group, mixed $data)

Store the data to cache by ID and group
Parameters
  • string $id The cache data ID
  • string $group The cache data group
  • string $data The data to store in cache
Returns
  • bool
Since
  • 3.0.0
Show source code of this method: store Source Code

public bool
(mixed $id, mixed $group)

Remove a cached data entry by ID and group
Parameters
  • string $id The cache data ID
  • string $group The cache data group
Returns
  • bool
Since
  • 3.0.0
Show source code of this method: remove Source Code

public bool
(mixed $group, mixed $mode = null)

Clean cache for a group given a mode.
Parameters
  • string $group The cache data group
  • string $mode The mode for cleaning cache [group|notgroup]
Returns
  • bool
Since
  • 3.0.0
Show source code of this method: clean Source Code

public bool
()

Flush all existing items in storage.
Returns
  • bool
Since
  • 3.6.3
Show source code of this method: flush Source Code

public static bool
()

Test to see if the storage handler is available.
Returns
  • bool
Since
  • 3.0.0
Show source code of this method: isSupported Source Code

public mixed
(mixed $id, mixed $group, mixed $locktime)

Lock cached item
Parameters
  • string $id The cache data ID
  • string $group The cache data group
  • int $locktime Cached item max lock time
Returns
  • mixed Boolean false if locking failed or an object containing properties lock and locklooped
Since
  • 3.0.0
Show source code of this method: lock Source Code

public bool
(mixed $id, mixed $group = null)

Unlock cached item
Parameters
  • string $id The cache data ID
  • string $group The cache data group
Returns
  • bool
Since
  • 3.0.0
Show source code of this method: unlock Source Code

protected bool
()

Lock cache index
Returns
  • bool
Since
  • 3.0.0
Show source code of this method: lockindex Source Code

protected bool
()

Unlock cache index
Returns
  • bool
Since
  • 3.0.0
Show source code of this method: unlockindex Source Code

Properties Summary

protected static \Memcached
$_db
Memcached connection object
Since
  • 3.0.0
protected int
$_compress
Payload compression level
Since
  • 3.0.0

Tags Summary

Since
3.0.0