diff options
Diffstat (limited to 'vendor/smarty/smarty/docs/programmers/api-functions/api-clear-cache.md')
-rw-r--r-- | vendor/smarty/smarty/docs/programmers/api-functions/api-clear-cache.md | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-cache.md b/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-cache.md new file mode 100644 index 000000000..3e17d80c8 --- /dev/null +++ b/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-cache.md @@ -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. |