MIOLO: MForm Class Reference

MForm::__construct	(	$	title = `''`,
		$	action = `''`,
		$	close = `''`,
		$	icon = `''`,
		$	help = `''`
	)

This is the constructor of the Form class. It takes a title and an action url as optional parameters. The action URL is typically obtained by calling the MIOLO->GetActionURL() method.

Parameters:

	$title	(string) the form's title string
	$action	(string) the URL for the forms `ACTION` attribute.

Definition at line 132 of file mform.class.

References $action, $help, $title, CreateFields(), GetFormFields(), and IsSubmitted().

Here is the call graph for this function:

MForm::__set	(	$	name,
		$	value
	)

Brief Description. Complete Description.

Parameters:

	$name	(tipo) desc
	$value	(tipo) desc

Returns:: (tipo) desc

Reimplemented from MControl.

Definition at line 165 of file mform.class.

References MComponent::$name.

MForm::__get ( $ name )

Brief Description. Complete Description.

Parameters:

$name

(tipo) desc

Returns:: (tipo) desc

Reimplemented from MControl.

Definition at line 181 of file mform.class.

References MComponent::$name.

MForm::OnLoad ( )

Brief Description. Complete Description.

Returns:: (tipo) desc

Definition at line 194 of file mform.class.

MForm::CreateFields ( )

Brief Description. Complete Description.

Returns:: (tipo) desc

Definition at line 206 of file mform.class.

Referenced by __construct().

Here is the caller graph for this function:

MForm::AddValidator ( $ validator )

Brief Description. Complete Description.

Parameters:

$validator

(tipo) desc

Returns:: (tipo) desc

Definition at line 220 of file mform.class.

References MComponent::$name.

Referenced by GenerateLayoutFields(), and SetValidators().

Here is the caller graph for this function:

MForm::SetValidators ( $ validators )

Brief Description. Complete Description.

Parameters:

$validators

(tipo) desc

Returns:: (tipo) desc

Definition at line 246 of file mform.class.

References AddValidator().

Here is the call graph for this function:

MForm::IsSubmitted ( )

Brief Description. Complete Description.

Returns:: (tipo) desc

Definition at line 274 of file mform.class.

References GetFormValue().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

MForm::GetTitle ( )

Brief Description. Complete Description.

Returns:: (tipo) desc

Definition at line 302 of file mform.class.

MForm::SetTitle ( $ title )

Brief Description. Complete Description.

Parameters:

$title

(tipo) desc

Returns:: (tipo) desc

Definition at line 320 of file mform.class.

References $title.

MForm::SetClose ( $ action )

Brief Description. Complete Description.

Parameters:

$action

(tipo) desc

Returns:: (tipo) desc

Definition at line 339 of file mform.class.

References $action.

MForm::SetIcon ( $ icon )

Brief Description. Complete Description.

Parameters:

$icon

(tipo) desc

Returns:: (tipo) desc

Definition at line 360 of file mform.class.

MForm::SetAlternate	(	$	color0,
		$	color1
	)

Definition at line 368 of file mform.class.

MForm::GetFooter ( )

Brief Description. Complete Description.

Returns:: (tipo) desc

Definition at line 388 of file mform.class.

MForm::SetFooter ( $ footer )

Form's footer. Sets the form's footer content.

Parameters:

$footer

(tipo) desc

Definition at line 400 of file mform.class.

References $footer.

MForm::GetFormFields ( )

Brief Description. Complete Description.

Returns:: (tipo) desc

Definition at line 417 of file mform.class.

References _GetFormFieldValue().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

MForm::_GetFormFieldValue ( $ field )

Brief Description. Complete Description.

Parameters:

$field

(tipo) desc

Returns:: (tipo) desc

Definition at line 432 of file mform.class.

Referenced by GetFormFields().

Here is the caller graph for this function:

MForm::GetFormValue	(	$	name,
		$	value = `NULL`
	)

Brief Description. Complete Description.

Parameters:

	$name	(tipo) desc
	$value	(tipo) desc

Returns:: (tipo) desc

Definition at line 478 of file mform.class.

References MComponent::$name, and MIOLO::_REQUEST().

Referenced by CollectInput(), and IsSubmitted().

Here is the call graph for this function:

Here is the caller graph for this function:

MForm::SetFormValue	(	$	name,
		$	value
	)

Brief Description. Complete Description.

Parameters:

	$name	(tipo) desc
	$value	(tipo) desc

