Docs For Class rcube_html

Description

Class for HTML page creation

usedby: rcube_template.php
usedby: rcube_template

Located in /rcube_html_page.php (line 30)

Direct descendents

Class	Description
rcube_template	Class to create HTML page output using a skin template

Variable Summary

mixed $base_path

mixed $body

mixed $charset

mixed $css_files

mixed $default_template

mixed $footer

mixed $header

mixed $scripts

mixed $scripts_path

mixed $script_files

mixed $title

Method Summary

rcube_html_page __construct ()

void add_footer (string $str)

void add_header (string $str)

void add_script (string $script, [string $position = 'head'])

string get_charset ()

void include_css (string $file)

void include_script (string $file, [string $position = 'head'])

void reset ()

void set_charset (string $charset)

void set_title (string $t)

void write ([string $templ = ''], [string $base_path = ''])

Variables

mixed $base_path = '' (line 43)

access: protected

mixed $body = '' (line 42)

access: protected

mixed $charset = RCMAIL_CHARSET (line 36)

access: protected

mixed $css_files = array() (line 34)

access: protected

mixed $default_template = "<html>\n<head><title></title></head>\n<body></body>\n</html>" (line 37)

access: protected

mixed $footer = '' (line 41)

access: protected

mixed $header = '' (line 40)

access: protected

mixed $scripts = array() (line 35)

access: protected

mixed $scripts_path = '' (line 32)

access: protected

mixed $script_files = array() (line 33)

access: protected

mixed $title = '' (line 39)

access: protected

Methods

Constructor __construct (line 47)

Constructor

access: public

rcube_html_page __construct ()

Redefined in descendants as:

rcube_template::__construct() : Constructor

add_footer (line 121)

Add HTML code to the page footer To be added right befor </body>

access: public

void add_footer (string $str)

string $str: HTML code

add_header (line 110)

Add HTML code to the page header

access: public

void add_header (string $str)

string $str: HTML code

add_script (line 85)

Add inline javascript code

access: public

void add_script (string $script, [string $position = 'head'])

string $script: JS code snippet
string $position: Target position [head|head_top|foot]

get_charset (line 152)

Getter for output charset

return: Output charset
access: public

string get_charset ()

include_css (line 100)

Link an external css file

access: public

void include_css (string $file)

string $file: File URL

include_script (line 55)

Link an external script file

access: public

void include_script (string $file, [string $position = 'head'])

string $file: File URL
string $position: Target position [head|foot]

reset (line 160)

Reset all saved properties

access: public

void reset ()

Redefined in descendants as:

rcube_template::reset() : Delete all stored env variables and commands

set_charset (line 142)

Setter for output charset.

To be specified in a meta tag and sent as http-header

access: public

void set_charset (string $charset)

string $charset: Charset

set_title (line 131)

Setter for page title

access: public

void set_title (string $t)

string $t: Page title

write (line 176)

Process template and write to stdOut

access: public

void write ([string $templ = ''], [string $base_path = ''])

string $templ: HTML template
string $base_path: Base for absolute paths

Redefined in descendants as:

rcube_template::write() : Process template and write to stdOut