mirror of
https://github.com/smarty-php/smarty.git
synced 2025-07-29 15:37:14 +02:00
Feature/add docs (#689)
* Add converted docs repo * Set theme jekyll-theme-minimal * Removed BC docs, added TOC * Added TOCs, rewrote most important links in documentation. Linked README to new Github Pages site * some link fixes
This commit is contained in:
60
docs/programmers/api-functions/api-clear-cache.md
Normal file
60
docs/programmers/api-functions/api-clear-cache.md
Normal file
@ -0,0 +1,60 @@
|
||||
clearCache()
|
||||
|
||||
clears the cache for a specific template
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
void
|
||||
|
||||
clearCache
|
||||
|
||||
string
|
||||
|
||||
template
|
||||
|
||||
string
|
||||
|
||||
cache\_id
|
||||
|
||||
string
|
||||
|
||||
compile\_id
|
||||
|
||||
int
|
||||
|
||||
expire\_time
|
||||
|
||||
- If you have [multiple caches](#caching.multiple.caches) for a
|
||||
template, you can clear a specific cache by supplying the `cache_id`
|
||||
as the second parameter.
|
||||
|
||||
- You can also pass a [`$compile_id`](#variable.compile.id) as a third
|
||||
parameter. You can [group templates together](#caching.groups) so
|
||||
they can be removed as a group, see the [caching section](#caching)
|
||||
for more information.
|
||||
|
||||
- As an optional fourth parameter, you can supply a minimum age in
|
||||
seconds the cache file must be before it will get cleared.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Since Smarty version 3.1.14 it is possible to delete cache files
|
||||
> by their individual expiration time at creation by passing
|
||||
> constant SMARTY::CLEAR\_EXPIRED as fourth parameter.
|
||||
|
||||
<!-- -->
|
||||
|
||||
|
||||
<?php
|
||||
// clear the cache for a template
|
||||
$smarty->clearCache('index.tpl');
|
||||
|
||||
// clear the cache for a particular cache id in an multiple-cache template
|
||||
$smarty->clearCache('index.tpl', 'MY_CACHE_ID');
|
||||
?>
|
||||
|
||||
|
||||
|
||||
See also [`clearAllCache()`](#api.clear.all.cache) and
|
||||
[`caching`](#caching) section.
|
Reference in New Issue
Block a user