Fixing phpdoc tags in CakePHP cache classes

git-svn-id: https://svn.cakephp.org/repo/branches/1.2.x.x@5853 3807eeeb-6ff5-0310-8944-8be069107fe0
This commit is contained in:
mariano.iglesias 2007-10-22 06:23:57 +00:00
parent 2e896e5220
commit 91b8d00aea
5 changed files with 11 additions and 14 deletions

View file

@ -38,9 +38,9 @@ class APCEngine extends CacheEngine {
* Called automatically by the cache frontend * Called automatically by the cache frontend
* To reinitialize the settings call Cache::engine('EngineName', [optional] settings = array()); * To reinitialize the settings call Cache::engine('EngineName', [optional] settings = array());
* *
* @see var $__defaults
* @param array $setting array of setting for the engine * @param array $setting array of setting for the engine
* @return bool True if the engine has been successfully initialized, false if not * @return bool True if the engine has been successfully initialized, false if not
* @see CacheEngine::__defaults
* @access public * @access public
*/ */
function init($settings = array()) { function init($settings = array()) {

View file

@ -41,9 +41,9 @@ if (!class_exists('file')) {
*/ */
class FileEngine extends CacheEngine { class FileEngine extends CacheEngine {
/** /**
* instance of File class * Instance of File class
* *
* @var string * @var object
* @access private * @access private
*/ */
var $__File = null; var $__File = null;
@ -54,8 +54,8 @@ class FileEngine extends CacheEngine {
* lock = enable file locking on write, default => false * lock = enable file locking on write, default => false
* serialize = serialize the data, default => true * serialize = serialize the data, default => true
* *
* @see var __defaults
* @var array * @var array
* @see CacheEngine::__defaults
* @access public * @access public
*/ */
var $settings = array(); var $settings = array();
@ -84,8 +84,7 @@ class FileEngine extends CacheEngine {
return true; return true;
} }
/** /**
* Garbage collection * Garbage collection. Permanently remove all expired and deleted data
* Permanently remove all expired and deleted data
* *
* @return bool True if garbage collection was succesful, false on failure * @return bool True if garbage collection was succesful, false on failure
* @access public * @access public

View file

@ -62,7 +62,6 @@ class MemcacheEngine extends CacheEngine {
if (!class_exists('Memcache')) { if (!class_exists('Memcache')) {
return false; return false;
} }
parent::init($settings); parent::init($settings);
$defaults = array('servers' => array('127.0.0.1'), 'compress'=> false); $defaults = array('servers' => array('127.0.0.1'), 'compress'=> false);
$this->settings = am($this->settings, $defaults, $settings); $this->settings = am($this->settings, $defaults, $settings);
@ -131,10 +130,10 @@ class MemcacheEngine extends CacheEngine {
return $this->__Memcache->flush(); return $this->__Memcache->flush();
} }
/** /**
* connects to a server in connection pool * Connects to a server in connection pool
* *
* @param string $host host ip address or name * @param string $host host ip address or name
* @param int $port * @param int $port Server port
* @return bool True if memcache server was connected * @return bool True if memcache server was connected
* @access public * @access public
*/ */

View file

@ -56,6 +56,7 @@ class ModelEngine extends CacheEngine {
* *
* @param array $setting array of setting for the engine * @param array $setting array of setting for the engine
* @return bool True if the engine has been successfully initialized, false if not * @return bool True if the engine has been successfully initialized, false if not
* @access public
*/ */
function init($settings) { function init($settings) {
parent::init($settings); parent::init($settings);
@ -68,9 +69,7 @@ class ModelEngine extends CacheEngine {
} }
} }
/** /**
* Garbage collection * Garbage collection. Permanently remove all expired and deleted data
*
* Permanently remove all expired and deleted data
* *
* @access public * @access public
*/ */
@ -82,7 +81,7 @@ class ModelEngine extends CacheEngine {
* *
* @param string $key Identifier for the data * @param string $key Identifier for the data
* @param mixed $data Data to be cached * @param mixed $data Data to be cached
* @param mixed $duration How long to cache the data, in seconds * @param int $duration How long to cache the data, in seconds
* @return bool True if the data was succesfully cached, false on failure * @return bool True if the data was succesfully cached, false on failure
* @access public * @access public
*/ */

View file

@ -119,7 +119,7 @@ class XcacheEngine extends CacheEngine {
* (see xcache.admin configuration settings) * (see xcache.admin configuration settings)
* *
* @param bool Revert changes * @param bool Revert changes
* @access protected * @access private
*/ */
function __auth($reverse = false) { function __auth($reverse = false) {
static $backup = array(); static $backup = array();