Docs For Class Formagic

void __construct(
string
$type, string
$name, [
&$args = null], [
&$caller = null], array
$args, object
$caller)

Constructor

Tags:

throws:	Formagic_Exception
access:	public

Overridden in child classes as:

Formagic_Item_PageSwitch::__construct(): Formagic_Item_PageSwitch::__construct()

Parameters:

string	$type	Type of item
string	$name	Name of item
array	$args	Additional attributes
object	$caller	containing Formagic object
	&$args
	&$caller

[ Top ]

integer addRule(
mixed
$rule, [string
$errorMessage = null], [array
$args = null])

Adds rule object to Formagic item

Formagic items can have multiple rules, which are saved in FormagicItem::rules. First parameter $rule can either be a string or a FormagicRule object. String value is assumed to be the type of rule to be added.

This method throws an exception if no valid role object can be identified.

Tags:

throws:	Formagic_Exception
access:	public

Parameters:

mixed	$rule	Rule type or FormagicRule object.
string	$errorMessage	Message returned if rule is violated
array	$args	Optional.

[ Top ]

boolean block(
)

Sets blocked flag

Tags:

access:

public

Overridden in child classes as:

Formagic_Item_Container::block(): Blocks container item and all its descendants

[ Top ]

boolean disable(
)

Sets disabled flag for item and thus removes it from form

Tags:

access:

public

Overridden in child classes as:

Formagic_Item_Container::disable(): Disables container item and all its descendants and thus removes all involved items from form

[ Top ]

Formagic getCaller(
)

Returns parent Formagic object

Tags:

access:

public

[ Top ]

string getErrorMessage(
)

Returns item error message

Returns error message if item check failed or empty string if not

Tags:

access:

public

[ Top ]

string getHtml(
)

HTML template for renderers that use HTML-Code

Tags:

access:

public

Overridden in child classes as:

Formagic_Item_Checkbox::getHtml(): Returns HTML representation of checkbox item

Formagic_Item_Input::getHtml(): HTML string representation of text input field

Formagic_Item_Password::getHtml(): Returns string representation of password item.

Formagic_Item_Radio::getHtml(): Returns string with HTML representation of radio elements

Formagic_Item_Select::getHtml(): HTML representation of Formagic select item

Formagic_Item_Submit::getHtml(): HTML string representation of submit button

[ Top ]

string getLabel(
)

Returns label for this item.

Tags:

access:

public

Overridden in child classes as:

Formagic_Item_Submit::getLabel(): Override parent::getLabel()

[ Top ]

mixed &getValue(
)

Returns current value for this item

Calls Formagic::getValue() as all value storages are held there.

Tags:

access:

public

Overridden in child classes as:

Formagic_Item_Container::getValue(): Returns values of all stored items.

Formagic_Item_Submit::getValue(): Override paren::getValue()

Formagic_Item_PageSwitch::getValue(): Always return no value

[ Top ]

boolean hasRule(
string
$rule)

Tells if rule exists for this item

Tags:

access:

public

Parameters:

string

$rule

[ Top ]

boolean isDisabled(
)

Returns disabled status of item

Tags:

access:

public

[ Top ]

boolean isHidden(
)

Returns hidden status of item

Tags:

access:

public

[ Top ]

array setAttributes(
array
$attArray)

Sets additional attributes for this item

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.

Tags:

access:

public

Parameters:

array

$attArray

[ Top ]

boolean setCaller(

&$caller, object
$caller)

Can be called to set caller object if not passed to constructor

Tags:

access:

public

Parameters:

object	$caller
	&$caller

[ Top ]

boolean setHidden(

$flag)

Sets hidden flag for item

Tags:

access:

public

Overridden in child classes as:

Formagic_Item_Container::setHidden(): Sets hidden flag on container item and all its descendants

Parameters:

$flag

[ Top ]

mixed validate(
)

Performs rule checks

Iterates through all defined rules of Formagic item. Returns true if all rules apply or violated Formagic_Rule object

Tags:

return:	Rule object or boolean
throws:	Formagic_Rule_Exception
access:	public

Overridden in child classes as:

Formagic_Item_Container::validate(): Validates containing items

[ Top ]

boolean _execEvent(
string
$event)

Event dispatcher

Tags:

throws:	Formagic_Exception
access:	public

Parameters:

string

$event

[ Top ]

string _getAttributeStr(
)

Returns attribute string for HTML tag

Tags:

access:

protected

[ Top ]

boolean _handleArg(
string
$key, mixed
$arg)

Handler for additional item arguments

Tags:

access:

protected

Overridden in child classes as:

Formagic_Item_Container::_handleArg(): Generic argument handler

Formagic_Item_Radio::_handleArg(): Argument handler for arguments that are unknown to item parent class

Formagic_Item_Select::_handleArg(): Generic argument handler

Parameters:

string	$key	Argument name
mixed	$arg	Argument value

[ Top ]

boolean _onCreate(
)

Executed when object is created

Tags:

access:

protected

Overridden in child classes as:

Formagic_Item_Container::_onCreate(): OnCreate-Handler implementation

Formagic_Item_Hidden::_onCreate()

Formagic_Item_Radio::_onCreate(): Adds empty element to data array after constructor is processed

Formagic_Item_Submit::_onCreate(): Implementation of onCreate-handler

[ Top ]

void _onFetch(
)

Executed when Formagic::fetch() is called

Tags:

access:

protected

Overridden in child classes as:

Formagic_Item_Container::_onFetch(): OnFetch-handler implementation

Formagic_Item_PageController::_onFetch(): Implementation of fetch handler

[ Top ]

boolean _onPostValidate(
)

Executed after item validation is done

Tags:

access:

protected

Overridden in child classes as:

Formagic_Item_PageController::_onPostValidate(): Implementation of postValidate handler

[ Top ]

boolean _onPreValidate(
)

Executed before item validation

Can be overwritten. Must return true if successful. If not, can either return false or throw exception

Tags:

access:

protected

Overridden in child classes as:

Formagic_Item_PageController::_onPreValidate(): Implementation of preValidate handler

[ Top ]

string __toString(
)

Returns string representation of formItem object

Tags:

access:

public

[ Top ]

Class: Formagic_Item

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Class Details

Tags:

Class Variables

$attributes = array()

Tags:

$defaultValue = null

Tags:

$id =

Tags:

$isPostItem = true

Tags:

$isSubmitted = false

Tags:

$isWide = false

Tags:

$name =

Tags:

$savedValue = null

Tags:

$submittedValue = null

Tags:

$type =

Tags:

$_caller = null

Tags:

$_constantValue = null

Tags:

$_isBlocked = false

Tags:

$_isDisabled = false

Tags:

$_isHidden = false

Tags:

$_label = 'undefined'

Tags:

$_rules = array()

Tags:

Class Methods

constructor __construct [line 154]

Tags:

Parameters:

method addRule [line 358]

Tags:

Parameters:

method block [line 431]

Tags:

method disable [line 461]

Tags:

method getCaller [line 255]

Tags:

method getErrorMessage [line 421]

Tags:

method getHtml [line 305]

Tags:

method getLabel [line 295]

Tags:

method getValue [line 284]

Tags:

method hasRule [line 380]

Tags:

Parameters:

method isDisabled [line 471]

Tags:

method isHidden [line 451]

Tags:

method setAttributes [line 320]

Tags:

Parameters:

method setCaller [line 230]

Tags:

Parameters:

method setHidden [line 441]