1. webvariants
  2. Untitled project
  3. BabelCache

Commits

xrstf  committed b9b7abc

added @package declarations

  • Participants
  • Parent commits ba92841
  • Branches default

Comments (0)

Files changed (16)

File BabelCache.php

View file
  * This class only contains three little methods. Most of the time, you will be
  * using generateKey().
  *
- * @author Christoph Mewes
+ * @author  Christoph Mewes
+ * @package BabelCache
  */
 abstract class BabelCache {
 	/**

File BabelCache/APC.php

View file
  * On APC < 3.1.4, all data will be manually serialized by this class, else
  * it will rely on APC to handle complex data.
  *
- * @author Christoph Mewes
- * @see    http://php.net/manual/de/book.apc.php
+ * @author  Christoph Mewes
+ * @see     http://php.net/manual/de/book.apc.php
+ * @package BabelCache.Storage
  */
 class BabelCache_APC extends BabelCache_Abstract {
 	private $hasExistsMethod = null; ///< boolean  true if apc_exists() exists, else false

File BabelCache/Abstract.php

View file
  * implementations will only wrap the specific functions added by the PECL
  * module.
  *
- * @author Christoph Mewes
+ * @author  Christoph Mewes
+ * @package BabelCache.Storage
  */
 abstract class BabelCache_Abstract extends BabelCache implements BabelCache_Interface {
 	protected $versions   = array(); ///< array   runtime cache of versions

File BabelCache/Blackhole.php

View file
  * so that code relying on a cache can use the cache instance normally without
  * checking for null.
  *
- * @author Christoph Mewes
+ * @author  Christoph Mewes
+ * @package BabelCache.Storage
  */
 class BabelCache_Blackhole extends BabelCache implements BabelCache_Interface {
 	public static function isAvailable() {

File BabelCache/Exception.php

View file
  *
  * Nothing special here, just to distinguish between BabelCache errors and
  * other errors.
+ *
+ * @package BabelCache
  */
 class BabelCache_Exception extends Exception { }

File BabelCache/Factory.php

View file
  * When caching is globally disabled, the factory will always return the
  * blackhole cache.
  *
- * @author Christoph Mewes
+ * @author  Christoph Mewes
+ * @package BabelCache
  */
 abstract class BabelCache_Factory {
 	private $instances     = array();  ///< array    list of caching instances

File BabelCache/Filesystem.php

View file
  * should suffice in 99,9% of all cases (if you really need to store large
  * amount of data, consider using Memcached instead).
  *
- * @author Christoph Mewes
- * @see    BabelCache_Filesystem_Plain
+ * @author  Christoph Mewes
+ * @see     BabelCache_Filesystem_Plain
+ * @package BabelCache.Storage
  */
 class BabelCache_Filesystem extends BabelCache implements BabelCache_Interface {
 	protected $dataDir = '';    ///< string  absolute path to the cache directory

File BabelCache/Filesystem/Plain.php

View file
  * In constrast to the full-blown filesystem cache, this one will store all data
  * files directly inside the namespace directories.
  *
- * @author Christoph Mewes
- * @see    BabelCache_Filesystem
+ * @author  Christoph Mewes
+ * @see     BabelCache_Filesystem
+ * @package BabelCache.Storage
  */
 class BabelCache_Filesystem_Plain extends BabelCache_Filesystem {
 	public function lock($namespace, $key, $duration = 1) {

File BabelCache/Interface.php

View file
  * This interface is used for all provided caches and provides a common set of
  * methods that all caches support. It's kind of the least common denominator.
  *
- * @author Christoph Mewes
+ * @author  Christoph Mewes
+ * @package BabelCache.Storage
  */
 interface BabelCache_Interface {
 	/**
 	 * This method will put a value into the cache. If it already exists, it
 	 * will be overwritten.
 	 *
-	 * @param  string $namespace     the namespace to use
-	 * @param  string $key           the object key
-	 * @param  mixed  $value         the value to store
-	 * @return mixed                 the set value
+	 * @param  string $namespace  the namespace to use
+	 * @param  string $key        the object key
+	 * @param  mixed  $value      the value to store
+	 * @return mixed              the set value
 	 */
 	public function set($namespace, $key, $value);
 

File BabelCache/Memcache.php

View file
  * This class wraps the memcache extension of PHP. Don't mix it up with the
  * memcached (with d!) extension, for which you have to use BabelCache_Memcached.
  *
- * @author Christoph Mewes
- * @see    http://www.php.net/manual/de/book.memcache.php
+ * @author  Christoph Mewes
+ * @see     http://www.php.net/manual/de/book.memcache.php
+ * @package BabelCache.Storage
  */
 class BabelCache_Memcache extends BabelCache_Abstract {
 	protected $memcached = null;  ///< Memcache  the current Memcache instance

File BabelCache/Memcached.php

View file
  * memcache (without d!) extension, for which you have to use
  * BabelCache_Memcache.
  *
- * @author Christoph Mewes
- * @see    http://www.php.net/manual/de/book.memcached.php
+ * @author  Christoph Mewes
+ * @see     http://www.php.net/manual/de/book.memcached.php
+ * @package BabelCache.Storage
  */
 class BabelCache_Memcached extends BabelCache_Memcache {
 	/**

File BabelCache/Memory.php

View file
  * Lockig does of course not make any sense, so the corresponding methods will
  * just return true.
  *
- * @author Christoph Mewes
- * @see    BabelCache_Filesystem
+ * @author  Christoph Mewes
+ * @see     BabelCache_Filesystem
+ * @package BabelCache.Storage
  */
 class BabelCache_Memory extends BabelCache implements BabelCache_Interface {
 	protected $data = array();  ///< array  contains the cached data {namespace => {key: value, key: value}}

File BabelCache/SQLite.php

View file
  * all the other stuff that makes the PHP file API so goddamn awful, use this
  * implementation.
  *
- * @author Christoph Mewes
+ * @author  Christoph Mewes
+ * @package BabelCache.Storage
  */
 class BabelCache_SQLite extends BabelCache implements BabelCache_Interface {
 	protected $pdo   = null;    ///< PDO    database connection

File BabelCache/XCache.php

View file
  * This class wraps the XCache extension, which provides both opcode and vardata
  * caching.
  *
- * Using XCache is my personal recommendation, as it's fast and reliable.
- *
- * @author Christoph Mewes
- * @see    http://xcache.lighttpd.net/
+ * @author  Christoph Mewes
+ * @see     http://xcache.lighttpd.net/
+ * @package BabelCache.Storage
  */
 class BabelCache_XCache extends BabelCache_Abstract {
 	public function getMaxKeyLength() {

File BabelCache/ZendServer.php

View file
  * Please note that this implementation does not use the native namespacing
  * features, but the generic implementation of BabelCache_Abstract.
  *
- * @author Christoph Mewes
- * @see    http://files.zend.com/help/Zend-Platform/zend_cache_api.htm
+ * @author  Christoph Mewes
+ * @see     http://files.zend.com/help/Zend-Platform/zend_cache_api.htm
+ * @package BabelCache.Storage
  */
 class BabelCache_ZendServer extends BabelCache_Abstract {
 	public function getMaxKeyLength() {

File BabelCache/eAccelerator.php

View file
  * in recent versions (> 0.9.5), you have to enable the vardata functions (put,
  * get, ...) via the compile switch --with-eaccelerator-shared-memory.
  *
- * @author Christoph Mewes
- * @see    http://eaccelerator.net/
+ * @author  Christoph Mewes
+ * @see     http://eaccelerator.net/
+ * @package BabelCache.Storage
  */
 class BabelCache_eAccelerator extends BabelCache_Abstract {
 	public function getMaxKeyLength() {