• Home
• FOF30
• Form
• Form

PHP Class FOF30\Form\Form

Show file Open project: akeeba/fof Class Usage Examples

Protected Properties

Property	Type	Description
$container	FOF30\Container\Container	The Container this form belongs to
$entities	array	Prototypes for all fields and rules are here. Array's structure: entities: {ENTITY_NAME}: {KEY}: {OBJECT}
$model	FOF30\Model\DataModel	The model attached to this view
$view	FOF30\View\DataView\DataViewInterface	The view used to render this form

Public Methods

Method	Description
__construct ( Container $container, string $name, array $options = [] )	Method to instantiate the form object.
addFieldPath ( string $new = null ) : void	WARNING: THIS IS IGNORED IN FOF3!
addFormPath ( string $new = null ) : void	WARNING: THIS IS IGNORED IN FOF3!
addHeaderPath ( string $new = null ) : void	WARNING: THIS IS IGNORED IN FOF3!
addRulePath ( string $new = null ) : void	WARNING: THIS IS IGNORED IN FOF3!
bind ( mixed $data ) : boolean	Method to bind data to the form.
getAttribute ( string $attribute, mixed $default = null ) : mixed	Returns the value of an attribute of the form itself
getContainer ( ) : Container	Get a reference to the form's Container
getData ( ) : JRegistry	Returns a reference to the protected $data object, allowing direct access to and manipulation of the form's data.
getHeader ( string $name, string $group = null, mixed $value = null ) : FOF30\Form\HeaderInterface | boolean	Method to get a header field represented as a HeaderInterface object.
getHeaderset ( ) : array	Method to get an array of FormHeader objects in the headerset.
getModel ( ) : DataModel	Returns the DataModel attached to this form
getView ( ) : FOF30\View\DataView\DataViewInterface	Returns the DataViewInterface attached to this form
loadCSSFiles ( ) : void	Loads the CSS files defined in the form, based on its cssfiles attribute
loadClass ( string $entity, string $type ) : mixed	Load a class for one of the form's entities of a particular type.
loadFile ( string $file, boolean $reset = true, boolean $xpath = false ) : boolean	Method to load the form description from an XML file.
loadJSFiles ( ) : void	Loads the Javascript files defined in the form, based on its jsfiles attribute
removeHeader ( string $name, string $group = null ) : boolean	Method to remove a header from the form definition.
setContainer ( Container $container )	Set the form's Container
setModel ( DataModel &$model ) : void	Attaches a DataModel to this form
setView ( FOF30\View\DataView\DataViewInterface &$view ) : void	Attaches a DataViewInterface to this form

Protected Methods

Method	Description
bindLevel ( string $group, mixed $data ) : void	Method to bind data to the form for the group level.
findField ( string $name, string $group = null ) : mixed	Method to get a form field represented as an XML element object.
findHeader ( string $name, string $group = null ) : mixed	Method to get a header field represented as an XML element object.
findHeadersByGroup ( mixed $group = null, boolean $nested = false ) : SimpleXMLElement | boolean	Method to get an array of elements from the form XML document which are in a control group by name.
loadField ( string $element, string $group = null, mixed $value = null ) : mixed	Method to load, setup and return a JFormField object based on field data.
loadFieldType ( string $type, boolean $new = true ) : FOF30\Form\FieldInterface | boolean	Proxy for {@link Helper::loadFieldType()}.
loadHeader ( string $element, string $group = null ) : FOF30\Form\HeaderInterface | boolean	Method to load, setup and return a HeaderInterface object based on field data.
loadHeaderType ( string $type, boolean $new = true ) : FOF30\Form\HeaderInterface | boolean	Proxy for {@link Helper::loadHeaderType()}.
loadRuleType ( string $type, boolean $new = true ) : JFormRule | boolean	Proxy for {@link Helper::loadRuleType()}.
loadType ( string $entity, string $type, boolean $new = true ) : mixed	Method to load a form entity object given a type.
modelToBindSource ( DataModel $model, integer $maxLevel = 1, array $modelsProcessed = [] ) : array	Converts a DataModel into data suitable for use with the form. The difference to the Model's getData() method is that we process hasOne and belongsTo relations. This is a recursive function which will be called at most $maxLevel deep. You can set this in the form XML file, in the relation_depth attribute.

Method Details

Property Details