Overview

Packages

  • Auth
    • Ads
    • Ldap
    • Xoops
  • Autotasks
  • Config
    • Category
    • Item
    • Option
  • Core
    • Filesystem
    • Filters
    • Logger
    • Mail
    • Message
    • Password
    • Security
    • StopSpammer
    • Template
    • Textsanitizer
    • VersionChecker
  • Data
    • Avatar
    • Comment
  • Database
    • Connection
    • Criteria
    • Legacy
    • MySQL
    • PDO
    • Updater
  • Feeds
    • RSS
  • File
  • Form
    • Base
    • Elements
  • ICMS
    • IPF
      • View
  • Image
    • Category
  • Ipf
    • Category
    • Controller
    • Export
    • form
    • Keyhighlighter
    • Member
    • Object
    • Permission
    • richfile
    • Tree
    • urllink
    • View
  • kernel
    • Set
  • Member
    • Group
    • GroupMembership
    • GroupPermission
    • User
  • Messaging
  • Module
  • None
  • Notification
  • Page
  • Plugins
    • Editor
  • Preload
    • Libraries
  • Privmessage
  • Session
  • SmartObject
  • View
    • Block
    • Breadcrumb
    • PageNav
    • PrinterFriendly
    • Template
    • Templates
    • Theme
    • Tree

Classes

  • icms_form_Groupperm
  • icms_form_Simple
  • icms_form_Table
  • icms_form_Theme
  • icms_ipf_form_Base
  • icms_ipf_form_Secure
  • Overview
  • Package
  • Class

Class icms_ipf_form_Base

Form that will output as a theme-enabled HTML table

Also adds JavaScript to validate required fields

icms_form_Base
Extended by icms_form_Theme
Extended by icms_ipf_form_Base

Direct known subclasses

icms_ipf_form_Secure
Package: Form
Category: ICMS
Copyright: copyright (c) 2000-2003 XOOPS.org
License: GNU General Public License (GPL)
Author: Kazumi Ono onokazu@xoops.org
Located at ipf/form/Base.php
Methods summary
public
# __construct( string & $target, string $form_name, string $form_caption, string $form_action, string $form_fields = NULL, string $submit_button_caption = FALSE, boolean $cancel_js_action = FALSE, boolean $captcha = FALSE )

Constructor Sets all the values / variables for the IcmsForm class

Constructor Sets all the values / variables for the IcmsForm class

Parameters

$target
$target reference to targetobject (@todo, which object will be passed here?)
$form_name
the form name
$form_caption
the form caption
$form_action
the form action
$form_fields
the form fields
$submit_button_caption
whether to add a caption to the submit button
$cancel_js_action
whether to invoke a javascript action when cancel button is clicked
$captcha
whether to add captcha

Overrides

icms_form_Base::__construct()
public boolean
# addCustomButton( string $name, string $caption, $onclick = FALSE )

Sets variables for adding custom button

Sets variables for adding custom button

Parameters

$name
button name
$caption
load the config's options now?
$onclick

Returns

boolean
$onclick wheter to add onclick event
public
# addElement( object & $formElement, string $key = FALSE, string $var = FALSE, boolean $required = 'notset' )

Add an element to the form

Add an element to the form

Parameters

$formElement
$formElement reference to a icms_form_Element
$key
encrypted key string for the form
$var
some form variables?
$required
is this a "required" element?

Overrides

icms_form_Base::addElement()
public &
# getElementById( string $keyname, mixed $ret,… )

Gets reference to the object for each key in the variables of the targetobject

Gets reference to the object for each key in the variables of the targetobject

Parameters

$keyname
name of the key
$ret,…
Object if the returned object is set, FALSE if no object called (if getname is not equal to the passed keyname)
public string
# render( )

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

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

Returns

string
$ret

Copyright

copyright (c) 2000-2003 XOOPS.org

Author

Kazumi Ono onokazu@xoops.org

Overrides

icms_form_Theme::render()
public
# assign( object & $tpl, mixed $smartyName = FALSE )

assign to smarty form template instead of displaying directly

assign to smarty form template instead of displaying directly

Parameters

$tpl
$tpl reference to a Smarty object
$smartyName
if smartyName is passed, assign it to the smarty call else assign the name of the form element

Copyright

copyright (c) 2000-2003 XOOPS.org

Author

Kazumi Ono onokazu@xoops.org

See

Smarty

Overrides

icms_form_Base::assign()
public boolean
# renderValidationJS( boolean $withtags = TRUE )

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

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

Parameters

$withtags
whether to add script HTML tag to the $js string

Returns

boolean
$js the constructed javascript validation string

Copyright

copyright (c) 2000-2003 XOOPS.org

Author

Kazumi Ono onokazu@xoops.org

Overrides

icms_form_Base::renderValidationJS()
public
# renderValidationJS2( <type> $withtags = TRUE )

Parameters

$withtags
Methods inherited from icms_form_Theme
insertBreak()
Methods inherited from icms_form_Base
display(), getAction(), getElementByName(), getElementNames(), getElementValue(), getElementValues(), getElements(), getExtra(), getMethod(), getName(), getRequired(), getTitle(), setElementValue(), setElementValues(), setExtra(), setRequired()
Properties summary
public $targetObject
# NULL
public $form_fields
# NULL
Properties inherited from icms_form_Base
$_elements
API documentation generated by ApiGen