BmfoPage Class Reference

List of all members.

Public Member Functions
	header ($title, $strIcon="images/bmfo.png")
	footer ($pagename, $cvsdate)
	printSelect ($strName, $arrValues, $arrRecord, $strHelp="", $boolDisabled=false, $strOnChange="", $strLabel="")
	printLabeledItem ($strName, $arrRecord, $strValue="", $strUrl="", $strLabel="")
	printTextInput ($strName, $arrRecord, $strValue="", $strHelp="", $strLabel="", $strType="text")
	printButton ($strType, $strName, $strLabel, $strHelp="")
	getTimestamp ()
	copyToSession ($arrFields, $boolReset=false)
	importantMessage ($strMessage)

---

Detailed Description

Central functions related to the page layout, standard BMFO GUI elements.

---

Member Function Documentation

BmfoPage::copyToSession (  $  arrFields, $  boolReset = false )

Copy fields from $_POST and $_REQUEST to $_SESSION, if they exist Parameters: $arrFields  is an array of field names. boolReset  is optional. Decides whether non-existing fields will be set to "". Default is false. Returns: Nothing.

BmfoPage::footer (  $  pagename, $  cvsdate )

Echo the standard BMFO footer including language selection dialog, logoff and help links. Parameters: $pagename  is the name of the current page. $cvsdate  is the page date generated by CVS. Returns: Nothing.

BmfoPage::getTimestamp (   )

Return a string timestamp that is compatible with the time format used in the database Returns: A String with the current date in ISO format.

BmfoPage::header (  $  title, $  strIcon = "images/bmfo.png" )

Create a standard BMFO page including header Parameters: $title  is the page title. $strIcon  is the path to the logo icon displayed in the header. Returns: Nothing.

BmfoPage::importantMessage (  $  strMessage  )

Echo a paragraph with an important message. Parameters: $strMessage  is the Message to be printed. Please internationalize using _(). Returns: Nothing.

BmfoPage::printButton (  $  strType, $  strName, $  strLabel, $  strHelp = "" )

Print a HTML button. Parameters: $strType  is the button type $strName  is the button name. $strLabel  is the button label. Should be internationalized by calling _(). $strHelp  is the optional onmouseover help message. Should be internationalized by calling _(). Returns: Nothing.

BmfoPage::printLabeledItem (  $  strName, $  arrRecord, $  strValue = "", $  strUrl = "", $  strLabel = "" )

Print a table row with a label and a text or link. The text is looked up from an array by default. Parameters: $strName  is the name used for the label. $arrRecord  is an associative array with the default value: $arrRecord[strName]. $strValue  is the optional text to be displayed if the array should not be used. Make sure that $arrRecord does not have a key $strName in this case. $strUrl  is the optional link URL - no link is inserted if this is empty. $strLabel  is the optional label string. Please internationalize by calling _(). Returns: Nothing.

BmfoPage::printSelect (  $  strName, $  arrValues, $  arrRecord, $  strHelp = "", $  boolDisabled = false, $  strOnChange = "", $  strLabel = "" )

Print a HTML select box and fill it with values. Parameters: $strName  is the name used for the label. $arrValues  contains the selectable values. $arrRecord  is an associative array with the selected value: arrRecord[strName]. $strHelp  is the optional onmouseover help message. $boolDisable  is an optional parameter to disable the select box. default is false. $strOnChange  is an optional JavaScript that is executed for the onChange event. $strLabel  is an optional Label that replace $strName. Please internationalize by calling _(). Returns: Nothing. Todo: Use HTML title attribute instead.

BmfoPage::printTextInput (  $  strName, $  arrRecord, $  strValue = "", $  strHelp = "", $  strLabel = "", $  strType = "text" )

Print a HTML text input and fill it with values. Parameters: $strName  is the name used for the label. $arrRecord  is an associative array with the default value: $arrRecord[$strName]. $strValue  is the optional string that is displayed if $strName is not a key in $arrRecord $strHelp  is the optional onmouseover help message. $strLabel  is the optional label string to be used instead of $strName. Please internationalize using _(). $strType  is the optional input tag type (e.g. password). Default is text. Returns: Nothing.

---

The documentation for this class was generated from the following file:

• header.php

---