Roundcube Framework
Back to top  

rcube_output

Class for output generation

package

Framework
subpackage

View

Methods

Object constructor

__construct()

Magic getter

__get( $var)

Arguments

$var

Send browser compatibility/security/etc. headers

common_headers()

Send header with expire date 30 days in future

future_expire_header( $offset = 2600000)

Arguments

$offset

Getter for output charset

get_charset() : string

Response

string

Output charset name

Create an edit field for inclusion on a form

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

Arguments

$col

string

Field name

$value

string

Field value

$attrib

array

HTML element attributes for the field

$type

string

HTML element type (default 'text')

Response

string

HTML field definition

Environment variable getter.

get_env(string $name) : mixed

Arguments

$name

string

Property name

Response

mixed

Property value

Convert a variable into a javascript object notation

json_serialize(mixed $input, boolean $pretty = false) : string
static

Arguments

$input

mixed

Input value

$pretty

boolean

Enable JSON formatting

Response

string

Serialized JSON string

Send HTTP headers to prevent caching a page

nocacheing_headers()

Show error page and terminate script execution

raise_error(integer $code, string $message)

Arguments

$code

integer

Error code

$message

string

Error message

Redirect to a certain url.

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

Arguments

$p

mixed

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

$delay

integer

Delay in seconds

Delete all stored env variables and commands

reset()

Send output to the client.

send()
abstract

Setter for output charset.

set_charset(string $charset)

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

Arguments

$charset

string

Charset name

Set environment variable

set_env(string $name, mixed $value)

Arguments

$name

string

Property name

$value

mixed

Property value

Invoke display_message command

show_message(string $message, string $type = 'notice', array $vars = null, boolean $override = true, integer $timeout)
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

integer

Message displaying time in seconds

Properties

browser

browser :

Type(s)

app

app :

Type(s)

config

config :

Type(s)

charset

charset :

Type(s)

env

env :

Type(s)

skins

skins :

Type(s)