Class XoopsForm

Abstract base class for forms

Direct known subclasses

XoopsGroupPermForm, XoopsSimpleForm, XoopsTableForm, XoopsThemeForm

Package: kernel\form
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Author: Taiwen Jiang phppp@users.sourceforge.net
Located at lass/xoopsform/form.php

Methods summary
`public`	# `__construct( string $title, string $name, string $action, string $method = 'post', boolean $addtoken = false, string $summary = '' )` constructor constructor Parameters `$title` title of the form `$name` "name" attribute for the < form> tag `$action` "action" attribute for the < form> tag `$method` "method" attribute for the < form> tag `$addtoken` whether to add a security token to the form `$summary`
`public`	# `XoopsForm( )` PHP 4 style constructor compatibility shim PHP 4 style constructor compatibility shim Deprecated all callers should be using parent::__construct()
`public string`	# `getObjectID( $object, string $hashinfo = 'sha1' )` #@+ retrieves object serialisation/identification id (sha1 used) #@+ retrieves object serialisation/identification id (sha1 used) each object has serialisation - legal requirement of enterprise relational management (ERM) Deprecated Parameters `$object` `$hashinfo` Returns string
`public string`	# `getArrayID( $value, $key, $ret, string $hashinfo = 'sha1' )` Parameters `$value` `$key` `$ret` `$hashinfo` Returns string
`public string`	# `getSummary( boolean $encode = false )` return the summary of the form return the summary of the form Parameters `$encode` To sanitizer the text? Returns string
`public string`	# `getTitle( boolean $encode = false )` return the title of the form return the title of the form Parameters `$encode` To sanitizer the text? Returns string
`public string`	# `getName( boolean $encode = true )` get the "name" attribute for the < form> tag get the "name" attribute for the < form> tag Deprecated, to be refactored Parameters `$encode` To sanitizer the text? Returns string
`public string`	# `getAction( boolean $encode = true )` get the "action" attribute for the < form> tag get the "action" attribute for the < form> tag Parameters `$encode` To sanitizer the text? Returns string
`public string`	# `getMethod( )` get the "method" attribute for the < form> tag get the "method" attribute for the < form> tag Returns string
`public`	# `addElement( string\|XoopsFormElement $formElement, boolean $required = false )` Add an element to the form Add an element to the form Parameters `$formElement` reference to a `XoopsFormElement` `$required` is this a "required" element?
`public XoopsFormElement[] &`	# `getElements( boolean $recurse = false )` get an array of forms elements get an array of forms elements Parameters `$recurse` get elements recursively? Returns `XoopsFormElement[]` array of `XoopsFormElement`s
`public array`	# `getElementNames( )` get an array of "name" attributes of form elements get an array of "name" attributes of form elements Returns array array of form element names
`public object &`	# `getElementByName( string $name )` get a reference to a `XoopsFormElement` object by its "name" get a reference to a `XoopsFormElement` object by its "name" Parameters `$name` "name" attribute assigned to a `XoopsFormElement` Returns object reference to a `XoopsFormElement`, false if not found
`public`	# `setElementValue( string $name, string $value )` Sets the "value" attribute of a form element Sets the "value" attribute of a form element Parameters `$name` the "name" attribute of a form element `$value` the "value" attribute of a form element
`public`	# `setElementValues( array $values )` Sets the "value" attribute of form elements in a batch Sets the "value" attribute of form elements in a batch Parameters `$values` array of name/value pairs to be assigned to form elements
`public string`	# `getElementValue( string $name, boolean $encode = false )` Gets the "value" attribute of a form element Gets the "value" attribute of a form element Parameters `$name` the "name" attribute of a form element `$encode` To sanitizer the text? Returns string the "value" attribute assigned to a form element, null if not set
`public array`	# `getElementValues( boolean $encode = false )` gets the "value" attribute of all form elements gets the "value" attribute of all form elements Parameters `$encode` To sanitizer the text? Returns array array of name/value pairs assigned to form elements
`public`	# `setExtra( string $extra )` set the extra attributes for the < form> tag set the extra attributes for the < form> tag Parameters `$extra` extra attributes for the < form> tag
`public`	# `setSummary( string $summary )` set the summary tag for the < form> tag set the summary tag for the < form> tag Parameters `$summary`
`public string &`	# `getExtra( )` get the extra attributes for the < form> tag get the extra attributes for the < form> tag Returns string
`public`	# `setRequired( XoopsFormElement $formElement )` make an element "required" make an element "required" Parameters `$formElement` reference to a `XoopsFormElement`
`public array &`	# `getRequired( )` get an array of "required" form elements get an array of "required" form elements Returns array array of `XoopsFormElement`s
`public`	# `insertBreak( string $extra = null )` insert a break in the form insert a break in the form This method is abstract. It must be overwritten in the child classes. Parameters `$extra` extra information for the break
`public`	# `render( )` returns renderered form returns renderered form This method is abstract. It must be overwritten in the child classes.
`public`	# `display( )` displays rendered form displays rendered form
`public string`	# `renderValidationJS( boolean $withtags = true )` Renders the Javascript function needed for client-side for validation 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 `$withtags` Include the < javascript > tags in the returned string Returns string
`public`	# `assign( XoopsTpl $tpl )` assign to smarty form template instead of displaying directly assign to smarty form template instead of displaying directly Parameters `$tpl` reference to a `Smarty` object object See `Smarty`

Properties summary
`public string`	`$_action` "action" attribute for the html form "action" attribute for the html form	#
`public string`	`$_method` "method" attribute for the form. "method" attribute for the form.	#
`public string`	`$_name` "name" attribute of the form "name" attribute of the form	#
`public string`	`$_title` title for the form title for the form	#
`public string`	`$_summary` summary for the form (WGAC2 Requirement) summary for the form (WGAC2 Requirement)	# `''`
`public array`	`$_elements` array of `XoopsFormElement` objects array of `XoopsFormElement` objects	# `array()`
`public array`	`$_extra` extra information for the < form> tag extra information for the < form> tag	# `array()`
`public array`	`$_required` required elements required elements	# `array()`
`public string`	`$_objid` additional serialised object checksum (ERM Analysis - Requirement) additional serialised object checksum (ERM Analysis - Requirement) Deprecated	# `'da39a3ee5e6b4b0d3255bfef95601890afd80709'`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsForm

Direct known subclasses

Parameters

Deprecated

Deprecated

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Parameters

Returns

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

See

Deprecated