Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: patTemplate

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

Abstract Class patTemplate_TemplateCache

Description

Base class for patTemplate template cache

$Id: TemplateCache.php 219 2004-05-25 20:38:38Z schst $

A template cache is used to cache the data after the template has been read, but before the variables have been added.

Data is normally stored in serialized format. This will increase performance.

This is not related to an output cache!

Located in /pattemplate/patTemplate/TemplateCache.php (line 43)

Abstract class patTemplate_Module

Abstract class patTemplate_TemplateCache   (Subpackage Caches)
Direct descendents
Class Description
ClasspatTemplate_TemplateCache_eAccelerator patTemplate Template cache that stores data in the eAccelerator Cache
ClasspatTemplate_TemplateCache_MMCache patTemplate Template cache that stores data in the eAccelerator Cache
ClasspatTemplate_TemplateCache_File patTemplate Template cache that stores data on filesystem
Method Summary
Method string getKey (mixed $input, [array $options = array()])
Method array|boolean load (string $key, [integer $modTime = -1])
Method void write (string $key, array $templates)
Methods
getKey (line 78)

get the cache key for the input

  • return: key
string getKey (mixed $input, [array $options = array()])
  • mixed $input: input to read from. This can be a string, a filename, a resource or whatever the derived class needs to read from
  • array $options: options
load (line 53)

load template from cache

  • return: either an array containing the templates or false cache could not be loaded
  • access: public
array|boolean load (string $key, [integer $modTime = -1])
  • string $key: cache key
  • integer $modTime: modification time of original template

Redefined in descendants as:
write (line 65)

write template to cache

  • access: public
void write (string $key, array $templates)
  • string $key: cache key
  • array $templates: templates to store

Redefined in descendants as:

Inherited Methods

Inherited From patTemplate_Module

 patTemplate_Module::getName()
 patTemplate_Module::getParam()
 patTemplate_Module::setParams()

Documentation generated on Mon, 05 Mar 2007 21:29:14 +0000 by phpDocumentor 1.3.1