Graphe d'héritage de FOFForm:

Fonctions membres publiques
	getAttribute ($attribute, $default=null)

	loadCSSFiles ()

	loadJSFiles ()

	getData ()

	setModel (FOFModel &$model)

&	getModel ()

	setView (FOFView &$view)

&	getView ()

	getHeaderset ()

	getHeader ($name, $group=null, $value=null)

	removeHeader ($name, $group=null)

Fonctions membres publiques statiques
static	getInstance ($name, $data=null, $options=array(), $replace=true, $xpath=false)

static	addFieldPath ($new=null)

static	addHeaderPath ($new=null)

static	addFormPath ($new=null)

static	addRulePath ($new=null)

Fonctions membres protégées
&	findHeadersByGroup ($group=null, $nested=false)

	findHeader ($name, $group=null)

	loadHeader ($element, $group=null, $value=null)

	loadFieldType ($type, $new=true)

	loadHeaderType ($type, $new=true)

	loadRuleType ($type, $new=true)

Attributs protégés
	$model

	$view

Documentation des fonctions membres

◆ addFieldPath()

static addFieldPath ( $new = null )

static

Proxy for FOFFormHelper::addFieldPath().

Paramètres

mixed $new A path or array of paths to add.

Renvoie: array The list of paths that have been added.

Depuis: 2.0

Référencé par FOFModel\loadForm().

◆ addFormPath()

static addFormPath ( $new = null )

static

Proxy for FOFFormHelper::addFormPath().

Paramètres

mixed $new A path or array of paths to add.

Renvoie: array The list of paths that have been added.

Voir également: FOFFormHelper::addFormPath()

Depuis: 2.0

Référencé par FOFModel\loadForm().

◆ addHeaderPath()

static addHeaderPath ( $new = null )

static

Proxy for FOFFormHelper::addHeaderPath().

Paramètres

mixed $new A path or array of paths to add.

Renvoie: array The list of paths that have been added.

Depuis: 2.0

Références FOFFormHelper\addHeaderPath().

Référencé par FOFModel\loadForm().

◆ addRulePath()

static addRulePath ( $new = null )

static

Proxy for FOFFormHelper::addRulePath().

Paramètres

mixed $new A path or array of paths to add.

Renvoie: array The list of paths that have been added.

Voir également: FOFFormHelper::addRulePath()

Depuis: 2.0

◆ findHeader()

findHeader	(	$name,
		$group = `null`
	)

protected

Method to get a header field represented as an XML element object.

Paramètres

string	$name	The name of the form field.
string	$group	The optional dot-separated form group path on which to find the field.

Renvoie: mixed The XML element object for the field or boolean false on error.

Depuis: 2.0

Références $field, $fields, $name, $names, et $tmp.

Référencé par findHeadersByGroup(), getHeader(), et removeHeader().

◆ findHeadersByGroup()

& findHeadersByGroup	(	$group = `null`,
		$nested = `false`
	)

protected

Method to get an array of <header> elements from the form XML document which are in a control group by name.

Paramètres

mixed	$group	The optional dot-separated form group path on which to find the fields. Null will return all fields. False will return fields not in a group.
boolean	$nested	True to also include fields in nested groups that are inside of the group for which to find fields.

Renvoie: mixed Boolean false on error or array of SimpleXMLElement objects.

Depuis: 2.0

Références $field, $fields, $names, $tmp, elseif, et findHeader().

Référencé par getHeaderset().

◆ getAttribute()

getAttribute	(	$attribute,
		$default = `null`
	)

Returns the value of an attribute of the form itself

Paramètres

string	$attribute	The name of the attribute
mixed	$default	Optional default value to return

Renvoie: mixed

Depuis: 2.0

Références $default, et $value.

Référencé par loadCSSFiles(), et loadJSFiles().

◆ getData()

getData ( )

Returns a reference to the protected $data object, allowing direct access to and manipulation of the form's data.

Renvoie: JRegistry The form's data registry

Depuis: 2.0

Références $data.

◆ getHeader()

getHeader	(	$name,
		$group = `null`,
		$value = `null`
	)

Method to get a header field represented as a FOFFormHeader object.

Paramètres

string	$name	The name of the header field.
string	$group	The optional dot-separated form group path on which to find the field.
mixed	$value	The optional value to use as the default for the field.

Renvoie: mixed The FOFFormHeader object for the field or boolean false on error.

Depuis: 2.0

Références $name, $value, findHeader(), et loadHeader().

◆ getHeaderset()

getHeaderset ( )

Method to get an array of FOFFormHeader objects in the headerset.

Renvoie: array The array of FOFFormHeader objects in the headerset.

Depuis: 2.0

Références $field, $fields, $groups, findHeadersByGroup(), et loadHeader().

◆ getInstance()

static getInstance	(	$name,
		$data = `null`,
		$options = `array()`,
		$replace = `true`,
		$xpath = `false`
	)

static

