Difference between revisions of "JCacheStorageFile"
From Joomla! Documentation
(Bulk upload by Doxiki2) |
m (preparing for archive only) |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | + | =={{JVer|11.1}} JCacheStorageFile== | |
| − | + | ===Description=== | |
| − | + | * 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. | |
| − | {{ | + | |
| − | === | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| − | |[[JCacheStorageFile::__construct | + | |public |
| + | |[[API17:JCacheStorageFile::__construct|__construct]] | ||
|Constructor. | |Constructor. | ||
|- | |- | ||
| − | |[[JCacheStorageFile::clean | + | |public |
| + | |[[API17:JCacheStorageFile::clean|clean]] | ||
|Clean cache for a group given a mode. | |Clean cache for a group given a mode. | ||
|- | |- | ||
| − | |[[JCacheStorageFile::gc | + | |public |
| + | |[[API17:JCacheStorageFile::gc|gc]] | ||
|Garbage collect expired cache data. | |Garbage collect expired cache data. | ||
|- | |- | ||
| − | |[[JCacheStorageFile::get | + | |public |
| + | |[[API17:JCacheStorageFile::get|get]] | ||
|Get cached data from a file by id and group. | |Get cached data from a file by id and group. | ||
|- | |- | ||
| − | |[[JCacheStorageFile::getAll | + | |public |
| + | |[[API17:JCacheStorageFile::getAll|getAll]] | ||
|Get all cached data. | |Get all cached data. | ||
|- | |- | ||
| − | |[[JCacheStorageFile::lock | + | |public |
| + | |[[API17:JCacheStorageFile::lock|lock]] | ||
|Lock cached item. | |Lock cached item. | ||
|- | |- | ||
| − | |[[JCacheStorageFile::remove | + | |public |
| + | |[[API17:JCacheStorageFile::remove|remove]] | ||
|Remove a cached data file by id and group. | |Remove a cached data file by id and group. | ||
|- | |- | ||
| − | |[[JCacheStorageFile::store | + | |public |
| + | |[[API17:JCacheStorageFile::store|store]] | ||
|Store the data to a file by id and group. | |Store the data to a file by id and group. | ||
|- | |- | ||
| − | |[[JCacheStorageFile::unlock | + | |public |
| + | |[[API17:JCacheStorageFile::unlock|unlock]] | ||
|Unlock cached item. | |Unlock cached item. | ||
|- | |- | ||
| − | |[[JCacheStorageFile::test | + | |public static |
| + | |[[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 | ||
| + | * '''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}} Subpackage [[API17:Subpackage Cache|Cache]] |
| − | + | * [[API17:JCacheStorageFile|Other versions of JCacheStorageFile]] | |
| − | + | ||
| − | + | ||
| − | ===Examples=== | + | ===User contributed notes=== |
| − | + | === Code Examples === | |
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JCacheStorageFile | category=JCacheStorageFile | ||
| − | + | namespace=CodeExample | |
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
| − | <noinclude> | + | <noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude> |
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.
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]
- JCacheStorageFile source code on BitBucket
- Subpackage Cache
- Other versions of JCacheStorageFile
User contributed notes[edit]
Code Examples[edit]