__construct()
__toString()
addAttribute()
addFilter()
addItem()
addRule()
count()
getAttribute()
getAttributeStr()
getAttributes()
getHtml()
getItem()
getItems()
getIterator()
getLabel()
getName()
getUnfilteredValue()
getValue()
getViolatedRules()
hasFilter()
hasRule()
isDisabled()
isHidden()
isIgnored()
printInfo()
setAttributes()
setDisabled()
setFixed()
setHidden()
setIgnore()
setReadonly()
setRequiredAttributes()
setValue()
validate()
_buildAttributeStr()
_filterValue()
_init()
_validateItemValue()
_makeDomId()
$headline
$_attributes
$_filters
$_isDisabled
$_isFixed
$_isHidden
$_isIgnored
$_isReadonly
$_items
$_label
$_name
$_requiredAttributes
$_rules
$_value
$_filteredValue
$_violatedRules
Formagic Container Item class
Changes on following flag will be applied recursively to all items added to the container object: - _isHidden - _isReadonly - _isDisabled
Changes on the flag _isPostItem will only be applied to the container item itself (and defaults to false as there is no use posting a container item).
| category | Formagic |
|---|---|
| package | Item |
| author | Florian Sonnenburg |
| copyright | Copyright (c) 2011 Florian Sonnenburg |
| version | $Id: Container.php 169 2012-05-06 20:16:16Z meweasle $ |
__construct(string $name, array $arguments) : void
| inherited_from | \Formagic_Item_Abstract::__construct() |
|---|
stringName of item
arrayAdditional arguments
\Formagic_Exception |
|---|
__toString() : string
| inherited_from | \Formagic_Item_Abstract::__toString() |
|---|
stringThe HTML string representation.addAttribute(string $name, string $value) : \Formagic_Item_Abstract
Implements a fluent interface pattern.
| inherited_from | \Formagic_Item_Abstract::addAttribute() |
|---|
stringAttribute name
stringAttribute value
\Formagic_Item_AbstractThis object.addFilter(mixed $filter, array $args) : \Formagic_Item_Container
Formagic items can have multiple filters which will be applied in the order they are passed to the object.
First parameter $filter can either be a string or an object of a class that extends Formagic_Filter_Interface. A string value is assumed to be the type of filter to be added.
This method throws an exception if no valid role object can be identified.
Implements a fluent interface pattern.
| see | \Formagic_Item_Abstract::addFilter() |
|---|
mixedFilter type string or Formatic_Filter_Interface object.
arrayOptional array of arguments. Will be passed to the filter constructor as array.
\Formagic_Exception |
if $filter argument is invalid |
|---|
\Formagic_Item_ContainerThis objectaddItem(\Formagic_Item_Abstract | String $item, string $name, array $args) : \Formagic_Item_Container
Creates new item object and adds this, or adds passed formagicItem object
stringString with item name. NULL if $type is Formagic_Item_Abstract object
arrayArray with additional item information. NULL if $type is Formagic_Item_Abstract object
\Formagic_Item_ContainerFluent interfaceaddRule(mixed $rule, array $args) : \Formagic_Item_Container
Formagic items can have multiple rules which will be applied in the order they are passed to the object.
First parameter $rule can either be a string or an instance of a class that extends Formagic_Rule_Abstract. A string value is assumed to be the type of rule to be added.
Implements a fluent interface pattern.
| see | \Formagic_Item_Abstract::addRule() |
|---|
mixedRule type string or Formagic_Rule_Abstract object.
arrayOptional array of arguments. Will be passed to the rule constructor as array.
\Formagic_Exception |
if $rule argument is invalid |
|---|
\Formagic_Item_ContainerThis object.count() : integer
integerThe number of items in this containergetAttribute(string $name) : string
| see | \Formagic_Item_Abstract::setAttributes() |
|---|---|
| see | \Formagic_Item_Abstract::addAttribute() |
| inherited_from | \Formagic_Item_Abstract::getAttribute() |
stringName of the attribute value to fetch
stringAttribute valuegetAttributeStr() : string
Takes the attributes array and transforms it into a string that can be directly inserted into a HTML tag. The string will be built with a trailing space character.
Two default attributes are added to the attributes string: "name" and "id". If you want to skip these, add them to your attributes on item generation or via setAttributes() or addAttribute() with NULL as value.
$item->setAttributes(array('class' => 'myclass', 'onclick' => 'alert('Formagic');'));
$string = $item->getAttributeStr();
echo '';
// output will be:
//
| see | \Formagic_Item_Abstract::setAttributes() |
|---|---|
| see | \Formagic_Item_Abstract::addAttribute() |
| inherited_from | \Formagic_Item_Abstract::getAttributeStr() |
stringThe attributes string.getAttributes() : array
| see | \Formagic_Item_Abstract::setAttributes() |
|---|---|
| see | \Formagic_Item_Abstract::addAttribute() |
| inherited_from | \Formagic_Item_Abstract::getAttributes() |
arrayThe attributes array.getHtml() : string
Should be overwritten by subclasses.
| inherited_from | \Formagic_Item_Abstract::getHtml() |
|---|
stringThe HTML string representation of this item.getItem(string $name, boolean $throwException) : \Formagic_Item_Abstract
Throws Formagic_Exception by default if item does not exist. This can be altered by setting $throwException to FALSE; the result value will be NULL then.
stringItem identifier string.
booleanReturns NULL if set to FALSE.
\Formagic_Exception |
|---|
\Formagic_Item_AbstractReturns the Formagic item identified by $name or throws exception if not found.getItems() : array
arraygetIterator() : \ArrayObject
\ArrayObjectArrayObject with container items.getLabel() : string
| inherited_from | \Formagic_Item_Abstract::getLabel() |
|---|
stringThe label string.getName() : string
| inherited_from | \Formagic_Item_Abstract::getName() |
|---|
stringThe item namegetUnfilteredValue() : mixed
| inherited_from | \Formagic_Item_Abstract::getUnfilteredValue() |
|---|
mixedThe unfiltered item valuegetValue() : array
The return value will be an associative array, the keys beeing the name of the item, the value beeing the filtered item value.
arrayArray of item values.getViolatedRules() : array
If no rules were violated or if no validation has been performed yet, an empty array will be returned.
| inherited_from | \Formagic_Item_Abstract::getViolatedRules() |
|---|
arrayThe violated rules.hasFilter(string $filterName) : boolean
| inherited_from | \Formagic_Item_Abstract::hasFilter() |
|---|
stringFilter name
booleanCheck valuehasRule(string $ruleName) : boolean
The $ruleName parameter has to be a string with the name of rule that is looked for. If you want to know for example if the item has the mandatory rule added, $ruleName would have to be 'mandatory'.
The search string is case insensitive.
addRule($mandatory);
// look for the rule
$ruleExists = $item->hasRule('mandatory'); // would return TRUE
$ruleExists = $item->hasRule('Mandatory'); // would return TRUE
$ruleExists = $item->hasRule('Formagic_Rule_Mandatory'); // would return FALSE
?>
| inherited_from | \Formagic_Item_Abstract::hasRule() |
|---|
stringRule name, eg. 'Mandatory'
booleanisDisabled() : boolean
| inherited_from | \Formagic_Item_Abstract::isDisabled() |
|---|
booleanThe disabled status.isHidden() : boolean
| inherited_from | \Formagic_Item_Abstract::isHidden() |
|---|
booleanThe hidden status.isIgnored() : boolean
| inherited_from | \Formagic_Item_Abstract::isIgnored() |
|---|
booleanThe ignored status.printInfo() : string
| inherited_from | \Formagic_Item_Abstract::printInfo() |
|---|
stringThe item information stringsetAttributes(array $attArray) : \Formagic_Item_Abstract
Mainly used for additional HTML attributes other than "name", "id" or "value", such as "style", "class", javascript-handlers etc. Attributes are added corresponding to key->value-pairs in $attArray.
setAttributes() will overwrite any previously added item attributes.
Implements a fluent interface pattern.
| see | \Formagic_Item_Abstract::addAttribute() |
|---|---|
| inherited_from | \Formagic_Item_Abstract::setAttributes() |
arrayThe new
\Formagic_Item_AbstractThis object.setDisabled(boolean $flag) : \Formagic_Item_Container
Implements a fluent interface pattern.
| see | \Formagic_Item_Abstract::setDisabled() |
|---|
booleanDisabled status flag.
\Formagic_Item_ContainerThis object.setFixed(boolean $flag) : \Formagic_Item_Abstract
If set to true, all following calls to setValue() will be ignored.
Implements a fluent interface pattern.
| inherited_from | \Formagic_Item_Abstract::setFixed() |
|---|
booleanIsFixed flag value.
\Formagic_Item_AbstractThis object.setHidden(boolean $flag) : \Formagic_Item_Container
Implements a fluent interface pattern.
| see | \Formagic_Item_Abstract::setHidden() |
|---|
booleanHidden status flag.
\Formagic_Item_ContainerThis object.setIgnore(boolean $flag) : \Formagic_Item_Abstract
Implements a fluent interface pattern.
| inherited_from | \Formagic_Item_Abstract::setIgnore() |
|---|
booleanIgnored status flag.
\Formagic_Item_AbstractThis object.setReadonly(boolean $flag) : \Formagic_Item_Container
Implements a fluent interface pattern.
| see | \Formagic_Item_Abstract::setReadonly() |
|---|
booleanReadonly status flag.
\Formagic_Item_ContainerThis object.setRequiredAttributes(array $requiredAttributes) : \Formagic_Item_Abstract
Default required attributes are "id" and "name".
| inherited_from | \Formagic_Item_Abstract::setRequiredAttributes() |
|---|
arrayNumeric array of required attributes.
\Formagic_Item_AbstractFluent interface.setValue(array $value) : \Formagic_Item_Container
Other than in Formagic_Item_Abstract defined, $value has to be an associative array, the key beeing the name of the item the value belongs to.
Implements a fluent interface pattern.
arraySet of new values for contained items.
\Formagic_Item_ContainerThis object.validate() : boolean
Iterates through all contained items. If any rule is violated, sub-item will return violated Formagic_Rule item and the container will pass it on.
If all items pass violation, validate() calls onValidate-handler and returns its result.
boolean_buildAttributeStr(array $attributes) : string
| inherited_from | \Formagic_Item_Abstract::_buildAttributeStr() |
|---|
arrayarray of attributes
stringAttributes string_filterValue(Formagic_Filter_Interface $filter, mixed $subject) : mixed
| inherited_from | \Formagic_Item_Abstract::_filterValue() |
|---|
mixedScalar or array
mixedFiltered scalar or array_init(array $additionalArgs) : void
| inherited_from | \Formagic_Item_Abstract::_init() |
|---|
arrayArray of arguments that are not processed by superclass.
_validateItemValue(Formagic_Rule_Abstract $rule, string | array $subject) : boolean
| inherited_from | \Formagic_Item_Abstract::_validateItemValue() |
|---|
stringarrayValidation subject
booleanValidation result_makeDomId(string $str) : string
| inherited_from | \Formagic_Item_Abstract::_makeDomId() |
|---|
stringString to convert to a DOM ID
stringValid DOM ID$headline : string
$_attributes : array
| inherited_from | \Formagic_Item_Abstract::$$_attributes |
|---|
$_filters : array
| inherited_from | \Formagic_Item_Abstract::$$_filters |
|---|
$_isDisabled : boolean
| inherited_from | \Formagic_Item_Abstract::$$_isDisabled |
|---|
$_isFixed : boolean
| inherited_from | \Formagic_Item_Abstract::$$_isFixed |
|---|
$_isHidden : boolean
| inherited_from | \Formagic_Item_Abstract::$$_isHidden |
|---|
$_isIgnored : boolean
| inherited_from | \Formagic_Item_Abstract::$$_isIgnored |
|---|
$_isReadonly : boolean
| inherited_from | \Formagic_Item_Abstract::$$_isReadonly |
|---|
$_items : string
$_label : boolean
| inherited_from | \Formagic_Item_Abstract::$$_label |
|---|
$_name : string
| inherited_from | \Formagic_Item_Abstract::$$_name |
|---|
$_requiredAttributes : array
$_rules : array
| inherited_from | \Formagic_Item_Abstract::$$_rules |
|---|
$_value : mixed
| inherited_from | \Formagic_Item_Abstract::$$_value |
|---|
$_filteredValue : mixed
| inherited_from | \Formagic_Item_Abstract::$$_filteredValue |
|---|
$_violatedRules : \Form_Rule_Abstract
| inherited_from | \Formagic_Item_Abstract::$$_violatedRules |
|---|