API17:JCacheStorageFile
From Joomla! Documentation
(Difference between revisions)
(Bulk upload by Doxiki2) |
m (→User contributed notes: bad link repair) |
||
| (2 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|11.1}} JCacheStorageFile== | ||
| + | ===Description=== | ||
| + | {{Description:JCacheStorageFile}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JCacheStorageFile|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JCacheStorageFile|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public | ||
|[[JCacheStorageFile::__construct/11.1|__construct]] | |[[JCacheStorageFile::__construct/11.1|__construct]] | ||
|Constructor. | |Constructor. | ||
|- | |- | ||
| + | |public | ||
|[[JCacheStorageFile::clean/11.1|clean]] | |[[JCacheStorageFile::clean/11.1|clean]] | ||
|Clean cache for a group given a mode. | |Clean cache for a group given a mode. | ||
|- | |- | ||
| + | |public | ||
|[[JCacheStorageFile::gc/11.1|gc]] | |[[JCacheStorageFile::gc/11.1|gc]] | ||
|Garbage collect expired cache data. | |Garbage collect expired cache data. | ||
|- | |- | ||
| + | |public | ||
|[[JCacheStorageFile::get/11.1|get]] | |[[JCacheStorageFile::get/11.1|get]] | ||
|Get cached data from a file by id and group. | |Get cached data from a file by id and group. | ||
|- | |- | ||
| + | |public | ||
|[[JCacheStorageFile::getAll/11.1|getAll]] | |[[JCacheStorageFile::getAll/11.1|getAll]] | ||
|Get all cached data. | |Get all cached data. | ||
|- | |- | ||
| + | |public | ||
|[[JCacheStorageFile::lock/11.1|lock]] | |[[JCacheStorageFile::lock/11.1|lock]] | ||
|Lock cached item. | |Lock cached item. | ||
|- | |- | ||
| + | |public | ||
|[[JCacheStorageFile::remove/11.1|remove]] | |[[JCacheStorageFile::remove/11.1|remove]] | ||
|Remove a cached data file by id and group. | |Remove a cached data file by id and group. | ||
|- | |- | ||
| + | |public | ||
|[[JCacheStorageFile::store/11.1|store]] | |[[JCacheStorageFile::store/11.1|store]] | ||
|Store the data to a file by id and group. | |Store the data to a file by id and group. | ||
|- | |- | ||
| + | |public | ||
|[[JCacheStorageFile::unlock/11.1|unlock]] | |[[JCacheStorageFile::unlock/11.1|unlock]] | ||
|Unlock cached item. | |Unlock cached item. | ||
|- | |- | ||
| + | |public static | ||
|[[JCacheStorageFile::test/11.1|test]] | |[[JCacheStorageFile::test/11.1|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''' [[JCacheStorage/11.1|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=== | ||
| − | * [[JCacheStorageFile|Other versions of | + | * {{JVer|11.1}} '''JCacheStorageFile source code''' on [[jplatform:cache/storage/file.php|BitBucket]] |
| + | * {{JVer|11.1}} Subpackage [[Subpackage Cache/11.1|Cache]] | ||
| + | * [[JCacheStorageFile|Other versions of JCacheStorageFile]] | ||
{{SeeAlso:JCacheStorageFile}} | {{SeeAlso:JCacheStorageFile}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JCacheStorageFile|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JCacheStorageFile|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | === | + | ===User contributed notes=== |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 64: | Line 74: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
| − | <noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JCacheStorageFile]]</noinclude> | + | <noinclude>[[Category:Platform JClasses]][[Category:Platform 11.1]][[Category:JCacheStorageFile]]</noinclude> |
Revision as of 13:31, 29 August 2012
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 cache/ directory.
[Edit Descripton]
Methods
| 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
jimport( 'joomla.cache.storage.file' );
See also
- JCacheStorageFile source code on BitBucket
- Subpackage Cache
- Other versions of JCacheStorageFile
SeeAlso:JCacheStorageFile [Edit See Also]
User contributed notes
<CodeExamplesForm />