Method to get an instance of a form.

Paramètres

string	$name	The name of the form.
string	$data	The name of an XML file or string to load as the form definition.
array	$options	An array of form options.
bool	$replace	Flag to toggle whether form fields should be replaced if a field already exists with the same group/name.
bool \| string	$xpath	An optional xpath to search for the fields.

Renvoie: object FOFForm instance.

Depuis: 2.0

Exceptions

InvalidArgumentException	if no data provided.
RuntimeException	if the form could not be loaded.

Références $data, $name, et $options.

Référencé par FOFModel\loadForm().

◆ getModel()

& getModel ( )

Returns the FOFModel attached to this form

Renvoie: FOFModel

Références $model.

◆ getView()

& getView ( )

Returns the FOFView attached to this form

Renvoie: FOFView

Références $view.

◆ loadCSSFiles()

loadCSSFiles ( )

Loads the CSS files defined in the form, based on its cssfiles attribute

Renvoie: void

Depuis: 2.0

Références $alt, $parts, FOFTemplateUtils\addCSS(), FOFTemplateUtils\addLESS(), getAttribute(), et null.

◆ loadFieldType()

loadFieldType	(	$type,
		$new = `true`
	)

protected

Proxy for FOFFormHelper::loadFieldType().

Paramètres

string	$type	The field type.
boolean	$new	Flag to toggle whether we should get a new instance of the object.

Renvoie: mixed FOFFormField object on success, false otherwise.

Depuis: 2.0

Références $type, et FOFFormHelper\loadFieldType().

◆ loadHeader()

loadHeader	(	$element,
		$group = `null`,
		$value = `null`
	)

protected

Method to load, setup and return a FOFFormHeader object based on field data.

Paramètres

string	$element	The XML element object representation of the form field.
string	$group	The optional dot-separated form group path on which to find the field.
mixed	$value	The optional value to use as the default for the field.

Renvoie: mixed The FOFFormHeader object for the field or boolean false on error.

Depuis: 2.0

Références $field, $type, $value, et loadHeaderType().

Référencé par getHeader(), et getHeaderset().

◆ loadHeaderType()

loadHeaderType	(	$type,
		$new = `true`
	)

protected

Proxy for FOFFormHelper::loadHeaderType().

Paramètres

string	$type	The field type.
boolean	$new	Flag to toggle whether we should get a new instance of the object.

Renvoie: mixed FOFFormHeader object on success, false otherwise.

Depuis: 2.0

Références $type, et FOFFormHelper\loadHeaderType().

Référencé par loadHeader().

◆ loadJSFiles()

loadJSFiles ( )

Loads the Javascript files defined in the form, based on its jsfiles attribute

Renvoie: void

Depuis: 2.0

Références FOFTemplateUtils\addJS(), et getAttribute().

◆ loadRuleType()

loadRuleType	(	$type,
		$new = `true`
	)

protected

Proxy for FOFFormHelper::loadRuleType().

Paramètres

string	$type	The rule type.
boolean	$new	Flag to toggle whether we should get a new instance of the object.

Renvoie: mixed JFormRule object on success, false otherwise.

Voir également: FOFFormHelper::loadRuleType()

Depuis: 2.0

Références $type.

◆ removeHeader()

removeHeader	(	$name,
		$group = `null`
	)

Method to remove a header from the form definition.

Paramètres

string	$name	The name of the form field for which remove.
string	$group	The optional dot-separated form group path on which to find the field.

Renvoie: boolean True on success, false otherwise.

Exceptions

UnexpectedValueException

Références $name, et findHeader().

◆ setModel()

setModel ( FOFModel & $model )

Attaches a FOFModel to this form

Paramètres

FOFModel &$model The model to attach to the form

Renvoie: void

Références $model.

◆ setView()

setView ( FOFView & $view )

Attaches a FOFView to this form

Paramètres

FOFView &$view The view to attach to the form

Renvoie: void

Références $view, et view.

Documentation des champs

◆ $model

$model

protected

Référencé par getModel(), et setModel().

◆ $view

$view

protected

Référencé par getView(), et setView().

La documentation de cette classe a été générée à partir du fichier suivant :

libraries/fof/form/form.php

Fonctions membres publiques

Fonctions membres publiques statiques

Fonctions membres protégées

Attributs protégés

Documentation des fonctions membres

◆ addFieldPath()

◆ addFormPath()

◆ addHeaderPath()

◆ addRulePath()

◆ findHeader()

◆ findHeadersByGroup()

◆ getAttribute()

◆ getData()

◆ getHeader()

◆ getHeaderset()

◆ getInstance()

◆ getModel()

◆ getView()

◆ loadCSSFiles()

◆ loadFieldType()

◆ loadHeader()

◆ loadHeaderType()

◆ loadJSFiles()

◆ loadRuleType()

◆ removeHeader()

◆ setModel()

◆ setView()

Documentation des champs

◆ $model

◆ $view