Returns:: (tipo) desc

Definition at line 508 of file mform.class.

References MComponent::$name, and EscapeValue().

Here is the call graph for this function:

MForm::EscapeValue ( $ value ) [private]

Used to escapes special characters contained in a form field's value Currently, only simple and double quote characters are subsituted with their corresponding HTML entities.

This function is used internally by some of the form's methods.

Returns:: (string) the translated string

Definition at line 528 of file mform.class.

Referenced by _RegisterField(), MTabbedForm2::AddPage(), and SetFormValue().

Here is the caller graph for this function:

MForm::OnSubmit ( $ jscode )

Brief Description. Complete Description.

Parameters:

$jscode

(tipo) desc

Returns:: (tipo) desc

Definition at line 565 of file mform.class.

Referenced by GenerateScript().

Here is the caller graph for this function:

MForm::AddJsCode ( $ jscode )

Brief Description. Complete Description.

Parameters:

$jscode

(tipo) desc

Returns:: (tipo) desc

Definition at line 580 of file mform.class.

MForm::SetAction ( $ action )

Brief Description. Complete Description.

Parameters:

$action

(tipo) desc

Returns:: (tipo) desc

Definition at line 600 of file mform.class.

References $action.

MForm::setHelp	(	$	help,
		$	module = `null`,
		$	action = `null`
	)

Brief Description. Complete Description.

Parameters:

$href

(tipo) desc

Returns:: (tipo) desc

Definition at line 620 of file mform.class.

References $action, and $help.

MForm::GetFields ( ) [private]

Obtain the list of form fields.

Deprecated:: this function will be changed in the near future, so don't use it anymore and keep in touch with the development team to figure out, what will be the replacement.

Returns:: (array) the list of form fields

Definition at line 652 of file mform.class.

MForm::SetFields ( &$ fields )

Brief Description. Complete Description.

Parameters:

&$fields

(tipo) desc

Returns:: (tipo) desc

Definition at line 670 of file mform.class.

References $fields, and _RegisterField().

Here is the call graph for this function:

MForm::_RegisterField ( $ field ) [private]

This function is used internally of the form framework to prepare the form fields for the usage within the form framework.

The function basically renames all fields to 'frm_' + name and assigns the value from the global array $HTTP_POST_VARS if the field has no value (null) assigned.

Parameters:

$field

(reference) to a single field or an array of fields If an array of fields is passed, the function is called recursively for each of the contained fields.

Returns:: (nothing)

Definition at line 696 of file mform.class.

References MComponent::$className, AddFields(), and EscapeValue().

Referenced by AddField(), and SetFields().

Here is the call graph for this function:

Here is the caller graph for this function:

MForm::AddField	(	$	field,
		$	hint = `false`
	)

Brief Description. Complete Description.

Parameters:

	$field	(tipo) desc
	$hint	(tipo) desc

Returns:: (tipo) desc

Definition at line 791 of file mform.class.

References _RegisterField().

Referenced by AddFields(), MCompoundForm::CompoundFields(), and MCSSForm::SetField().

Here is the call graph for this function:

Here is the caller graph for this function:

MForm::AddFields ( $ fields )

Brief Description. Complete Description.

Parameters:

$fields

(tipo) desc

Returns:: (tipo) desc

Definition at line 812 of file mform.class.

References $fields, and AddField().

Referenced by _RegisterField().

Here is the call graph for this function:

Here is the caller graph for this function:

MForm::AddButton ( $ btn )

Brief Description. Complete Description.

Parameters:

&$btn

(tipo) desc

Returns:: (tipo) desc

Definition at line 843 of file mform.class.

Referenced by SetButtons().

Here is the caller graph for this function:

MForm::SetButtons ( $ btn )

Brief Description. Complete Description.

Parameters:

&$btn

(tipo) desc

Returns:: (tipo) desc

Definition at line 862 of file mform.class.

References AddButton().

Here is the call graph for this function:

MForm::setButtonLabel	(	$	index,
		$	label
	)

Set the buttons labels. This function is mainly used, to change the labels of the form's default buttons for submit and return.

Parameters:

	$index	(integer) the 0 based index of the button
	$label	(string) the new button label

Definition at line 885 of file mform.class.

MForm::showReturn ( $ state )

Deprecated:: This method is deprecated, use setShowReturnButton instead.

Definition at line 893 of file mform.class.

References setShowReturnButton().

