Class: Formagic_Item_PageController

Source Location: /Item/PageController.php

Class Overview

Formagic_Item
   |
   --Formagic_Item_Container
      |
      --Formagic_Item_PageController

Formagic_Item_PageController

Author(s):

Florian Sonnenburg

Version:

$Id: PageController.php 19 2007-08-22 22:02:47Z meweasle $

Copyright:

Variables

$hasHtml

Methods

Inherited Variables

Class: Formagic_Item_Container

Formagic_Item_Container::$headline
Formagic_Item_Container::$_items

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_Container

Formagic_Item_Container::addItem(): Adds formagic item object to array of items.
Formagic_Item_Container::block(): Blocks container item and all its descendants
Formagic_Item_Container::countItems(): Counts items added to self and all sub-containers
Formagic_Item_Container::disable(): Disables container item and all its descendants and thus removes all involved items from form
Formagic_Item_Container::getAttributeStr(): Returns HTML attributes as one assembled string
Formagic_Item_Container::getItem(): Returns added item $name
Formagic_Item_Container::getItems(): Returns pointer to items array
Formagic_Item_Container::getValue(): Returns values of all stored items.
Formagic_Item_Container::setHidden(): Sets hidden flag on container item and all its descendants
Formagic_Item_Container::validate(): Validates containing items
Formagic_Item_Container::_handleArg(): Generic argument handler
Formagic_Item_Container::_onCreate(): OnCreate-Handler implementation
Formagic_Item_Container::_onFetch(): OnFetch-handler implementation

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 33]
Formagic_Item_PageController

Tags:

author:	Florian Sonnenburg
version:	$Id: PageController.php 19 2007-08-22 22:02:47Z meweasle $
copyright:	Copyright (c) 2007 Florian Sonnenburg
access:	public
license:	New BSD License

[ Top ]

Class Variables

$hasHtml = false

[line 46]

Page item has no own HTML representation

Tags:

access:

public

Type:	boolean
Overrides:	Array

[ Top ]

Class Methods

method addItem [line 141]

Formagic_Item addItem(
string
$type, string
$name, [array
$args = null])

Overwrites Formagic_Container::addItem()

Tags:

access:

public

Overrides Formagic_Item_Container::addItem() (Adds formagic item object to array of items.)

Parameters:

string	$type
string	$name
array	$args

[ Top ]

method getItems [line 161]

array &getItems(
)

Returns items of currently displayed page

Tags:

access:

public

Overrides Formagic_Item_Container::getItems() (Returns pointer to items array)

[ Top ]

method getReferringPage [line 118]

string getReferringPage(
)

Returns name of page item that called currently requested page

Referring page is NULL if form is in initial state

Tags:

access:

public

[ Top ]

method getRequestedPage [line 89]

mixed getRequestedPage(
)

Returns string with page item name or NULL if none detected

Page submit item posts array with exactly one entry. The key of that entry is requested page name.

getRequestedPage() returns NULL if form is being submitted without requesting another page or if there are no page items added to page controller

Tags:

return:	String or NULL
access:	public

[ Top ]

method _onFetch [line 215]

void _onFetch(
)

Implementation of fetch handler

Tags:

access:

protected

Overrides Formagic_Item_Container::_onFetch() (OnFetch-handler implementation)

[ Top ]

method _onPostValidate [line 199]

boolean _onPostValidate(
)

Implementation of postValidate handler

Tags object to be out of validation. Averts form from beeing executed when any other page is requested.

Tags:

access:

protected

Overrides Formagic_Item::_onPostValidate() (Executed after item validation is done)

[ Top ]

method _onPreValidate [line 185]

boolean _onPreValidate(
)

Implementation of preValidate handler

Tags object to be in validation.

Tags:

access:

protected

Overrides Formagic_Item::_onPreValidate() (Executed before item validation)

[ Top ]

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