kernel
[ class tree: kernel ] [ index: kernel ] [ all elements ]

Class: XoopsFormCheckBox

Source Location: /class/xoopsform/formcheckbox.php

Class Overview

XoopsFormElement
   |
   --XoopsFormCheckBox

One or more Checkbox(es)


Author(s):

Copyright:

  • copyright (c) 2000-2003 XOOPS.org

Methods


Inherited Methods

Class: XoopsFormElement

XoopsFormElement::XoopsFormElement()
constructor
XoopsFormElement::getAccessKey()
get the "accesskey" attribute for the element
XoopsFormElement::getAccessString()
If the accesskey is found in the specified string, underlines it
XoopsFormElement::getCaption()
get the caption for the element
XoopsFormElement::getClass()
get the "class" attribute for the element
XoopsFormElement::getDescription()
get the element's description
XoopsFormElement::getExtra()
Get the extra attributes for the element
XoopsFormElement::getName()
get the "name" attribute for the element
XoopsFormElement::isContainer()
Is this element a container of other elements?
XoopsFormElement::isHidden()
Find out if an element is "hidden".
XoopsFormElement::render()
Generates output for the element.
XoopsFormElement::setAccessKey()
set the "accesskey" attribute for the element
XoopsFormElement::setCaption()
set the caption for the element
XoopsFormElement::setClass()
set the "class" attribute for the element
XoopsFormElement::setDescription()
set the element's description
XoopsFormElement::setExtra()
Add extra attributes to the element.
XoopsFormElement::setHidden()
flag the element as "hidden"
XoopsFormElement::setName()
set the "name" attribute for the element

Class Details

[line 47]
One or more Checkbox(es)



Tags:

copyright:  copyright (c) 2000-2003 XOOPS.org
author:  Kazumi Ono <onokazu@xoops.org>


[ Top ]


Class Methods


constructor XoopsFormCheckBox [line 70]

XoopsFormCheckBox XoopsFormCheckBox( string $caption, string $name, [mixed $value = null])

Constructor



Parameters:

string   $caption  
string   $name  
mixed   $value   Either one value as a string or an array of them.

[ Top ]

method addOption [line 109]

void addOption( string $value, [string $name = ""])

Add an option



Parameters:

string   $value  
string   $name  

[ Top ]

method addOptionArray [line 122]

void addOptionArray( array $options)

Add multiple Options at once



Parameters:

array   $options   Associative array of value->name pairs

[ Top ]

method getOptions [line 135]

array getOptions( )

Get an array with all the options



Tags:

return:  Associative array of value->name pairs


[ Top ]

method getValue [line 83]

array getValue( )

Get the "value"



[ Top ]

method render [line 144]

string render( )

prepare HTML for output



Overrides XoopsFormElement::render() (Generates output for the element.)

[ Top ]

method setValue [line 92]

void setValue( array $value)

Set the "value"



Parameters:

array   $value  

[ Top ]


Documentation generated on Fri, 03 Mar 2006 08:55:58 +0000 by phpDocumentor 1.3.0RC3