Class: Naos_Form_AbstractSource

Source Location: /Form/AbstractSource.php

Class Naos_Form_AbstractSource

Class Overview

Naos_Form_AbstractSource defines the interface for a data source.

You are able to define a new data source for forms by implementing the abstract functions of this class and by adding the new source to the form data source list (configuration).

Located in /Form/AbstractSource.php [line 27]

Author(s):

API Tags:

Abstract:

Information Tags:

Copyright:	Copyright (c) 2008 Jupiter GmbH
License:	http://www.naos-framework.com/website.naos.framework/en/license

Methods

[ Top ]

Descendants

Child Class	Description
Naos_Form_HttpPostSource	Naos_Form_HttpPostSource implements the well known $_POST source as form data source.
Naos_Form_XmlRequestSource	Naos_Form_XmlRequestSource provides support for the AJAX XML data source.

[ Top ]

Method Summary

array	getAvailableForms()	Returns an array with form identifier which are available for receiving.
array	getAvailableItems()	Returns an array with the available items and their titles of an specific form path.
string	getItemDescriptor()	Returns the item descriptor of an form path. The return value consists of an comma separated list of the available items and their input class.
string	getItemTitleDescriptor()	Returns the item titles of an form path. The value is in general an automatic generated value from the template compiler.
mixed	getItemValue()	Returns the value of an item path.
mixed	hasItemValue()	Checks for an value of an item path.

[ Top ]

Methods

getAvailableForms [line 34]

array getAvailableForms(
)

Returns an array with form identifier which are available for receiving.

API Tags:

Abstract:
Access:	public

Redefined in descendants as:

[ Top ]

getAvailableItems [line 71]

array getAvailableItems(

$path 
)

Returns an array with the available items and their titles of an specific form path.

Parameters:

$path:

API Tags:

Access:

public

[ Top ]

getItemDescriptor [line 46]

string getItemDescriptor(

$path 
)

Returns the item descriptor of an form path. The return value consists of an comma separated list of the available items and their input class.

e.g. name:text,begin:date

The individual parts are urlencoded.

Parameters:

$path:

API Tags:

Abstract:
Access:	protected

Redefined in descendants as:

[ Top ]

getItemTitleDescriptor [line 61]

string getItemTitleDescriptor(

$path 
)

Returns the item titles of an form path. The value is in general an automatic generated value from the template compiler.

e.g. name:Name,begin:Anfangsdatum

The individual parts are urlencoded.

TODO: Modify behaviour. Se should read the title from a file which is created by the template compiler.

Parameters:

$path:

API Tags:

Abstract:
Access:	protected

Redefined in descendants as:

[ Top ]

getItemValue [line 127]

mixed getItemValue(

$path 
)

Returns the value of an item path.

Parameters:

$path:

API Tags:

Abstract:
Access:	public

Redefined in descendants as:

[ Top ]

hasItemValue [line 135]

mixed hasItemValue(

$path 
)

Checks for an value of an item path.

Parameters:

$path:

API Tags:

Abstract:
Access:	public

Redefined in descendants as:

[ Top ]

Documentation generated on Sat, 13 Sep 2008 01:40:35 -0400 by phpDocumentor 1.4.0

	Naos_Form

[ class tree: Naos_Form ] [ index: Naos_Form ] [ all elements ]