PHP. notebook

Summary
Boolean, if this notebook has been loaded already
Get the current page identifier.
Get all variables used by the notebook
Determine if the form has been cancelled
Boolean, whether the form is ready to be processed
Adds a new “page” to the end of the notebook
Gets the HTML code for the current view of the notebook
Get the HTML code for the notebook button bars when displayed at the top of the notebook.
Get the HTML code for the notebook button bars when displayed at the left or right of the notebook.
Get HTML code for embedding variables that are not displayed in the current page in INPUT TYPE=HIDDEN tags.

Functions

been_here

function been_here ($null_var =  "")

Returns

Boolean, if this notebook has been loaded already

get_current_page

function get_current_page ($action =  NULL)

Get the current page identifier.

Parameters

$action(optional) Value passed by action button.  Defaults to pulling from the global scope.

Returns

Returns the current page of the notebook

get_vars

function get_vars ($null_var =  "")

Get all variables used by the notebook

Returns

Array of all variables used by the notebook

is_cancelled

function is_cancelled ($null_var =  "")

Determine if the form has been cancelled

Returns

Boolean, whether the form has been cancelled

is_done

function is_done ($null_var =  "")

Returns

Boolean, whether the form is ready to be processed

add_page

function add_page ($page_name,  
$page_vars,  
$page_text,  
$error = NULL,
$warning = NULL)

Adds a new “page” to the end of the notebook

Parameters

$page_nameText name of the notebook page
$page_varsArray of variables that are defined on this page
$textText of this notebook page
$err(optional) Array of error conditions
$warn(optional) Array of warning conditions

display

function display ($null_var =  "")

Gets the HTML code for the current view of the notebook

Returns

XHTML-compliant notebook widget code

display_notebook_bar

function display_notebook_bar($page_to_display)

Get the HTML code for the notebook button bars when displayed at the top of the notebook.

Parameters

$page_to_displayNumber of current page.  This has to be looked up.

Returns

XHTML-compliant notebook button code

See Also

display_notebook_sidebar

display_notebook_sidebar

function display_notebook_sidebar($page_to_display)

Get the HTML code for the notebook button bars when displayed at the left or right of the notebook.

Parameters

$page_to_displayNumber of current page.  This has to be looked up.

Returns

XHTML-compliant notebook button code

See Also

display_notebook_bar

display_hidden_variables

function display_hidden_variables($__page_to_display)

Get HTML code for embedding variables that are not displayed in the current page in INPUT TYPE=HIDDEN tags.  Properly handles arrays.

Parameters

$__page_to_displayNumber of the page to be displayed

Returns

XHTML-compliant hidden variable code

function been_here ($null_var =  "")
Boolean, if this notebook has been loaded already
function get_current_page ($action =  NULL)
Get the current page identifier.
function get_vars ($null_var =  "")
Get all variables used by the notebook
function is_cancelled ($null_var =  "")
Determine if the form has been cancelled
function is_done ($null_var =  "")
Boolean, whether the form is ready to be processed
function add_page ($page_name,  
$page_vars,  
$page_text,  
$error = NULL,
$warning = NULL)
Adds a new “page” to the end of the notebook
function display ($null_var =  "")
Gets the HTML code for the current view of the notebook
function display_notebook_bar($page_to_display)
Get the HTML code for the notebook button bars when displayed at the top of the notebook.
function display_notebook_sidebar($page_to_display)
Get the HTML code for the notebook button bars when displayed at the left or right of the notebook.
function display_hidden_variables($__page_to_display)
Get HTML code for embedding variables that are not displayed in the current page in INPUT TYPE=HIDDEN tags.