Inheritance diagram for Xoops\Form\Form:

Public Member Functions
	__construct ($title, $name, $action, $method= 'post', $addtoken=false, $display= '')

	addElement (Element $formElement, $required=false)

	assign (\XoopsTpl $tpl)

	display ()

	getAction ($encode=true)

	getDisplay ($encode=false)

	getElementByName ($name)

	getElementNames ()

	getElements ($recurse=false)

	getElementValue ($name, $encode=false)

	getElementValues ($encode=false)

	getExtra ()

	getMethod ()

	getName ($encode=true)

	getRequired ()

	getTitle ($encode=false)

	render ()

	renderValidationJS ($withtags=true)

	setAction ($value= '')

	setElementValue ($name, $value)

	setElementValues ($values)

	setExtra ($extra)

	setRequired (Element $formElement)

	setSummary ($summary)

	setTitle ($title)

Private Attributes
	$action

	$display = ''

	$elements = array()

	$extra = array()

	$method

	$name

	$required = array()

	$summary = ''

	$title

Detailed Description

Definition at line 26 of file Form.php.

Constructor & Destructor Documentation

Xoops\Form\Form::__construct	(	$title,
		$name,
		$action,
		$method = `'post'`,
		$addtoken = `false`,
		$display = `''`
	)

constructor

Parameters

string	$title	title of the form
string	$name	name attribute for the <form> tag
string	$action	action attribute for the <form> tag
string	$method	method attribute for the <form> tag
boolean	$addtoken	whether to add a security token to the form
string	$display	class for the form, i.e. horizontal, vertical, inline

Returns: void

Definition at line 101 of file Form.php.

References Xoops\Form\Form\$action, Xoops\Form\Form\$display, Xoops\Form\Form\$method, Xoops\Form\Form\$name, Xoops\Form\Form\$title, Xoops\Form\Form\addElement(), and Xoops\Form\Form\display().

Here is the call graph for this function:

Member Function Documentation

Xoops\Form\Form::addElement	(	Element	$formElement,
			$required = `false`
	)

addElement - Add an element to the form

Parameters

Element	$formElement	Xoops to add
boolean	$required	true if this is a required element

Returns: void

Definition at line 206 of file Form.php.

References $count, $i, Xoops\Form\Form\$required, and Xoops\Form\Element\setRequired().

Referenced by AvatarsAvatar_userForm\__construct(), XcaptchaImageForm\__construct(), XcaptchaTextForm\__construct(), ImagesImageForm\__construct(), AvatarsAvatarForm\__construct(), XcaptchaRecaptchaForm\__construct(), XcaptchaCaptchaForm\__construct(), ImagesCategoryselectForm\__construct(), ImagesCategoryForm\__construct(), SmiliesSmiliesForm\__construct(), CommentsCommentForm\__construct(), ImagesCategory_imagemanagerForm\__construct(), UserrankRanksForm\__construct(), MenusMenus_menuForm\__construct(), MenusMenus_menusForm\__construct(), ImagesImage_imagemanagerForm\__construct(), SystemUserForm\__construct(), SystemGroupForm\__construct(), Xoops\Form\GroupPermissionForm\__construct(), Xoops\Form\Form\__construct(), MaintenanceMaintenanceForm\getDump(), UserconfigsConfigsForm\getForm(), SystemPreferencesForm\getForm(), SystemBlockForm\getForm(), MaintenanceMaintenanceForm\getMaintenance(), UserconfigsModulesForm\getModulesForm(), SearchSearchForm\getSearchFrom(), Xoops\Form\SimpleForm\insertBreak(), Xoops\Form\ThemeForm\insertBreak(), Xoops\Form\TableForm\insertBreak(), and Xoops\Form\GroupPermissionForm\render().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Form\Form::assign ( \XoopsTpl $tpl )

assign - assign to smarty form template instead of displaying directly

Parameters

\XoopsTpl $tpl template

Returns: void

Definition at line 499 of file Form.php.

References Xoops\Form\Form\$elements, $i, Xoops\Form\Form\getAction(), Xoops\Form\Form\getElements(), Xoops\Form\Form\getExtra(), Xoops\Form\Form\getMethod(), Xoops\Form\Form\getName(), Xoops\Form\Form\getRequired(), Xoops\Form\Form\getTitle(), Xoops\Form\Form\renderValidationJS(), and XoopsLocaleEn_US\REQUIRED.

Here is the call graph for this function:

Xoops\Form\Form::display ( )

display - displays rendered form

Returns: void

Definition at line 442 of file Form.php.

References Xoops\Form\Form\render().

Referenced by Xoops\Form\Form\__construct(), and Xoops\Form\Form\getDisplay().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Form\Form::getAction ( $encode = true )

getAction - get the "action" attribute for the <form> tag

Parameters

boolean $encode True to encode special characters

Returns: string

Definition at line 182 of file Form.php.

References Xoops\Form\Form\$action.

Referenced by Xoops\Form\Form\assign(), Xoops\Form\SimpleForm\render(), Xoops\Form\TableForm\render(), Xoops\Form\ThemeForm\render(), and Xoops\Form\GroupPermissionForm\render().

Here is the caller graph for this function:

Xoops\Form\Form::getDisplay ( $encode = false )

getDisplay - return the summary of the form

Parameters

boolean $encode True to encode special characters

Returns: string

Definition at line 120 of file Form.php.

References Xoops\Form\Form\$display, and Xoops\Form\Form\display().

Referenced by Xoops\Form\ThemeForm\render().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Form\Form::getElementByName ( $name )

getElementByName - get a reference to a Xoops by its name

Parameters

