IcmsPersistableObject

Packages:

Files:

Interfaces:

Classes:

IcmsAutocompleteElement
IcmsForm
IcmsFormAutocompleteElement
IcmsFormCheckElement
IcmsFormDateElement
IcmsFormDate_timeElement
IcmsFormFileElement
IcmsFormFileUploadElement
IcmsFormHidden
IcmsFormImageElement
IcmsFormImageUploadElement
IcmsFormLanguageElement
IcmsFormParentcategoryElement
IcmsFormRadioElement
IcmsFormSelectElement
IcmsFormSelect_multiElement
IcmsFormSet_passwordElement
IcmsFormTextElement
IcmsFormTimeElement
IcmsFormUploadElement
IcmsFormUrlLinkElement
IcmsFormUserElement
IcmsFormUser_sigElement
IcmsFormYesnoElement
IcmsMetagen
IcmsPersistableColumn
IcmsPersistableController
IcmsPersistableObject
IcmsPersistableObjectHandler
IcmsPersistablePermissionHandler
IcmsPersistableRegistry
IcmsPersistableSeoObject
IcmsPersistableTable
IcmsPersistableTreeTable
IcmsSecureForm
IcmsStopSpammer

form
IcmsFormRichFileElement
IcmsFormSection
IcmsFormSectionClose

Class: IcmsForm

Source Location: /class/icmsform/icmsform.php

Class IcmsForm

Class Overview

IcmsForm base class

Base class representing a single form for a specific IcmsPersistableObject

Located in /class/icmsform/icmsform.php [line 21]

XoopsForm
   |
   --XoopsThemeForm
      |
      --IcmsForm

Author(s):

marcan <marcan@impresscms.org>

Information Tags:

Version:	$Id: icmsform.php 6931 2008-11-15 13:49:11Z pesian_stranger $
Copyright:	The ImpressCMS Project http://www.impresscms.org/
Since:	1.1
License:	GNU General Public License (GPL)

Properties

Methods

[ Top ]

Descendants

Child Class	Description
IcmsSecureForm	IcmsSecureForm extending IcmsForm with the addition of the Security Token

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From XoopsThemeForm

XoopsThemeForm::insertBreak()

Insert an empty row in the table to serve as a seperator.

XoopsThemeForm::render()

create HTML to output the form as a theme-enabled table with validation.

Inherited From XoopsForm

XoopsForm::XoopsForm()

constructor

XoopsForm::addElement()

Add an element to the form

XoopsForm::assign()

assign to smarty form template instead of displaying directly

XoopsForm::display()

displays rendered form

XoopsForm::getAction()

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

XoopsForm::getElementByName()

get a reference to a XoopsFormElement object by its "name"

XoopsForm::getElementNames()

get an array of "name" attributes of form elements

XoopsForm::getElements()

get an array of forms elements

XoopsForm::getElementValue()

Gets the "value" attribute of a form element

XoopsForm::getElementValues()

gets the "value" attribute of all form elements

XoopsForm::getExtra()

get the extra attributes for the <form> tag

XoopsForm::getMethod()

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

XoopsForm::getName()

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

XoopsForm::getRequired()

get an array of "required" form elements

XoopsForm::getTitle()

return the title of the form

XoopsForm::insertBreak()

insert a break in the form

XoopsForm::render()

returns renderered form

XoopsForm::renderValidationJS()

Renders the Javascript function needed for client-side for validation

XoopsForm::setElementValue()

Sets the "value" attribute of a form element

XoopsForm::setElementValues()

Sets the "value" attribute of form elements in a batch

XoopsForm::setExtra()

set the extra attributes for the <form> tag

XoopsForm::setRequired()

make an element "required"

[ Top ]

Property Summary

mixed	$form_fields
mixed	$targetObject
mixed	$_cancel_js_action
mixed	$_captcha
mixed	$_custom_button
mixed	$_form_caption
mixed	$_form_name
mixed	$_submit_button_caption

[ Top ]

Method Summary

IcmsForm	IcmsForm()
void	addCustomButton()
void	addElement()	Add an element to the form
void	assign()	assign to smarty form template instead of displaying directly
void	createButtons()
void	createElements()
void	createPermissionControls()
void	getControl()
void	&getElementById()
void	getThemeSelect()
string	render()	create HTML to output the form as a theme-enabled table with validation.
void	renderValidationJS()

[ Top ]

Properties

mixed $form_fields = null [line 24]

[ Top ]

mixed $targetObject = null [line 23]

[ Top ]

mixed $_cancel_js_action = false [line 25]

[ Top ]

mixed $_captcha = false [line 27]

[ Top ]

mixed $_custom_button = false [line 26]

[ Top ]

mixed $_form_caption = false [line 29]

[ Top ]

mixed $_form_name = false [line 28]

[ Top ]

mixed $_submit_button_caption = false [line 30]

[ Top ]

Methods

Constructor IcmsForm [line 32]

IcmsForm IcmsForm(

&$target, 
$form_name, 
$form_caption, 
$form_action, [
$form_fields = null], [
$submit_button_caption = false], [
$cancel_js_action = false], [
$captcha = false] 
)

Parameters:

	&$target:
	$form_name:
	$form_caption:
	$form_action:
	$form_fields:
	$submit_button_caption:
	$cancel_js_action:
	$captcha:

[ Top ]

addCustomButton [line 69]

void addCustomButton(

$name, 
$caption, [
$onclick = false] 
)

Parameters:

	$name:
	$caption:
	$onclick:

Information Tags:

Todo:

to be implemted later...

[ Top ]

addElement [line 84]

void addElement(
object
&$formElement, [
$key = false], [
$var = false], [bool
$required = 'notset'] 
)

Add an element to the form

Parameters:

object	&$formElement:	reference to a XoopsFormElement
bool	$required:	is this a "required" element?
	$key:
	$var:

Redefinition of:

XoopsForm::addElement(): Add an element to the form

[ Top ]

assign [line 509]

void assign(
object
&$tpl, [
$smartyName = false] 
)

assign to smarty form template instead of displaying directly

Parameters:

object	&$tpl:	reference to a Smarty object
	$smartyName:

API Tags:

See:

Smarty

Redefinition of:

XoopsForm::assign(): assign to smarty form template instead of displaying directly

[ Top ]

createButtons [line 279]

void createButtons(

$form_name, 
$form_caption, [
$submit_button_caption = false] 
)

Parameters:

	$form_name:
	$form_caption:
	$submit_button_caption:

[ Top ]

createElements [line 116]

void createElements(
)

[ Top ]

createPermissionControls [line 252]

void createPermissionControls(
)

[ Top ]

getControl [line 320]

void getControl(

$controlName, 
$key 
)

Parameters:

	$controlName:
	$key:

[ Top ]

getElementById [line 459]

void &getElementById(

$keyname 
)

Parameters:

$keyname:

[ Top ]

getThemeSelect [line 438]

void getThemeSelect(

$key, 
$var, [
$multiple = false] 
)

Parameters:

	$key:
	$var:
	$multiple:

[ Top ]

render [line 474]

string render(
)

create HTML to output the form as a theme-enabled table with validation.

Redefinition of:

XoopsThemeForm::render(): create HTML to output the form as a theme-enabled table with validation.

[ Top ]

renderValidationJS [line 536]

void renderValidationJS(
[
$withtags = true] 
)

Parameters:

$withtags:

Redefinition of:

XoopsForm::renderValidationJS(): Renders the Javascript function needed for client-side for validation

[ Top ]

Documentation generated on Sat, 15 Nov 2008 14:16:44 -0600 by phpDocumentor 1.4.1