Here is the call graph for this function:

MForm::setShowReturnButton ( $ state )

Return button visibility. This function can be used to show or hide the form's return button.

Parameters:

$state

(boolean) the visible state of the return button

Definition at line 904 of file mform.class.

Referenced by showReturn().

Here is the caller graph for this function:

MForm::setShowPostButton ( $ state )

Post button visibility. Use this method to set the visibility of the Post Button.

Parameters:

$state

(boolean) the visible state of the Post Button

Definition at line 915 of file mform.class.

MForm::showReset ( $ state )

Deprecated:: This method is deprecated, use setShowResetButton instead.

Definition at line 923 of file mform.class.

References setShowResetButton().

Here is the call graph for this function:

MForm::setShowResetButton ( $ state )

Reset button visibility. This function can be used to show or hide the form's reset button.

Parameters:

$state

(boolean) the visible state of the reset button

Definition at line 934 of file mform.class.

Referenced by showReset().

Here is the caller graph for this function:

MForm::getShowHints ( )

Form's hints visibility. This function returns the visibility of the form's hint texts.

See also:: ShowHints

Definition at line 945 of file mform.class.

References showHints().

Here is the call graph for this function:

MForm::setShowHints ( $ state )

Set form's hints visibility. This function can be used to show or hide the form's hint texts. Each form element may have a hint text associated with it. Using this method, one can enable/disable the display of the texts. This may be useful for implementing kind of an beginner/expert mode.

Parameters:

$state

(boolean) the visible state of the hint texts

Definition at line 959 of file mform.class.

References showHints().

Referenced by showHints().

Here is the call graph for this function:

Here is the caller graph for this function:

MForm::showHints ( $ state )

Deprecated:: This method is deprecated, use setShowHints instead.

Definition at line 967 of file mform.class.

References setShowHints().

Referenced by GenerateLayoutField(), getShowHints(), and setShowHints().

Here is the call graph for this function:

Here is the caller graph for this function:

MForm::GetFieldList ( )

Returns form fields list. This is a placeholder function to bu the form's field list. It is excpected, that the form returns a scalar list of all defined fields which carry a form field value. Thus, form elements of decorative purpose only should be omitted.

Derived classes such as TabbedForm override this function to provide the list of fields independently of the form's layout.

Returns:: (array) a scalar array of form fields

Reimplemented in MTabbedForm, and MTabbedForm2.

Definition at line 986 of file mform.class.

References _GetFieldList().

Referenced by CollectInput().

Here is the call graph for this function:

Here is the caller graph for this function:

MForm::_GetFieldList ( $ allfields ) [private]

Returns field list. Internal function which takes a list of form elements possibly consisting of single fields as well as arrays and returns a scalar the list of fields filtering out some known decorative form fields.

Parameters:

$allfields

(array) an array of form fields

Returns:: (array) a scalar array of form fields

Definition at line 1000 of file mform.class.

References $fields.

Referenced by MTabbedForm2::GetFieldList(), and GetFieldList().

Here is the caller graph for this function:

MForm::ClearFields ( )

Definition at line 1022 of file mform.class.

MForm::ClearButtons ( )

Definition at line 1028 of file mform.class.

MForm::validateAll ( $ assert = true )

Validate all form fields. Validates all form fields to have a non-empty content

Parameters:

$assert

(boolean) flag how to handle invalid fields;
if true, an error message will be shown
if false no error message will be shown and the caller can provide an appropriate action based on the return value.

Returns:: (boolean) true if all fields have a value; false if any of the fields has been left empty

Definition at line 1045 of file mform.class.

References validate().

Here is the call graph for this function:

MForm::validateRequiredFields ( $ assert = true )

Brief Description. Complete Description.

Parameters:

$assert

(tipo) desc

Returns:: (tipo) desc

Definition at line 1066 of file mform.class.

MForm::validate	(	$	required,
		$	assert = `true`
	)

Validates the form input Validate form data based on an array of required variable names.

Parameters:

	$required	(array) field to be validated
	$assert	(boolean) should the program stop if a error is found

Returns:: (boolean) true if all fields have a value; false if any of the fields has been left empty

Definition at line 1091 of file mform.class.

References $fields, MComponent::$name, and _M().

Referenced by validateAll().

Here is the call graph for this function:

Here is the caller graph for this function:

MForm::Error ( $ err )

Regiter the error Registers the error related to the form

Parameters:

