Class FOFForm

FOFForm is an extension to JForm which support not only edit views but also browse (record list) and read (single record display) views based on XML forms.

JForm

FOFForm

Package: FrameworkOnFramework\form
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 2.0
Located at fof/form/form.php

Methods summary

`public static object`	# `getInstance( string $name, string $data = null, array $options = array(), boolean $replace = true, boolean\|string $xpath = false )` Method to get an instance of a form. Method to get an instance of a form. Parameters `$name` `string` - $name The name of the form. `$data` `string` - $data The name of an XML file or string to load as the form definition. `$options` `array` - $options An array of form options. `$replace` `boolean` - $replace Flag to toggle whether form fields should be replaced if a field already exists with the same group/name. `$xpath` `boolean\|string` - $xpath An optional xpath to search for the fields. Returns `object` - FOFForm instance. Throws `InvalidArgumentException` - if no data provided. `RuntimeException` - if the form could not be loaded. Since 2.0 Overrides `JForm::getInstance`
`public mixed`	# `getAttribute( string $attribute, mixed $default = null )` Returns the value of an attribute of the form itself Returns the value of an attribute of the form itself Parameters `$attribute` `string` - $attribute The name of the attribute `$default` `mixed` - $default Optional default value to return Returns `mixed` Since 2.0 Overrides `JForm::getAttribute`
`public`	# `loadCSSFiles( )` Loads the CSS files defined in the form, based on its cssfiles attribute Loads the CSS files defined in the form, based on its cssfiles attribute Since 2.0
`public`	# `loadJSFiles( )` Loads the Javascript files defined in the form, based on its jsfiles attribute Loads the Javascript files defined in the form, based on its jsfiles attribute Since 2.0
`public JRegistry`	# `getData( )` Returns a reference to the protected $data object, allowing direct access to and manipulation of the form's data. Returns a reference to the protected $data object, allowing direct access to and manipulation of the form's data. Returns `JRegistry` - The form's data registry Since 2.0 Overrides `JForm::getData`
`public`	# `setModel( FOFModel & $model )` Attaches a FOFModel to this form Attaches a FOFModel to this form Parameters `$model` `FOFModel` - &$model The model to attach to the form
`public FOFModel &`	# `getModel( )` Returns the FOFModel attached to this form Returns the FOFModel attached to this form Returns `FOFModel`
`public`	# `setView( FOFView & $view )` Attaches a FOFView to this form Attaches a FOFView to this form Parameters `$view` `FOFView` - &$view The view to attach to the form
`public FOFView &`	# `getView( )` Returns the FOFView attached to this form Returns the FOFView attached to this form Returns `FOFView`
`public array`	# `getHeaderset( )` Method to get an array of FOFFormHeader objects in the headerset. Method to get an array of FOFFormHeader objects in the headerset. Returns `array` - The array of FOFFormHeader objects in the headerset. Since 2.0
`protected mixed &`	# `findHeadersByGroup( mixed $group = null, boolean $nested = false )` Method to get an array of <header /> elements from the form XML document which are in a control group by name. Method to get an array of <header /> elements from the form XML document which are in a control group by name. Parameters `$group` `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. `$nested` `boolean` - $nested True to also include fields in nested groups that are inside of the group for which to find fields. Returns `mixed` - Boolean false on error or array of SimpleXMLElement objects. Since 2.0
`public mixed`	# `getHeader( string $name, string $group = null, mixed $value = null )` Method to get a header field represented as a FOFFormHeader object. Method to get a header field represented as a FOFFormHeader object. Parameters `$name` `string` - $name The name of the header field. `$group` `string` - $group The optional dot-separated form group path on which to find the field. `$value` `mixed` - $value The optional value to use as the default for the field. Returns `mixed` - The FOFFormHeader object for the field or boolean false on error. Since 2.0
`protected mixed`	# `findHeader( string $name, string $group = null )` Method to get a header field represented as an XML element object. Method to get a header field represented as an XML element object. Parameters `$name` `string` - $name The name of the form field. `$group` `string` - $group The optional dot-separated form group path on which to find the field. Returns `mixed` - The XML element object for the field or boolean false on error. Since 2.0
`protected mixed`	# `loadHeader( string $element, string $group = null, mixed $value = null )` Method to load, setup and return a FOFFormHeader object based on field data. Method to load, setup and return a FOFFormHeader object based on field data. Parameters `$element` `string` - $element The XML element object representation of the form field. `$group` `string` - $group The optional dot-separated form group path on which to find the field. `$value` `mixed` - $value The optional value to use as the default for the field. Returns `mixed` - The FOFFormHeader object for the field or boolean false on error. Since 2.0
`public boolean`	# `removeHeader( string $name, string $group = null )` Method to remove a header from the form definition. Method to remove a header from the form definition. Parameters `$name` `string` - $name The name of the form field for which remove. `$group` `string` - $group The optional dot-separated form group path on which to find the field. Returns `boolean` - True on success, false otherwise. Throws `UnexpectedValueException`
`protected mixed`	# `loadFieldType( string $type, boolean $new = true )` Proxy for `FOFFormHelper::loadFieldType()`. Proxy for `FOFFormHelper::loadFieldType()`. Parameters `$type` `string` - $type The field type. `$new` `boolean` - $new Flag to toggle whether we should get a new instance of the object. Returns `mixed` - FOFFormField object on success, false otherwise. Since 2.0 Overrides `JForm::loadFieldType`
`protected mixed`	# `loadHeaderType( string $type, boolean $new = true )` Proxy for `FOFFormHelper::loadHeaderType()`. Proxy for `FOFFormHelper::loadHeaderType()`. Parameters `$type` `string` - $type The field type. `$new` `boolean` - $new Flag to toggle whether we should get a new instance of the object. Returns `mixed` - FOFFormHeader object on success, false otherwise. Since 2.0
`protected mixed`	# `loadRuleType( string $type, boolean $new = true )` Proxy for `JFormHelper::loadRuleType()`. Proxy for `JFormHelper::loadRuleType()`. Parameters `$type` `string` - $type The rule type. `$new` `boolean` - $new Flag to toggle whether we should get a new instance of the object. Returns `mixed` - JFormRule object on success, false otherwise. Since 2.0 See `JFormHelper::loadRuleType()` Overrides `JForm::loadRuleType`
`public static array`	# `addFieldPath( mixed $new = null )` Proxy for `JFormHelper::addFieldPath()`. Proxy for `JFormHelper::addFieldPath()`. Parameters `$new` `mixed` - $new A path or array of paths to add. Returns `array` - The list of paths that have been added. Since 2.0 Overrides `JForm::addFieldPath`
`public static array`	# `addHeaderPath( mixed $new = null )` Proxy for `FOFFormHelper::addHeaderPath()`. Proxy for `FOFFormHelper::addHeaderPath()`. Parameters `$new` `mixed` - $new A path or array of paths to add. Returns `array` - The list of paths that have been added. Since 2.0
`public static array`	# `addFormPath( mixed $new = null )` Proxy for FOFFormHelper::addFormPath(). Proxy for FOFFormHelper::addFormPath(). Parameters `$new` `mixed` - $new A path or array of paths to add. Returns `array` - The list of paths that have been added. Since 2.0 See `JFormHelper::addFormPath()` Overrides `JForm::addFormPath`
`public static array`	# `addRulePath( mixed $new = null )` Proxy for FOFFormHelper::addRulePath(). Proxy for FOFFormHelper::addRulePath(). Parameters `$new` `mixed` - $new A path or array of paths to add. Returns `array` - The list of paths that have been added. Since 2.0 See `JFormHelper::addRulePath()` Overrides `JForm::addRulePath`

