Docs For Class rcmail

Description

Class for output generation

abstract:

Located in /include/rcmail_output.php (line 28)

rcube_output
   |
   --rcmail_output

Direct descendents

Class	Description
rcmail_output_html	Class to create HTML page output using a skin template
rcmail_output_json	View class to produce JSON responses

Class Constant Summary

JS_OBJECT_NAME = 'rcmail'

Variable Summary

mixed $ajax_call

mixed $framed

mixed $object_handlers

mixed $pagetitle

mixed $type

Method Summary

rcmail_output __construct ([ $task = null], [ $framed = false])

void add_handler (string $obj, string $func)

void add_handlers (array $arr)

void add_label ()

void command (string 0, ... 1)

void get_skin_path ()

void reset ()

void set_pagetitle (string $title)

Variables

mixed $ajax_call = false (line 33)

access: public

Redefined in descendants as:

rcmail_output_json::$ajax_call

mixed $framed = false (line 34)

access: public

mixed $object_handlers = array() (line 37)

access: protected

mixed $pagetitle = '' (line 36)

access: protected

mixed $type = 'html' (line 32)

access: public

Redefined in descendants as:

Inherited Variables

Inherited from rcube_output

rcube_output::$app
rcube_output::$browser
rcube_output::$charset
rcube_output::$config
rcube_output::$env

Methods

Constructor __construct (line 43)

Object constructor

access: public

rcmail_output __construct ([ $task = null], [ $framed = false])

$task
$framed

Redefinition of:

rcube_output::__construct(): Object constructor

Redefined in descendants as:

rcmail_output_html::__construct() : Constructor

add_handler (line 103)

Register a template object handler

access: public

void add_handler (string $obj, string $func)

string $obj: Object name
string $func: Function name to call

Redefined in descendants as:

rcmail_output_json::add_handler() : Register a template object handler

add_handlers (line 115)

Register a list of template object handlers

access: public

void add_handlers (array $arr)

array $arr: Hash array with object=>handler pairs

Redefined in descendants as:

rcmail_output_json::add_handlers() : Register a list of template object handlers

add_label (line 93)

Add a localized label to the client environment

abstract:

void add_label ()

Redefined in descendants as:

rcmail_output_html::add_label() : Add a localized label to the client environment
rcmail_output_json::add_label() : Add a localized label to the client environment

command (line 87)

Call a client method

abstract:

void command (string 0, ... 1)

string 0: Method to call
... 1: Additional arguments

Redefined in descendants as:

rcmail_output_html::command() : Call a client method
rcmail_output_json::command() : Call a client method

get_skin_path (line 63)

Getter for the current skin path property

access: public

void get_skin_path ()

reset (line 72)

Delete all stored env variables and commands

access: public

void reset ()

Redefinition of:

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

Redefined in descendants as:

rcmail_output_html::reset() : Delete all stored env variables and commands
rcmail_output_json::reset() : Delete all stored env variables and commands

set_pagetitle (line 54)

Setter for page title

access: public

void set_pagetitle (string $title)

string $title: Page title

Redefined in descendants as:

rcmail_output_json::set_pagetitle() : Issue command to set page title

Inherited Methods

Inherited From rcube_output

rcube_output::__construct()
rcube_output::future_expire_header()
rcube_output::get_charset()
rcube_output::get_edit_field()
rcube_output::get_env()
rcube_output::json_serialize()
rcube_output::nocacheing_headers()
rcube_output::raise_error()
rcube_output::redirect()
rcube_output::reset()
rcube_output::send()
rcube_output::set_charset()
rcube_output::set_env()
rcube_output::show_message()
rcube_output::__get()

Class Constants

JS_OBJECT_NAME = 'rcmail' (line 30)