$err

(tipo) desc

Returns:: (tipo) desc

Definition at line 1131 of file mform.class.

References AddError().

Here is the call graph for this function:

MForm::AddError ( $ err )

Brief Description. Complete Description.

Parameters:

$err

(tipo) desc

Returns:: (tipo) desc

Definition at line 1150 of file mform.class.

Referenced by Error().

Here is the caller graph for this function:

MForm::HasErrors ( )

Brief Description. Complete Description.

Returns:: (tipo) desc

Definition at line 1184 of file mform.class.

Referenced by MTabbedForm2::GenerateBody(), MTabbedForm::GenerateBody(), and GenerateBody().

Here is the caller graph for this function:

MForm::AddInfo ( $ info )

Brief Description. Complete Description.

Parameters:

$info

(tipo) desc

Returns:: (tipo) desc

Definition at line 1202 of file mform.class.

MForm::HasInfos ( )

Brief Description. Complete Description.

Returns:: (tipo) desc

Definition at line 1236 of file mform.class.

Referenced by GenerateBody(), and MTabbedForm::GenerateJavascript().

Here is the caller graph for this function:

MForm::CollectInput ( $ data )

Brief Description. Complete Description.

Parameters:

$data

(tipo) desc

Returns:: (tipo) desc

Definition at line 1254 of file mform.class.

References GetFieldList(), and GetFormValue().

Here is the call graph for this function:

MForm::getData ( )

Obtains the fields Obtains form fields in a FormData object.

Returns:: (Object) Form fields

Definition at line 1275 of file mform.class.

MForm::SetData ( $ data )

Definition at line 1294 of file mform.class.

References _SetData().

Here is the call graph for this function:

MForm::_SetData ( $ data ) [private]

Brief Description. Complete Description.

Parameters:

$data

(tipo) desc

Returns:: (tipo) desc

Definition at line 1321 of file mform.class.

References MComponent::$name.

Referenced by SetData().

Here is the caller graph for this function:

MForm::GetFieldValue	(	$	name,
		$	value = `false`
	)

Brief Description. Complete Description.

Parameters:

	$name	(tipo) desc
	$value	(tipo) desc

Returns:: (tipo) desc

Definition at line 1362 of file mform.class.

References MComponent::$name.

MForm::SetFieldValue	(	$	name,
		$	value
	)

Brief Description. Complete Description.

Parameters:

	$name	(tipo) desc
	$value	(tipo) desc

Returns:: (tipo) desc

Definition at line 1382 of file mform.class.

References MComponent::$name.

MForm::SetFieldValidator	(	$	name,
		$	value
	)

Brief Description. Complete Description.

Parameters:

	$name	(tipo) desc
	$value	(tipo) desc

Returns:: (tipo) desc

Definition at line 1406 of file mform.class.

References MComponent::$name.

& MForm::GetField ( $ name )

Get a reference for a form field

Definition at line 1422 of file mform.class.

References MComponent::$name.

& MForm::GetButton ( $ name )

Get a reference for a button

Definition at line 1431 of file mform.class.

References MComponent::$name.

Referenced by SetButtonAttr().

Here is the caller graph for this function:

& MForm::GetPage ( )

Get a reference for page

Definition at line 1446 of file mform.class.

MForm::SetPage ( &$ page )

Brief Description. Complete Description.

Parameters:

&$page

(tipo) desc

Returns:: (tipo) desc

Definition at line 1464 of file mform.class.

References MComponent::$page.

MForm::SetFieldAttr	(	$	name,
		$	attr,
		$	value
	)

Brief Description. Complete Description.

Parameters:

	$name	(tipo) desc
	$attr	(tipo) desc
	$value	(tipo) desc

Returns:: (tipo) desc

Definition at line 1484 of file mform.class.

References MComponent::$name.

MForm::GetFieldAttr	(	$	name,
		$	attr,
		$	index = `NULL`
	)

Brief Description. Complete Description.

Parameters:

	$name	(tipo) desc
	$attr	(tipo) desc
	$index	(tipo) desc

Returns:: (tipo) desc

Definition at line 1506 of file mform.class.

References MComponent::$name.

MForm::SetButtonAttr	(	$	name,
		$	attr,
		$	value
	)

Brief Description. Complete Description.

Parameters:

	$name	(tipo) desc
	$attr	(tipo) desc
	$value	(tipo) desc

Returns:: (tipo) desc

