Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres publiques | Fonctions membres publiques statiques | Fonctions membres protégées | Attributs protégés | Attributs protégés statiques
Référence de la classe JCacheStorageCachelite
+ Graphe d'héritage de JCacheStorageCachelite:
+ Graphe de collaboration de JCacheStorageCachelite:

Liste de tous les membres

Fonctions membres publiques

 __construct ($options=array())
 get ($id, $group, $checkTime=true)
 getAll ()
 store ($id, $group, $data)
 remove ($id, $group)
 clean ($group, $mode=null)
 gc ()
- Fonctions membres publiques inherited from JCacheStorage
 lock ($id, $group, $locktime)
 unlock ($id, $group=null)

Fonctions membres publiques statiques

static isSupported ()
- Fonctions membres publiques statiques inherited from JCacheStorage
static getInstance ($handler=null, $options=array())
static test ()
static addIncludePath ($path= '')

Fonctions membres protégées

 initCache ($cloptions)
- Fonctions membres protégées inherited from JCacheStorage
 _getCacheId ($id, $group)

Attributs protégés

 $_root
- Attributs protégés inherited from JCacheStorage
 $rawname

Attributs protégés statiques

static $CacheLiteInstance = null

Additional Inherited Members

- Attributs publics inherited from JCacheStorage
 $_now
 $_lifetime
 $_locking
 $_language
 $_application
 $_hash

Description détaillée

Définition à la ligne 20 du fichier cachelite.php.

Documentation des constructeurs et destructeur

JCacheStorageCachelite::__construct (   $options = array())

Constructor

Paramètres:
array$optionsOptional parameters.
Depuis:
11.1

Réimplémentée à partir de JCacheStorage.

Définition à la ligne 45 du fichier cachelite.php.

{
parent::__construct($options);
$this->_root = $options['cachebase'];
$cloptions = array(
'cacheDir' => $this->_root . '/',
'lifeTime' => $this->_lifetime,
'fileLocking' => $this->_locking,
'automaticCleaningFactor' => isset($options['autoclean']) ? $options['autoclean'] : 200,
'fileNameProtection' => false,
'hashedDirectoryLevel' => 0,
'caching' => $options['caching']);
if (self::$CacheLiteInstance === null)
{
$this->initCache($cloptions);
}
}

Documentation des fonctions membres

JCacheStorageCachelite::clean (   $group,
  $mode = null 
)

Clean cache for a group given a mode.

Paramètres:
string$groupThe cache data group.
string$modeThe mode for cleaning cache [group|notgroup]. group mode : cleans all cache in the group notgroup mode : cleans all cache not in the group
Renvoie:
boolean True on success, false otherwise.
Depuis:
11.1

Réimplémentée à partir de JCacheStorage.

Définition à la ligne 232 du fichier cachelite.php.

Références JFolder\delete(), et jimport().

{
jimport('joomla.filesystem.folder');
switch ($mode)
{
case 'notgroup':
$clmode = 'notingroup';
$success = self::$CacheLiteInstance->clean($group, $clmode);
break;
case 'group':
if (is_dir($this->_root . '/' . $group))
{
$clmode = $group;
self::$CacheLiteInstance->setOption('cacheDir', $this->_root . '/' . $group . '/');
$success = self::$CacheLiteInstance->clean($group, $clmode);
JFolder::delete($this->_root . '/' . $group);
}
else
{
$success = true;
}
break;
default:
if (is_dir($this->_root . '/' . $group))
{
$clmode = $group;
self::$CacheLiteInstance->setOption('cacheDir', $this->_root . '/' . $group . '/');
$success = self::$CacheLiteInstance->clean($group, $clmode);
}
else
{
$success = true;
}
break;
}
if ($success == true)
{
return $success;
}
else
{
return false;
}
}

+ Voici le graphe d'appel pour cette fonction :

JCacheStorageCachelite::gc ( )

Garbage collect expired cache data

Renvoie:
boolean True on success, false otherwise.
Depuis:
11.1

Réimplémentée à partir de JCacheStorage.

Définition à la ligne 290 du fichier cachelite.php.

{
$result = true;
self::$CacheLiteInstance->setOption('automaticCleaningFactor', 1);
self::$CacheLiteInstance->setOption('hashedDirectoryLevel', 1);
$success1 = self::$CacheLiteInstance->_cleanDir($this->_root . '/', false, 'old');
if (!($dh = opendir($this->_root . '/')))
{
return false;
}
while ($file = readdir($dh))
{
if (($file != '.') && ($file != '..') && ($file != '.svn'))
{
$file2 = $this->_root . '/' . $file;
if (is_dir($file2))
{
$result = ($result && (self::$CacheLiteInstance->_cleanDir($file2 . '/', false, 'old')));
}
}
}
$success = ($success1 && $result);
return $success;
}
JCacheStorageCachelite::get (   $id,
  $group,
  $checkTime = true 
)

