Constructor
rcmail_output_html
__construct
([ $task = null], [ $framed = false])
Redefinition of:
- rcmail_output::__construct()
- Object constructor
Include content from config/about.<LANG>.html if available
void
about_content
( $attrib)
Make URLs starting with a slash point to skin directory
string
abs_url
(string $str, [boolean $search_path = false])
-
string
$str: Input string
-
boolean
$search_path: True if URL should be resolved using the current skin path stack
Add HTML code to the page footer To be added right befor </body>
void
add_footer
(string $str)
Register a GUI object to the client script
void
add_gui_object
(string $obj, string $id)
-
string
$obj: Object name
-
string
$id: Object ID
Add HTML code to the page header
void
add_header
(string $str)
Add a localized label to the client environment
void
add_label
()
Redefinition of:
- rcmail_output::add_label()
- Add a localized label to the client environment
Add inline javascript code
void
add_script
(string $script, [string $position = 'head'])
-
string
$script: JS code snippet
-
string
$position: Target position [head|head_top|foot]
Inserts hidden field with CSRF-prevention-token into POST forms
void
alter_form_tag
( $matches)
Create and register a button
string
button
(array $attrib)
-
array
$attrib: Named button attributes
GUI object 'charsetselector'
string
charset_selector
(array $attrib)
-
array
$attrib: Named parameters for the select tag
Determines if a given condition is met
boolean
check_condition
(string $condition)
-
string
$condition: Condition statement
Call a client method
void
command
(string 0, ... 1)
-
string
0: Method to call
-
...
1: Additional arguments
Redefinition of:
- rcmail_output::command()
- Call a client method
GUI object 'username' Showing IMAP username of the current session
string
current_username
(array $attrib)
-
array
$attrib: Named tag parameters (currently not used)
Parse & evaluate a given expression and return its result.
mixed
eval_expression
(string $expression)
-
string
$expression: Expression statement
Callback function for preg_replace_callback in write()
string
file_callback
( $matches)
Correct absolute paths in images and other tags
add timestamp to .js and .css filename
void
fix_paths
( $output)
Create a form tag with the necessary hidden fields
string
form_tag
(array $attrib, [ $content = null])
-
array
$attrib: Named tag parameters
-
$content
Returns iframe object, registers some related env variables
string
frame
(array $attrib, [boolean $is_contentframe = false])
-
array
$attrib: HTML attributes
-
boolean
$is_contentframe: Register this iframe as the 'contentframe' gui object
Return executable javascript code for all registered commands
string
get_js_commands
()
Getter for the current page title
string
get_pagetitle
()
Find the given file in the current skin path stack
mixed
get_skin_file
(string $file, [string &$skin_path = null], [string $add_path = null])
-
string
$file: File name/path to resolve (starting with /)
-
string
&$skin_path: Reference to the base path of the matching skin
-
string
$add_path: Additional path to search in
Callback funtion for preg_replace_callback() in parse_with_globals()
void
globals_callback
( $matches)
Link an external css file
void
include_css
(string $file)
Include a specific file and return it's contents
string
include_php
(string $file)
Link an external script file
void
include_script
(string $file, [string $position = 'head'])
-
string
$file: File URL
-
string
$position: Target position [head|foot]
Public wrapper to dipp into template parsing.
string
just_parse
(string $input)
GUI object 'loginform' Returns code for the webmail login form
string
login_form
(array $attrib)
-
array
$attrib: Named parameters
Builder for GUI object 'message'
string
message_container
(array $attrib)
-
array
$attrib: Named tag parameters
Parse a specific skin template and deliver to stdout (or return)
void
parse
([string $name = 'main'], [boolean $exit = true], [boolean $write = true])
-
string
$name: Template name
-
boolean
$exit: Exit script
-
boolean
$write: Don't write to stdout, return parsed content instead
Parse for conditional tags
string
parse_conditions
(string $input)
Replace all strings ($varname) with the content of the according global variable.
void
parse_with_globals
( $input)
Search for special tags in input and replace them with the appropriate content
string
parse_xml
(string $input)
-
string
$input: Input string to parse
GUI object 'preloader' Loads javascript code for images preloading
void
preloader
(array $attrib)
-
array
$attrib: Named parameters
Show error page and terminate script execution
void
raise_error
(int $code, string $message)
-
int
$code: Error code
-
string
$message: Error message
Redefinition of:
- rcube_output::raise_error()
- Show error page and terminate script execution
Redirect to a certain url
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
Redefinition of:
- rcube_output::redirect()
- Redirect to a certain url.
Build a form tag with a unique request token
string
request_form
(array $attrib, [string $content = ''])
-
array
$attrib: Named tag parameters including 'action' and 'task' values which will be put into hidden fields
-
string
$content: Form content
Delete all stored env variables and commands
void
reset
([bool $all = false])
-
bool
$all: Reset all env variables (including internal)
Redefinition of:
- rcmail_output::reset()
- Delete all stored env variables and commands
GUI object 'searchform' Returns code for search function
string
search_form
(array $attrib)
-
array
$attrib: Named parameters
Send the request output to the client.
This will either parse a skin tempalte or send an AJAX response
void
send
([string $templ = null], [boolean $exit = true])
-
string
$templ: Template name
-
boolean
$exit: True if script should terminate (default)
Redefinition of:
- rcube_output::send()
- Send output to the client.
Set environment variable
void
set_env
(string $name, mixed $value, [boolean $addtojs = true])
-
string
$name: Property name
-
mixed
$value: Property value
-
boolean
$addtojs: True if this property should be added to client environment
Redefinition of:
- rcube_output::set_env()
- Set environment variable
Set skin
void
set_skin
( $skin)
Invoke display_message command
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 display time in seconds
Redefinition of:
- rcube_output::show_message()
- Invoke display_message command
Check if a specific template exists
boolean
template_exists
(string $name)
-
string
$name: Template name
Process template and write to stdOut
void
write
([string $template = ''])
-
string
$template: HTML template content
Redefined in descendants as:
Callback function for parsing an xml command tag and turn it into real html content
string
xml_command
(array $matches)
-
array
$matches: Matches array of preg_replace_callback
Process template and write to stdOut
void
_write
([string $templ = ''], [string $base_path = ''])
-
string
$templ: HTML template
-
string
$base_path: Base for absolute paths
Inherited Methods
Inherited From rcmail_output
rcmail_output::__construct()
rcmail_output::add_handler()
rcmail_output::add_handlers()
rcmail_output::add_label()
rcmail_output::command()
rcmail_output::get_skin_path()
rcmail_output::reset()
rcmail_output::set_pagetitle()
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()