Definition at line 1536 of file mform.class.

References MComponent::$name, and GetButton().

Here is the call graph for this function:

MForm::SetFieldCSS	(	$	name,
		$	top,
		$	left,
		$	width = `NULL`,
		$	position = `'absolute'`
	)

Brief Description. Complete Description.

Parameters:

	$name	(tipo) desc
	$top	(tipo) desc
	$left	(tipo) desc
	$width	(tipo) desc
	$position=absolute'	(tipo) desc

Returns:: (tipo) desc

Definition at line 1559 of file mform.class.

References MComponent::$name, and $width.

MForm::SetFormCSS	(	$	height = `0`,
		$	width = `0`,
		$	top = `0`,
		$	left = `0`,
		$	buttons = `0`,
		$	position = `'absolute'`
	)

Brief Description. Complete Description.

Parameters:

	$height0	(tipo) desc
	$width=0	(tipo) desc
	$top=0	(tipo) desc
	$left=0	(tipo) desc
	$buttons=0	(tipo) desc
	$position=absolute'	(tipo) desc

Returns:: (tipo) desc

Definition at line 1590 of file mform.class.

References $width.

MForm::SetBackgroundColor ( $ bgcolor )

Definition at line 1601 of file mform.class.

MForm::SetAlign ( $ value )

Definition at line 1606 of file mform.class.

MForm::SetWidth ( $ width = NULL )

Definition at line 1611 of file mform.class.

References $width.

MForm::SetHeight ( $ height = NULL )

Reimplemented in MCSSPForm.

Definition at line 1616 of file mform.class.

MForm::SetLabelWidth ( $ width )

Brief Description. Complete Description.

Parameters:

$width

(tipo) desc

Returns:: (tipo) desc

Definition at line 1632 of file mform.class.

References $width.

MForm::GenerateErrors ( )

Brief Description. Complete Description.

Returns:: (tipo) desc

Definition at line 1644 of file mform.class.

References MPrompt::Error().

Referenced by MTabbedForm2::GenerateBody(), MTabbedForm::GenerateBody(), and GenerateBody().

Here is the call graph for this function:

Here is the caller graph for this function:

MForm::GenerateInfos ( )

Brief Description. Complete Description.

Returns:: (tipo) desc

Definition at line 1658 of file mform.class.

References MPrompt::Information().

Referenced by GenerateBody().

Here is the call graph for this function:

Here is the caller graph for this function:

MForm::GenerateBody ( )

Brief Description. Complete Description.

Returns:: (tipo) desc

Reimplemented in MIndexedForm, MTabbedForm, and MTabbedForm2.

Definition at line 1672 of file mform.class.

References $buttons, $layout, GenerateButtons(), GenerateErrors(), GenerateHiddenFields(), GenerateInfos(), GenerateLayoutFields(), GenerateScript(), HasErrors(), and HasInfos().

Referenced by Generate(), MCSSPForm::Generate(), MCSSForm::Generate(), and MCompoundForm::Generate().

Here is the call graph for this function:

Here is the caller graph for this function:

MForm::GenerateFooter ( )

Brief Description. Complete Description.

Returns:: (tipo) desc

Reimplemented in MTabbedForm.

Definition at line 1725 of file mform.class.

Referenced by Generate(), MCSSPForm::Generate(), MCompoundForm::Generate(), and MTabbedForm2::generateInner().

Here is the caller graph for this function:

MForm::GenerateLayoutFields ( &$ hidden )

Brief Description. Complete Description.

Parameters:

&$hidden

(tipo) desc

Returns:: (tipo) desc

Reimplemented in MCSSForm, and MCSSPForm.

Definition at line 1739 of file mform.class.

References $zebra, AddValidator(), GenerateLayoutField(), and getFieldValidator().

Referenced by MTabbedForm2::GenerateBody(), and GenerateBody().

Here is the call graph for this function:

Here is the caller graph for this function:

MForm::getFieldValidator ( $ name )

Definition at line 1769 of file mform.class.

References MComponent::$name.

Referenced by GenerateLayoutFields().

Here is the caller graph for this function:

MForm::GenerateLayoutField	(	$	f,
		&$	hidden
	)

Brief Description. Complete Description.

Parameters:

	$f	(tipo) desc
	&$hidden	(tipo) desc

Returns:: (tipo) desc

Definition at line 1792 of file mform.class.

References showHints().

Referenced by GenerateLayoutFields().

