Class: Formagic_Item_Select

Source Location: /Item/Select.php

Class Overview

Formagic_Item_Abstract
   |
   --Formagic_Item_Select

formagicItemSelect

Author(s):

Florian Sonnenburg

Version:

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

Copyright:

Variables

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 32]
formagicItemSelect

Tags:

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

[ Top ]

Class Variables

$_data = array()

[line 38]

Array containing select options

Tags:

access:

protected

Type:

array

[ Top ]

$_multi = false

[line 44]

Determines if the selectbox should be displayed as a multi selectbox

Tags:

access:

protected

Type:

boolean

[ Top ]

Class Methods

method getHtml [line 93]

string getHtml(
)

HTML representation of Formagic select item

Tags:

return:	The string representation.
throws:	Formagic_Exception if no options defined
access:	public

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

[ Top ]

method setData [line 69]

Formagic_Item_Select setData(

$data)

Sets the item options.

Tags:

return:	object
access:	public

Parameters:

array

$data

Array of select options

[ Top ]

method setMultiple [line 81]

Formagic_Item_Select setMultiple(
boolean
$flag)

Sets multiple attribute for select field.

Tags:

return:	object
access:	public

Parameters:

boolean

$flag

Bool value if the field has to be multiple.

[ Top ]

method _buildOptions [line 184]

string _buildOptions(

$data, string
$currentVal)

Build select options string.

Tags:

return:	Options string
access:	protected

Parameters:

array	$data	Select options
string	$currentVal	Current value

[ Top ]

method _getMultipleSelect [line 112]

string _getMultipleSelect(
)

Returns the HTML string for a multiselectbox.

Tags:

return:	The HTML string.
access:	protected

[ Top ]

method _getSingleSelect [line 156]

string _getSingleSelect(
)

Returns the HTML string for a single selectbox.

Tags:

return:	The HTML string.
access:	protected

[ Top ]

method _init [line 52]

void _init(

$additionalArgs, array
$arg)

Generic argument handler

Tags:

access:

protected

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

Parameters:

array	$arg	Array of additional options for this item
	$additionalArgs

[ Top ]

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