Class: Formagic_Item_Radio

Source Location: /Item/Radio.php

Class Overview

Formagic_Item_Abstract
   |
   --Formagic_Item_Radio

Input type radio for formagic formgenerator

Author(s):

Florian Sonnenburg

Version:

$Id: Radio.php 126 2011-05-18 18:41:58Z meweasle $

Copyright:

Variables

Constants

Methods

Inherited Variables

Class: Formagic_Item_Abstract

Formagic_Item_Abstract::$_attributes
Formagic_Item_Abstract::$_filteredValue
Formagic_Item_Abstract::$_filters
Formagic_Item_Abstract::$_isDisabled
Formagic_Item_Abstract::$_isFixed
Formagic_Item_Abstract::$_isHidden
Formagic_Item_Abstract::$_isIgnored
Formagic_Item_Abstract::$_isReadonly
Formagic_Item_Abstract::$_label
Formagic_Item_Abstract::$_name
Formagic_Item_Abstract::$_requiredAttributes
Formagic_Item_Abstract::$_rules
Formagic_Item_Abstract::$_value
Formagic_Item_Abstract::$_violatedRules

Inherited Methods

Class: Formagic_Item_Abstract

Formagic_Item_Abstract::__construct(): Constructor
Formagic_Item_Abstract::addAttribute(): Adds an HTML attribute to the attributes stack.
Formagic_Item_Abstract::addFilter(): Adds filter object to Formagic item
Formagic_Item_Abstract::addRule(): Adds rule object to Formagic item
Formagic_Item_Abstract::getAttribute(): Returns the attributes array for this item.
Formagic_Item_Abstract::getAttributes(): Returns the attributes array for this item.
Formagic_Item_Abstract::getAttributeStr(): Returns attribute string for HTML tag.
Formagic_Item_Abstract::getHtml(): HTML template for renderers that use HTML-Code.
Formagic_Item_Abstract::getLabel(): Returns label for this item.
Formagic_Item_Abstract::getName(): Returns the item name.
Formagic_Item_Abstract::getUnfilteredValue(): Returns current unfiltered value for this item.
Formagic_Item_Abstract::getValue(): Returns the current filtered value for this item.
Formagic_Item_Abstract::getViolatedRules(): Returns array of violated rules.
Formagic_Item_Abstract::hasFilter()
Formagic_Item_Abstract::hasRule(): Tells if a rule exists for this item.
Formagic_Item_Abstract::isDisabled(): Returns disabled status of item
Formagic_Item_Abstract::isHidden(): Returns hidden status of item
Formagic_Item_Abstract::isIgnored(): Returns ignore status of item
Formagic_Item_Abstract::printInfo(): Prints item infos.
Formagic_Item_Abstract::setAttributes(): Sets additional attributes for this item.
Formagic_Item_Abstract::setDisabled(): Sets disabled flag for item and removes it from form
Formagic_Item_Abstract::setFixed(): Sets isFixed flag.
Formagic_Item_Abstract::setHidden(): Sets hidden flag for item.
Formagic_Item_Abstract::setIgnore(): Defines if the item will be ignored in form submit.
Formagic_Item_Abstract::setReadonly(): Sets readonly flag
Formagic_Item_Abstract::setRequiredAttributes()
Formagic_Item_Abstract::setValue(): Sets the item value to $value.
Formagic_Item_Abstract::validate(): Performs rule checks
Formagic_Item_Abstract::_buildAttributeStr()
Formagic_Item_Abstract::_filterValue()
Formagic_Item_Abstract::_init(): Allow subclass initialization.
Formagic_Item_Abstract::_makeDomId(): Takes a string and returns a valid DOM ID.
Formagic_Item_Abstract::_validateItemValue(): Perform validation on item value.
Formagic_Item_Abstract::__toString(): Returns the HTML string representation of the form item.

Class Details

[line 31]
Input type radio for formagic formgenerator

Tags:

author:	Florian Sonnenburg
version:	$Id: Radio.php 126 2011-05-18 18:41:58Z meweasle $
copyright:	Copyright (c) 2007-2009 Florian Sonnenburg

[ Top ]

Class Variables

$_data = array()

[line 37]

Array containing radio options.

Tags:

access:

protected

Type:

array

[ Top ]

$_emptyElement =

[line 49]

Contains empty element.

Tags:

access:

private

Type:

mixed

[ Top ]

$_emptyPosition =

[line 55]

Tells where the empty element is going.

Tags:

access:

private

Type:

constant

[ Top ]

$_separator = "\n"

[line 43]

String to separate radio elements from each other.

Tags:

access:

private

Type:

string

[ Top ]

Class Methods

method getHtml [line 158]

string getHtml(
)

Returns string with HTML representation of radio elements

Tags:

access:

public

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

[ Top ]

method setData [line 135]

Formagic_Item_Radio setData(

$data)

Sets "options" for radio elements.

Tags:

return:	Fluent interface
access:	public

Parameters:

array

$data

Associative array with its key being value and its value being the label of radio elements.

[ Top ]

method setEmpty [line 107]

Formagic_Item_Radio setEmpty(
[string|array
$element = null], [integer
$position = Formagic_Item_Radio::EMPTY_PREPEND])

Prepends or appends empty radio input.

Tags:

return:	object
throws:	Formagic_Exception if position is invalid
access:	public

Parameters:

string\|array	$element	Label of empty element if string. If not given, '---' is label of empty element.
integer	$position	Where to add empty element. Allowed values: Formagic_Item_Radio::EMPTY_APPEND Formagic_Item_Radio::EMPTY_PREPEND

[ Top ]

method setSeparator [line 147]

Formagic_Item_Radio setSeparator(
string
$separator)

Sets the separator string to be displayed between radio fields.

Tags:

return:	Fluent interface
access:	public

Parameters:

string

$separator

Separator string

[ Top ]

method _init [line 73]

boolean _init(
array
$additionalArgs)

Radio item initialization.

Tags:

access:

protected

Overrides Formagic_Item_Abstract::_init() (Allow subclass initialization.)

Parameters:

array

$additionalArgs

Array of additional options for radio item

[ Top ]

Class Constants

EMPTY_APPEND = 2

[line 65]

Place empty element as last item.

[ Top ]

EMPTY_PREPEND = 1

[line 60]

Place empty element as first item.

[ Top ]

Documentation generated on Sun, 22 May 2011 22:40:20 +0200 by phpDocumentor 1.4.3