Class: Formagic_Item_Radio

Source Location: /Item/Radio.php

Class Overview

Formagic_Item
   |
   --Formagic_Item_Radio

Input type radio for formagic formgenerator

Author(s):

Florian Sonnenburg

Version:

$Id: Radio.php 11 2007-08-12 20:02:57Z meweasle $

Copyright:

Methods

Inherited Variables

Class: Formagic_Item

Formagic_Item::$attributes
Formagic_Item::$defaultValue
Formagic_Item::$id
Formagic_Item::$isPostItem
Formagic_Item::$isSubmitted
Formagic_Item::$isWide
Formagic_Item::$name
Formagic_Item::$savedValue
Formagic_Item::$submittedValue
Formagic_Item::$type
Formagic_Item::$_caller
Formagic_Item::$_constantValue
Formagic_Item::$_isBlocked
Formagic_Item::$_isDisabled
Formagic_Item::$_isHidden
Formagic_Item::$_label
Formagic_Item::$_rules

Inherited Methods

Class: Formagic_Item

Formagic_Item::__construct(): Constructor
Formagic_Item::addRule(): Adds rule object to Formagic item
Formagic_Item::block(): Sets blocked flag
Formagic_Item::disable(): Sets disabled flag for item and thus removes it from form
Formagic_Item::getCaller(): Returns parent Formagic object
Formagic_Item::getErrorMessage(): Returns item error message
Formagic_Item::getHtml(): HTML template for renderers that use HTML-Code
Formagic_Item::getLabel(): Returns label for this item.
Formagic_Item::getValue(): Returns current value for this item
Formagic_Item::hasRule(): Tells if rule exists for this item
Formagic_Item::isDisabled(): Returns disabled status of item
Formagic_Item::isHidden(): Returns hidden status of item
Formagic_Item::setAttributes(): Sets additional attributes for this item
Formagic_Item::setCaller(): Can be called to set caller object if not passed to constructor
Formagic_Item::setHidden(): Sets hidden flag for item
Formagic_Item::validate(): Performs rule checks
Formagic_Item::_execEvent(): Event dispatcher
Formagic_Item::_getAttributeStr(): Returns attribute string for HTML tag
Formagic_Item::_handleArg(): Handler for additional item arguments
Formagic_Item::_onCreate(): Executed when object is created
Formagic_Item::_onFetch(): Executed when Formagic::fetch() is called
Formagic_Item::_onPostValidate(): Executed after item validation is done
Formagic_Item::_onPreValidate(): Executed before item validation
Formagic_Item::__toString(): Returns string representation of formItem object

Class Details

[line 32]
Input type radio for formagic formgenerator

Tags:

author:	Florian Sonnenburg
version:	$Id: Radio.php 11 2007-08-12 20:02:57Z meweasle $
copyright:	Copyright (c) 2007 Florian Sonnenburg

[ Top ]

Class Methods

method addEmpty [line 93]

boolean addEmpty(
mixed
$element, mixed
$pos)

Saves empty element

Tags:

access:

public

Parameters:

mixed	$element	Label of empty element if string. If true, '---' is label of empty element.
mixed	$pos	Where to add empty element. Allowed values: 'first' or 'last'

[ Top ]

method getHtml [line 149]

string getHtml(
)

Returns string with HTML representation of radio elements

Tags:

access:

public

Overrides Formagic_Item::getHtml() (HTML template for renderers that use HTML-Code)

[ Top ]

method setData [line 127]

boolean setData(
array
$arr)

Sets data for radio elements

Tags:

access:

public

Parameters:

array

$arr

Associative array. Array-key will be value of radio elements, array-value will be label.

[ Top ]

method setSeparator [line 139]

string setSeparator(
string
$separator)

Sets separator string

Tags:

access:

public

Parameters:

string

$separator

[ Top ]

method _handleArg [line 62]

boolean _handleArg(
string
$key, mixed
$arg)

Argument handler for arguments that are unknown to item parent class

Tags:

access:

protected

Overrides Formagic_Item::_handleArg() (Handler for additional item arguments)

Parameters:

string	$key	Argument name
mixed	$arg	Argument value

[ Top ]

method _onCreate [line 108]

boolean _onCreate(
)

Adds empty element to data array after constructor is processed

Tags:

access:

protected

Overrides Formagic_Item::_onCreate() (Executed when object is created)

[ Top ]

Documentation generated on Thu, 23 Aug 2007 00:29:46 +0200 by phpDocumentor 1.4.0