Docs For Class rcube

Description

Class for output generation

abstract:

Located in /lib/Roundcube/rcube_output.php (line 26)

Direct descendents

Class	Description
rcmail_output	Class for output generation

Variable Summary

mixed $app

mixed $browser

mixed $charset

mixed $config

mixed $env

Method Summary

static string get_edit_field (string $col, string $value, array $attrib, [string $type = 'text'])

static string json_serialize (mixed $input)

rcube_output __construct ()

void future_expire_header ([int $offset = 2600000])

string get_charset ()

mixed get_env (string $name)

void nocacheing_headers ()

void raise_error (int $code, string $message)

void redirect ([mixed $p = array()], [int $delay = 1])

void reset ()

void send ()

void set_charset (string $charset)

void set_env (string $name, mixed $value)

void show_message (string $message, [string $type = 'notice'], [array $vars = null], [boolean $override = true], [int $timeout = 0])

void __get ( $var)

Variables

mixed $app (line 30)

access: protected

mixed $browser (line 28)

access: public

mixed $charset = RCUBE_CHARSET (line 32)

access: protected

mixed $config (line 31)

access: protected

mixed $env = array() (line 33)

access: protected

Methods

static get_edit_field (line 210)

Create an edit field for inclusion on a form

return: HTML field definition
access: public

string get_edit_field (string $col, string $value, array $attrib, [string $type = 'text'])

string $col: col field name
string $value: value field value
array $attrib: attrib HTML element attributes for field
string $type: type HTML element type (default 'text')

static json_serialize (line 260)

Convert a variable into a javascript object notation

return: Serialized JSON string
access: public

string json_serialize (mixed $input)

mixed $input: Input value

Constructor __construct (line 39)

Object constructor

access: public

rcube_output __construct ()

Redefined in descendants as:

rcmail_output::__construct() : Object constructor
rcmail_output_html::__construct() : Constructor

future_expire_header (line 175)

Send header with expire date 30 days in future

access: public

void future_expire_header ([int $offset = 2600000])

int $offset: Expiration time in seconds

get_charset (line 77)

Getter for output charset

return: Output charset name
access: public

string get_charset ()

get_env (line 102)

Environment variable getter.

return: Property value
access: public

mixed get_env (string $name)

string $name: Property name

nocacheing_headers (line 147)

Send HTTP headers to prevent caching a page

access: public

void nocacheing_headers ()

raise_error (line 192)

Show error page and terminate script execution

access: public

void raise_error (int $code, string $message)

int $code: Error code
string $message: Error message

Redefined in descendants as:

rcmail_output_html::raise_error() : Show error page and terminate script execution
rcmail_output_json::raise_error() : Show error page and terminate script execution

redirect (line 135)

Redirect to a certain url.

abstract:

void redirect ([mixed $p = array()], [int $delay = 1])

mixed $p: Either a string with the action or url parameters as key-value pairs
int $delay: Delay in seconds

Redefined in descendants as:

rcmail_output_html::redirect() : Redirect to a certain url
rcmail_output_json::redirect() : Redirect to a certain url

reset (line 111)

Delete all stored env variables and commands

access: public

void reset ()

Redefined in descendants as:

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

send (line 141)

Send output to the client.

abstract:

void send ()

Redefined in descendants as:

rcmail_output_html::send() : Send the request output to the client.
rcmail_output_json::send() : Send an AJAX response to the client.

set_charset (line 66)

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 name

set_env (line 89)

Set environment variable

access: public

void set_env (string $name, mixed $value)

string $name: Property name
mixed $value: Property value

Redefined in descendants as:

rcmail_output_html::set_env() : Set environment variable

show_message (line 126)

Invoke display_message command

abstract:

void show_message (string $message, [string $type = 'notice'], [array $vars = null], [boolean $override = true], [int $timeout = 0])

string $message: Message to display
string $type: Message type [notice|confirm|error]
array $vars: Key-value pairs to be replaced in localized text
boolean $override: Override last set message
int $timeout: Message displaying time in seconds

Redefined in descendants as:

rcmail_output_html::show_message() : Invoke display_message command
rcmail_output_json::show_message() : Invoke display_message command

__get (line 50)

Magic getter

access: public

void __get ( $var)

$var