Here is the call graph for this function:

Here is the caller graph for this function:

MForm::GenerateButtons ( )

Brief Description. Complete Description.

Returns:: (tipo) desc

Definition at line 1882 of file mform.class.

Referenced by MTabbedForm::GenerateBody(), GenerateBody(), and MTabbedForm::GenerateJavascript().

Here is the caller graph for this function:

MForm::GenerateHiddenFields ( $ hidden )

Brief Description. Complete Description.

Parameters:

$hidden

(tipo) desc

Returns:: (tipo) desc

Definition at line 1915 of file mform.class.

Referenced by MTabbedForm::GenerateBody(), GenerateBody(), and MTabbedForm::GenerateJavascript().

Here is the caller graph for this function:

MForm::GenerateScript ( )

Brief Description. Complete Description.

Returns:: (tipo) desc

Definition at line 1937 of file mform.class.

References OnSubmit().

Referenced by MTabbedForm2::GenerateBody(), and GenerateBody().

Here is the call graph for this function:

Here is the caller graph for this function:

MForm::Generate ( )

Reimplemented in MCompoundForm, MCSSForm, MCSSPForm, and MTabbedForm.

Definition at line 1974 of file mform.class.

References $footer, MControl::$id, GenerateBody(), and GenerateFooter().

Here is the call graph for this function:

MForm::$title

Attribute Description.

Definition at line 13 of file mform.class.

Referenced by MTabbedForm2::__construct(), MTabbedForm::__construct(), MIndexedForm::__construct(), __construct(), MCSSPForm::__construct(), MCSSForm::__construct(), MCompoundForm::__construct(), MTabbedForm2::AddPage(), MIndexedForm::AddPage(), Form::Form(), MCSSPForm::Generate(), MTabbedForm2::GenerateBody(), MTabbedForm::GenerateHtml(), MTabbedForm2::generateInner(), and SetTitle().

MForm::$action

Attribute Description.

Definition at line 18 of file mform.class.

Referenced by MTabbedForm2::__construct(), MTabbedForm::__construct(), MIndexedForm::__construct(), __construct(), MCSSPForm::__construct(), MCSSForm::__construct(), MCompoundForm::__construct(), Form::Form(), SetAction(), SetClose(), and setHelp().

MForm::$method

Attribute Description.

Definition at line 23 of file mform.class.

Referenced by MTabbedForm::Generate(), and MTabbedForm::SetPainterMethod().

MForm::$buttons

Attribute Description.

Definition at line 28 of file mform.class.

Referenced by MTabbedForm::GenerateBody(), GenerateBody(), and MTabbedForm::GenerateJavascript().

MForm::$fields = array()

Attribute Description.

Definition at line 33 of file mform.class.

Referenced by _GetFieldList(), AddFields(), MTabbedForm2::AddPage(), MIndexedForm::AddPage(), MTabbedForm::GenerateBody(), MIndexedForm::GenerateBody(), MIndexedForm::GenerateIndexPage(), MTabbedForm2::GetFieldList(), MTabbedForm::GetFieldList(), SetFields(), and validate().

MForm::$return

Attribute Description.

Definition at line 38 of file mform.class.

MForm::$reset

Attribute Description.

Definition at line 43 of file mform.class.

MForm::$styles

Attribute Description.

Definition at line 48 of file mform.class.

MForm::$help

Attribute Description.

Definition at line 53 of file mform.class.

Referenced by __construct(), and setHelp().

MForm::$footer

Attribute Description.

Reimplemented in MTabbedForm.

Definition at line 58 of file mform.class.

Referenced by Generate(), MCSSPForm::Generate(), MCSSForm::Generate(), MCompoundForm::Generate(), MTabbedForm2::generateInner(), and SetFooter().

MForm::$width

Attribute Description.

Definition at line 63 of file mform.class.

Referenced by MTabbedForm::GenerateBody(), MTabbedForm::GenerateJavascript(), MCSSForm::GenerateLayoutFields(), MCSSForm::SetField(), SetFieldCSS(), SetFormCSS(), SetLabelWidth(), and SetWidth().

MForm::$showHints = true

Attribute Description.

Definition at line 68 of file mform.class.

MForm::$enctype

Attribute Description.

Definition at line 73 of file mform.class.

MForm::$validations

Attribute Description.

Definition at line 78 of file mform.class.

MForm::$defaultButton

Attribute Description.

Definition at line 83 of file mform.class.

