API17

Difference between revisions of "JCacheStorageFile"

From Joomla! Documentation

m (→‎User contributed notes: moving preparation)
m (preparing for archive only)
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
=={{JVer|11.1}} JCacheStorageFile==
 
=={{JVer|11.1}} JCacheStorageFile==
 
===Description===
 
===Description===
{{Description:JCacheStorageFile}}
+
* JCacheStorageFile is a concrete cache storage handler, storing the cache data in files. In the Joomla CMS the default storage directory is the <code>cache/</code> directory.
<span class="editsection" style="font-size:76%;">
+
 
<nowiki>[</nowiki>[[Description:JCacheStorageFile|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
 
===Methods===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
Line 14: Line 12:
 
|-
 
|-
 
|public  
 
|public  
|[[JCacheStorageFile::__construct/11.1|__construct]]
+
|[[API17:JCacheStorageFile::__construct|__construct]]
 
|Constructor.  
 
|Constructor.  
 
|-
 
|-
 
|public  
 
|public  
|[[JCacheStorageFile::clean/11.1|clean]]
+
|[[API17:JCacheStorageFile::clean|clean]]
 
|Clean cache for a group given a mode.  
 
|Clean cache for a group given a mode.  
 
|-
 
|-
 
|public  
 
|public  
|[[JCacheStorageFile::gc/11.1|gc]]
+
|[[API17:JCacheStorageFile::gc|gc]]
 
|Garbage collect expired cache data.  
 
|Garbage collect expired cache data.  
 
|-
 
|-
 
|public  
 
|public  
|[[JCacheStorageFile::get/11.1|get]]
+
|[[API17:JCacheStorageFile::get|get]]
 
|Get cached data from a file by id and group.  
 
|Get cached data from a file by id and group.  
 
|-
 
|-
 
|public  
 
|public  
|[[JCacheStorageFile::getAll/11.1|getAll]]
+
|[[API17:JCacheStorageFile::getAll|getAll]]
 
|Get all cached data.  
 
|Get all cached data.  
 
|-
 
|-
 
|public  
 
|public  
|[[JCacheStorageFile::lock/11.1|lock]]
+
|[[API17:JCacheStorageFile::lock|lock]]
 
|Lock cached item.  
 
|Lock cached item.  
 
|-
 
|-
 
|public  
 
|public  
|[[JCacheStorageFile::remove/11.1|remove]]
+
|[[API17:JCacheStorageFile::remove|remove]]
 
|Remove a cached data file by id and group.  
 
|Remove a cached data file by id and group.  
 
|-
 
|-
 
|public  
 
|public  
|[[JCacheStorageFile::store/11.1|store]]
+
|[[API17:JCacheStorageFile::store|store]]
 
|Store the data to a file by id and group.  
 
|Store the data to a file by id and group.  
 
|-
 
|-
 
|public  
 
|public  
|[[JCacheStorageFile::unlock/11.1|unlock]]
+
|[[API17:JCacheStorageFile::unlock|unlock]]
 
|Unlock cached item.  
 
|Unlock cached item.  
 
|-
 
|-
 
|public static  
 
|public static  
|[[JCacheStorageFile::test/11.1|test]]
+
|[[API17:JCacheStorageFile::test|test]]
 
|Test to see if the cache storage is available.  
 
|Test to see if the cache storage is available.  
 
|-
 
|-
 
|}
 
|}
 
* '''Defined in''' libraries/joomla/cache/storage/file.php
 
* '''Defined in''' libraries/joomla/cache/storage/file.php
* '''Extends''' [[JCacheStorage/11.1|JCacheStorage]]
+
* '''Extends''' [[API17:JCacheStorage|JCacheStorage]]
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.cache.storage.file' );</source>
 
<source lang="php">jimport( 'joomla.cache.storage.file' );</source>
 
===See also===
 
===See also===
 
* {{JVer|11.1}} '''JCacheStorageFile source code''' on [[jplatform:cache/storage/file.php|BitBucket]]
 
* {{JVer|11.1}} '''JCacheStorageFile source code''' on [[jplatform:cache/storage/file.php|BitBucket]]
* {{JVer|11.1}} Subpackage [[Subpackage Cache/11.1|Cache]]
+
* {{JVer|11.1}} Subpackage [[API17:Subpackage Cache|Cache]]
* [[JCacheStorageFile|Other versions of JCacheStorageFile]]
+
* [[API17:JCacheStorageFile|Other versions of JCacheStorageFile]]
{{SeeAlso:JCacheStorageFile}}
+
 
<span class="editsection" style="font-size:76%;">
+
 
<nowiki>[</nowiki>[[SeeAlso:JCacheStorageFile|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
 
===User contributed notes===
 
===User contributed notes===
<CodeExamplesForm />
+
=== Code Examples ===
 
<dpl>
 
<dpl>
 
noresultsheader=\n
 
noresultsheader=\n
 
category=JCacheStorageFile
 
category=JCacheStorageFile
category=CodeExample
+
namespace=CodeExample
 
category=ClassExample
 
category=ClassExample
 
include=*
 
include=*

Latest revision as of 20:27, 24 March 2017

The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Joomla 11.1 JCacheStorageFile[edit]

Description[edit]

  • JCacheStorageFile is a concrete cache storage handler, storing the cache data in files. In the Joomla CMS the default storage directory is the cache/ directory.

Methods[edit]

Visibility Method name Description
public __construct Constructor.
public clean Clean cache for a group given a mode.
public gc Garbage collect expired cache data.
public get Get cached data from a file by id and group.
public getAll Get all cached data.
public lock Lock cached item.
public remove Remove a cached data file by id and group.
public store Store the data to a file by id and group.
public unlock Unlock cached item.
public static test Test to see if the cache storage is available.
  • Defined in libraries/joomla/cache/storage/file.php
  • Extends JCacheStorage

Importing[edit]

jimport( 'joomla.cache.storage.file' );

See also[edit]


User contributed notes[edit]

Code Examples[edit]