[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/joomla/template/ -> template.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id: template.php 14401 2010-01-26 14:10:00Z louis $
File Size: 208 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

JTemplate:: (9 methods):
  JTemplate()
  __construct()
  getInstance()
  parse()
  display()
  fetch()
  enableTemplateCache()
  setTemplateCachePrefix()
  _loadTemplatesFromCache()


Class: JTemplate  - X-Ref

Template class, provides an easy interface to parse and display a template file

JTemplate()   X-Ref
A hack to support __construct() on PHP 4
Hint: descendant classes have no PHP4 class_name() constructors,
so this constructor gets called first and calls the top-layer __construct()
which (if present) should call parent::__construct()

return: Object

__construct()   X-Ref
Class constructor

The type influences the tags you are using in your templates.


getInstance( $type = 'html' )   X-Ref
Returns a reference to a global Template object, only creating it
if it doesn't already exist.

param: string    $type (either html or tex)
return: jtemplate A template object

parse( $file )   X-Ref
Parse a file

param: string     $file    The filename

display( $name )   X-Ref
Execute and display a the template

param: string     $name        The name of the template

fetch( $name )   X-Ref
Returns a parsed template

param: string     $name        The name of the template

enableTemplateCache( $handler, $folder )   X-Ref
enable a template cache

A template cache will improve performace, as the templates
do not have to be read on each request.

param: string        name of the template cache
param: string        folder to store the cached files
return: boolean        true on success, patError otherwise

setTemplateCachePrefix( $prefix )   X-Ref
Set the prefix of the template cache

param: string        the prefix of the template cache
return: boolean        true on success, patError otherwise

_loadTemplatesFromCache( $input, &$reader, $options, $key )   X-Ref
load from template cache

param: string    name of the input (filename, shm segment, etc.)
param: string    driver that is used as reader, you may also pass a Reader object
param: array    options for the reader
param: string    cache key
return: array|boolean    either an array containing the templates, or false



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1