Get cached data from a file by id and group

Paramètres:
string$idThe cache data id.
string$groupThe cache data group.
boolean$checkTimeTrue to verify cache time expiration threshold.
Renvoie:
mixed Boolean false on failure or a cached data string.
Depuis:
11.1

Réimplémentée à partir de JCacheStorage.

Définition à la ligne 97 du fichier cachelite.php.

{
self::$CacheLiteInstance->setOption('cacheDir', $this->_root . '/' . $group . '/');
$this->_getCacheId($id, $group);
$data = self::$CacheLiteInstance->get($this->rawname, $group);
return $data;
}
JCacheStorageCachelite::getAll ( )

Get all cached data

Renvoie:
array
Depuis:
11.1

Réimplémentée à partir de JCacheStorage.

Définition à la ligne 113 du fichier cachelite.php.

{
parent::getAll();
$path = $this->_root;
$folders = new DirectoryIterator($path);
$data = array();
foreach ($folders as $folder)
{
if (!$folder->isDir() || $folder->isDot())
{
continue;
}
$foldername = $folder->getFilename();
$files = new DirectoryIterator($path . '/' . $foldername);
$item = new JCacheStorageHelper($foldername);
foreach ($files as $file)
{
if (!$file->isFile())
{
continue;
}
$filename = $file->getFilename();
$item->updateSize(filesize($path . '/' . $foldername . '/' . $filename) / 1024);
}
$data[$foldername] = $item;
}
return $data;
}
JCacheStorageCachelite::initCache (   $cloptions)
protected

Instantiates the appropriate CacheLite object. Only initializes the engine if it does not already exist. Note this is a protected method

Paramètres:
array$cloptionsoptional parameters
Renvoie:
object
Depuis:
11.1

Définition à la ligne 77 du fichier cachelite.php.

{
require_once 'Cache/Lite.php';
self::$CacheLiteInstance = new Cache_Lite($cloptions);
return self::$CacheLiteInstance;
}
static JCacheStorageCachelite::isSupported ( )
static

Test to see if the cache storage is available.

Renvoie:
boolean True on success, false otherwise.
Depuis:
12.1

Réimplémentée à partir de JCacheStorage.

Définition à la ligne 327 du fichier cachelite.php.

{
@include_once 'Cache/Lite.php';
if (class_exists('Cache_Lite'))
{
return true;
}
else
{
return false;
}
}
JCacheStorageCachelite::remove (   $id,
  $group 
)

Remove a cached data file by id and group

Paramètres:
string$idThe cache data id
string$groupThe cache data group
Renvoie:
boolean True on success, false otherwise
Depuis:
11.1

Réimplémentée à partir de JCacheStorage.

Définition à la ligne 204 du fichier cachelite.php.

{
self::$CacheLiteInstance->setOption('cacheDir', $this->_root . '/' . $group . '/');
$this->_getCacheId($id, $group);
$success = self::$CacheLiteInstance->remove($this->rawname, $group);
if ($success == true)
{
return $success;
}
else
{
return false;
}
}
JCacheStorageCachelite::store (   $id,
  $group,
  $data 
)

Store the data to a file by id and group

Paramètres:
string$idThe cache data id.
string$groupThe cache data group.
string$dataThe data to store in cache.
Renvoie:
boolean True on success, false otherwise
Depuis:
11.1

Réimplémentée à partir de JCacheStorage.

Définition à la ligne 162 du fichier cachelite.php.

{
$dir = $this->_root . '/' . $group;
// If the folder doesn't exist try to create it
if (!is_dir($dir))
{
// Make sure the index file is there
$indexFile = $dir . '/index.html';
@mkdir($dir) && file_put_contents($indexFile, '<!DOCTYPE html><title></title>');
}
// Make sure the folder exists
if (!is_dir($dir))
{
return false;
}
self::$CacheLiteInstance->setOption('cacheDir', $this->_root . '/' . $group . '/');
$this->_getCacheId($id, $group);
$success = self::$CacheLiteInstance->save($data, $this->rawname, $group);
if ($success == true)
{
return $success;
}
else
{
return false;
}
}

Documentation des données membres

JCacheStorageCachelite::$_root
protected

Définition à la ligne 36 du fichier cachelite.php.

JCacheStorageCachelite::$CacheLiteInstance = null
staticprotected

Définition à la ligne 28 du fichier cachelite.php.

La documentation de cette classe a été générée à partir du fichier suivant :