Docs For Class Template

Description

Handles the complete Templatesystem

since: PHPOpenChat 3.0.0
version: $Id: class Template.inc,v 1.0 2002/09/25
access: public
author: Sascha Ragtschaa <sascha@ragtschaa.com>
author: Michael Oertel <michael@ortelius.de>

Located in /include/class.Template.inc (line 44)

Variable Summary

mixed $cache_it

mixed $include_path

mixed $max_age

mixed $old_theme

mixed $poc_web_root

mixed $template

string $theme

mixed $tmpl_sys_path

mixed $tmpl_web_path

mixed $web_root

Method Summary

Template Template ([mixed $theme = null])

string filter_placeholder (string $string)

string get_cached_content (string $max_age)

string get_image_tag ($dir $dir)

void get_include_path ()

void get_language_template ([mixed $template = null])

string get_path (mixed $path)

string get_poc_web_root ()

void get_template ([mixed $template = null], [mixed $path_only = false])

string get_theme ()

string; get_theme_option_list ()

void get_theme_path ()

string get_tmpl_sys_path ()

string get_tmpl_web_path ()

void set_theme (string $theme)

void _build_pathes ([mixed $old_theme = null])

string _calculate_cacheId ()

void _check_pathes (mixed $file)

mixed _find_template ([string $template = null])

boolean _put_into_cache (string $content)

Variables

mixed $cache_it = false (line 62)

mixed $include_path = '' (line 56)

mixed $max_age = 0 (line 63)

mixed $old_theme = null (line 54)

mixed $poc_web_root = null (line 58)

mixed $template = '' (line 61)

string $theme = '' (line 53)

Contains the name of current theme

access: private

mixed $tmpl_sys_path = null (line 60)

mixed $tmpl_web_path = null (line 59)

mixed $web_root = null (line 57)

Methods

Constructor Template (line 70)

Constructor

access: public

Template Template ([mixed $theme = null])

filter_placeholder (line 391)

Filters the given string and replaces some placeholders

see: Template::get_path()

string filter_placeholder (string $string)

string $string

get_cached_content (line 279)

Provides content from cache

string get_cached_content (string $max_age)

string $max_age: maximum age for the cached content

get_image_tag (line 402)

Provides an img tag of an image of current chatter if available

string get_image_tag ($dir $dir)

$dir $dir: string

get_include_path (line 145)

void get_include_path ()

get_language_template (line 243)

Searches for a template in right language, if such template not found

Searches for a template in right language, if such template not found the template in default language will be returned

access: public

void get_language_template ([mixed $template = null])

get_path (line 317)

Provides the path to the current theme

string get_path (mixed $path)

get_poc_web_root (line 329)

Provides the web path to POC

string get_poc_web_root ()

get_template (line 201)

Provides the template with path and outputs html

access: public

void get_template ([mixed $template = null], [mixed $path_only = false])

get_theme (line 269)

Provides the current choosen theme

string get_theme ()

get_theme_option_list (line 362)

Provides all installed themes as an option list

return: html options

string; get_theme_option_list ()

get_theme_path (line 310)

void get_theme_path ()

get_tmpl_sys_path (line 339)

Provides the path to the current theme

string get_tmpl_sys_path ()

get_tmpl_web_path (line 304)

Provides the path to the current theme

string get_tmpl_web_path ()

set_theme (line 349)

Sets the current theme

void set_theme (string $theme)

string $theme

_build_pathes (line 89)

void _build_pathes ([mixed $old_theme = null])

_calculate_cacheId (line 131)

Calculates a unique key to store data in the db

access: private

string _calculate_cacheId ()

_check_pathes (line 84)

void _check_pathes (mixed $file)

_find_template (line 157)

Finds the given template in the POC-install-directory tree

access: private

mixed _find_template ([string $template = null])

string $template

_put_into_cache (line 186)

Puts content into the cache

access: private

boolean _put_into_cache (string $content)

string $content