Roundcube Webmail
Back to top  

rcmail_output

Extends \rcube_output

Class for output generation

package

Webmail
subpackage

View

Methods

Object constructor

__construct()
inherited

Setter for page title

set_pagetitle(string $title)

Arguments

$title

string

Page title

Getter for the current skin path property

get_skin_path()

Delete all stored env variables and commands

reset()
inherited

Call a client method

command()
abstract

Add a localized label to the client environment

add_label()
abstract

Register a template object handler

add_handler($obj, $func) : void

Arguments

$obj

$func

Register a list of template object handlers

add_handlers($arr) : void

Arguments

$arr

Magic getter

__get($var)
inherited

Arguments

$var

Setter for output charset.

set_charset(string $charset)
inherited

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

Arguments

$charset

string

Charset name

Getter for output charset

get_charset() : string
inherited

Response

string

Output charset name

Set environment variable

set_env(string $name, mixed $value)
inherited

Arguments

$name

string

Property name

$value

mixed

Property value

Environment variable getter.

get_env(string $name) : mixed
inherited

Arguments

$name

string

Property name

Response

mixed

Property value

Invoke display_message command

show_message(string $message, string $type = 'notice', array $vars = null, boolean $override = true, int $timeout)
inherited abstract

Arguments

$message

string

Message to display

$type

string

Message type [notice|confirm|error]

$vars

array

Key-value pairs to be replaced in localized text

$override

boolean

Override last set message

$timeout

int

Message displaying time in seconds

Redirect to a certain url.

redirect(mixed $p = array(), int $delay = 1)
inherited abstract

Arguments

$p

mixed

Either a string with the action or url parameters as key-value pairs

$delay

int

Delay in seconds

Send output to the client.

send()
inherited abstract

Send HTTP headers to prevent caching a page

nocacheing_headers()
inherited

Send header with expire date 30 days in future

future_expire_header($offset = 2600000)
inherited

Arguments

$offset

Show error page and terminate script execution

raise_error(int $code, string $message)
inherited

Arguments

$code

int

Error code

$message

string

Error message

Create an edit field for inclusion on a form

get_edit_field($col, $value, $attrib, $type = 'text') : string
inherited static

Arguments

$col

$value

$attrib

$type

Response

string

HTML field definition

Convert a variable into a javascript object notation

json_serialize($input) : string
inherited static

Arguments

$input

Response

string

Serialized JSON string

Constants

JS_OBJECT_NAME

JS_OBJECT_NAME

Properties

type

type :

ajax_call

ajax_call :

framed

framed :

pagetitle

pagetitle :

object_handlers

object_handlers :

browser

browser :
inherited

app

app :
inherited

config

config :
inherited

charset

charset :
inherited

env

env :
inherited