string $name name attribute assigned to a Xoops

Returns: null|Element

Definition at line 280 of file Form.php.

References Xoops\Form\Form\$elements, Xoops\Form\Form\$name, and Xoops\Form\Form\getElements().

Referenced by Xoops\Form\Form\getElementValue(), and Xoops\Form\Form\setElementValue().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Form\Form::getElementNames ( )

getElementNames - get an array of "name" attributes of form elements

Returns: string[] of form element names

Definition at line 261 of file Form.php.

References Xoops\Form\Form\$elements, and Xoops\Form\Form\getElements().

Here is the call graph for this function:

Xoops\Form\Form::getElements ( $recurse = false )

getElements - get an array of forms elements

Parameters

boolean $recurse true to get elements recursively

Returns: array of Xoops

Implements Xoops\Form\ContainerInterface.

Definition at line 232 of file Form.php.

References Xoops\Form\Form\$elements.

Referenced by Xoops\Form\Form\assign(), Xoops\Form\Form\getElementByName(), Xoops\Form\Form\getElementNames(), Xoops\Form\Form\getElementValues(), UserconfigsConfigsForm\getForm(), SystemPreferencesForm\getForm(), Xoops\Form\BlockForm\render(), Xoops\Form\SimpleForm\render(), Xoops\Form\TableForm\render(), Xoops\Form\ThemeForm\render(), Xoops\Form\GroupPermissionForm\render(), Xoops\Form\Form\renderValidationJS(), and Xoops\Form\Form\setElementValues().

Here is the caller graph for this function:

Xoops\Form\Form::getElementValue	(	$name,
		$encode = `false`
	)

getElementValue - Gets the value attribute of a form element

Parameters

string	$name	the name attribute of a form element
boolean	$encode	True to encode special characters

Returns: string|null the value attribute assigned to a form element, null if not set

Definition at line 339 of file Form.php.

References Xoops\Form\Form\$name, and Xoops\Form\Form\getElementByName().

Here is the call graph for this function:

Xoops\Form\Form::getElementValues ( $encode = false )

getElementValues - gets the value attribute of all form elements

Parameters

boolean $encode True to encode special characters

Returns: array array of name/value pairs assigned to form elements

Definition at line 352 of file Form.php.

References Xoops\Form\Form\$elements, Xoops\Form\Form\$name, and Xoops\Form\Form\getElements().

Here is the call graph for this function:

Xoops\Form\Form::getExtra ( )

getExtra - get the extra attributes for the <form> tag

Returns: string

Definition at line 400 of file Form.php.

References Xoops\Form\Form\$extra.

Referenced by Xoops\Form\Form\assign(), Xoops\Form\SimpleForm\render(), Xoops\Form\TableForm\render(), Xoops\Form\ThemeForm\render(), and Xoops\Form\GroupPermissionForm\render().

Here is the caller graph for this function:

Xoops\Form\Form::getMethod ( )

getMethod - get the "method" attribute for the <form> tag

Returns: string

Definition at line 193 of file Form.php.

Referenced by Xoops\Form\Form\assign(), Xoops\Form\SimpleForm\render(), Xoops\Form\TableForm\render(), Xoops\Form\ThemeForm\render(), and Xoops\Form\GroupPermissionForm\render().

Here is the caller graph for this function:

Xoops\Form\Form::getName ( $encode = true )

get the "name" attribute for the <form> tag

Deprecated, to be refactored

Parameters

boolean $encode True to encode special characters

Returns: string

Definition at line 158 of file Form.php.

References Xoops\Form\Form\$name.

Referenced by Xoops\Form\Form\assign(), Xoops\Form\SimpleForm\render(), Xoops\Form\TableForm\render(), Xoops\Form\ThemeForm\render(), Xoops\Form\GroupPermissionForm\render(), and Xoops\Form\Form\renderValidationJS().

Here is the caller graph for this function:

Xoops\Form\Form::getRequired ( )

getRequired - get an array of required form elements

Returns: array array of Xoops

Implements Xoops\Form\ContainerInterface.

Definition at line 423 of file Form.php.

References Xoops\Form\Form\$required.

Referenced by Xoops\Form\Form\assign().

Here is the caller graph for this function:

Xoops\Form\Form::getTitle ( $encode = false )

getTitle - return the title of the form

Parameters

bool $encode To sanitizer the text?

Returns: string

Definition at line 132 of file Form.php.

References Xoops\Form\Form\$title.

Referenced by Xoops\Form\Form\assign(), Xoops\Form\SimpleForm\render(), Xoops\Form\TableForm\render(), Xoops\Form\ThemeForm\render(), and Xoops\Form\GroupPermissionForm\render().

Here is the caller graph for this function:

Xoops\Form\Form::render ( )

abstract

render - returns renderered form

This method is abstract. It must be overwritten in the child classes.

Returns: string the rendered form

Referenced by Xoops\Form\Form\display().

Here is the caller graph for this function:

Xoops\Form\Form::renderValidationJS ( $withtags = true )

Renders the Javascript function needed for client-side for validation

Form elements that have been declared "required" and not set will prevent the form from being submitted. Additionally, each element class may provide its own "renderValidationJS" method that is supposed to return custom validation code for the element.

The element validation code can assume that the JS "myform" variable points to the form, and must execute return false if validation fails.

A basic element validation method may contain something like this: function renderValidationJS() { $name = $this->getName(); return "if ( myform.{$name}.value != 'valid' ) { " . "myform.{$name}.focus(); window.alert( '$name is invalid' ); return false;" . " }"; }

Parameters

boolean $withtags Include the < javascript > tags in the returned string