Methods inherited from JForm

__construct(), addNode(), bind(), bindLevel(), filter(), filterField(), findField(), findFieldsByFieldset(), findFieldsByGroup(), findGroup(), getControlGroup(), getControlGroups(), getErrors(), getField(), getFieldAttribute(), getFieldXml(), getFieldset(), getFieldsets(), getFormControl(), getGroup(), getInput(), getLabel(), getName(), getValue(), getXml(), load(), loadField(), loadFile(), mergeNode(), mergeNodes(), removeField(), removeGroup(), renderField(), renderFieldset(), reset(), setField(), setFieldAttribute(), setFields(), setValue(), syncPaths(), validate(), validateField()

Magic methods summary

Properties summary

`protected FOFModel`	`$model`	# The model attached to this view The model attached to this view
`protected FOFView`	`$view`	# The view used to render this form The view used to render this form

Properties inherited from JForm

$data, $errors, $forms, $name, $options, $repeat, $xml

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFForm

Methods summary

Parameters

Returns

Throws

Since

Overrides

Parameters

Returns

Since

Overrides

Since

Since

Returns

Since

Overrides

Parameters

Returns

Parameters

Returns

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

See

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

See

Overrides

Parameters

Returns

Since

See

Overrides

Methods inherited from JForm

Magic methods summary

Properties summary

Properties inherited from JForm