MForm::$errors

Attribute Description.

Definition at line 88 of file mform.class.

MForm::$infos

Attribute Description.

Definition at line 93 of file mform.class.

MForm::$box

Attribute Description.

Reimplemented from MControl.

Definition at line 98 of file mform.class.

MForm::$fieldNum = 0 [static]

Definition at line 100 of file mform.class.

MForm::$layout

Attribute Description.

Definition at line 104 of file mform.class.

Referenced by MTabbedForm::GenerateBody(), and GenerateBody().

MForm::$cssForm = false

Attribute Description.

Definition at line 109 of file mform.class.

MForm::$cssButtons

Definition at line 110 of file mform.class.

MForm::$zebra = false

Attribute Description.

Definition at line 114 of file mform.class.

Referenced by GenerateLayoutFields().

MForm::$labelWidth = NULL

Attribute Description.

Definition at line 118 of file mform.class.

MForm::$bgColor = NULL

Definition at line 120 of file mform.class.

MForm::$align = NULL

Definition at line 121 of file mform.class.


Public Member Functions
	__construct ($title='', $action='', $close='', $icon='', $help='')
	__set ($name, $value)
	__get ($name)
	OnLoad ()
	CreateFields ()
	AddValidator ($validator)
	SetValidators ($validators)
	IsSubmitted ()
	GetTitle ()
	SetTitle ($title)
	SetClose ($action)
	SetIcon ($icon)
	SetAlternate ($color0, $color1)
	GetFooter ()
	SetFooter ($footer)
	GetFormFields ()
	_GetFormFieldValue ($field)
	GetFormValue ($name, $value=NULL)
	SetFormValue ($name, $value)
	OnSubmit ($jscode)
	AddJsCode ($jscode)
	SetAction ($action)
	setHelp ($help, $module=null, $action=null)
	SetFields (&$fields)
	AddField ($field, $hint=false)
	AddFields ($fields)
	AddButton ($btn)
	SetButtons ($btn)
	setButtonLabel ($index, $label)
	showReturn ($state)
	setShowReturnButton ($state)
	setShowPostButton ($state)
	showReset ($state)
	setShowResetButton ($state)
	getShowHints ()
	setShowHints ($state)
	showHints ($state)
	GetFieldList ()
	ClearFields ()
	ClearButtons ()
	validateAll ($assert=true)
	validateRequiredFields ($assert=true)
	validate ($required, $assert=true)
	Error ($err)
	AddError ($err)
	HasErrors ()
	AddInfo ($info)
	HasInfos ()
	CollectInput ($data)
	getData ()
	SetData ($data)
	GetFieldValue ($name, $value=false)
	SetFieldValue ($name, $value)
	SetFieldValidator ($name, $value)
&	GetField ($name)
&	GetButton ($name)
&	GetPage ()
	SetPage (&$page)
	SetFieldAttr ($name, $attr, $value)
	GetFieldAttr ($name, $attr, $index=NULL)
	SetButtonAttr ($name, $attr, $value)
	SetFieldCSS ($name, $top, $left, $width=NULL, $position='absolute')
	SetFormCSS ($height=0, $width=0, $top=0, $left=0, $buttons=0, $position='absolute')
	SetBackgroundColor ($bgcolor)
	SetAlign ($value)
	SetWidth ($width=NULL)
	SetHeight ($height=NULL)
	SetLabelWidth ($width)
	GenerateErrors ()
	GenerateInfos ()
	GenerateBody ()
	GenerateFooter ()
	GenerateLayoutFields (&$hidden)
	getFieldValidator ($name)
	GenerateLayoutField ($f, &$hidden)
	GenerateButtons ()
	GenerateHiddenFields ($hidden)
	GenerateScript ()
	Generate ()
Public Attributes
	$title
	$action
	$method
	$buttons
	$fields = array()
	$return
	$reset
	$styles
	$help
	$footer
	$width
	$showHints = true
	$enctype
	$validations
	$defaultButton
	$errors
	$infos
	$box
	$layout
	$cssForm = false
	$cssButtons
	$zebra = false
	$labelWidth = NULL
	$bgColor = NULL
	$align = NULL
Static Public Attributes
static	$fieldNum = 0
Private Member Functions
	EscapeValue ($value)
	GetFields ()
	_RegisterField ($field)
	_GetFieldList ($allfields)
	_SetData ($data)

MForm Class Reference

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation