PHP Classes

File: htdocs/xoops_lib/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-cache.md

Recommend this page to a friend!
  Packages of Michael Beck   Xoops 2.5   htdocs/xoops_lib/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-cache.md   Download  
File: htdocs/xoops_lib/vendor/smarty/smarty/docs/programmers/api-functions/api-clear-cache.md
Role: Example script
Content type: text/markdown
Description: Example script
Class: Xoops 2.5
Modular content management publication system
Author: By
Last change:
Date: 1 month ago
Size: 1,270 bytes
 

Contents

Class file image Download

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 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 as a third parameter. You can group templates together so they can be removed as a group, see the caching section 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() and caching section.