mosHTML::BackButton

Last reviewed: Not reviewed
phpDocumentor

mosHTML::BackButton

Displays a standard back button. The text for the button will be taken from the current language settings.  The button is created with a CSS class of 'back_button'.

Syntax

void BackButton ( object &$params [, boolean $enable] )

$params
is an object of type mosParameters. If $params->get( 'back_button' ) is false then this function will not produce any output. If $params->get( 'popup' ) is true then this function will not produce any output (in other words, the back button will be suppressed if the window is a pop-up).
$hide_js
is a flag. If true then this function will not produce any output. The flag is optional and if omitted will default to false.

Examples

Example: This example uses the global configuration 'back_button' setting.
global $mainframe;
 
// Set-up the parameters object.
$params = & new mosParameters( '' );
$params->def( 'back_button', $mainframe->getCfg( 'back_button' ));
$params->def( 'popup', false );
 
// Draw the Back button.
mosHTML::BackButton( $params );

Please report any errors on this page to the Developer Documentation Forum.


Last Updated ( Thursday, 26 October 2006 )