Class FOFFormHelper

FOFForm's helper class. Provides a storage for filesystem's paths where FOFForm's entities reside and methods for creating those entities. Also stores objects with entities' prototypes for further reusing.

JFormHelper

FOFFormHelper

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/helper.php

Methods summary

`public static mixed`	# `loadFieldType( string $type, boolean $new = true )` Method to load a form field object given a type. Method to load a form field object given a type. 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` - JFormField object on success, false otherwise. Since 11.1 Overrides `JFormHelper::loadFieldType`
`public static mixed`	# `loadHeaderType( string $type, boolean $new = true )` Method to load a form field object given a type. Method to load a form field object given a type. 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` - JFormField object on success, false otherwise. Since 11.1
`protected static mixed`	# `loadType( string $entity, string $type, boolean $new = true )` Method to load a form entity object given a type. Each type is loaded only once and then used as a prototype for other objects of same type. Please, use this method only with those entities which support types (forms don't support them). Method to load a form entity object given a type. Each type is loaded only once and then used as a prototype for other objects of same type. Please, use this method only with those entities which support types (forms don't support them). Parameters `$entity` `string` - $entity The entity. `$type` `string` - $type The entity type. `$new` `boolean` - $new Flag to toggle whether we should get a new instance of the object. Returns `mixed` - Entity object on success, false otherwise. Since 11.1 Overrides `JFormHelper::loadType`
`public static mixed`	# `loadFieldClass( string $type )` Attempt to import the JFormField class file if it isn't already imported. You can use this method outside of JForm for loading a field for inheritance or composition. Attempt to import the JFormField class file if it isn't already imported. You can use this method outside of JForm for loading a field for inheritance or composition. Parameters `$type` `string` - $type Type of a field whose class should be loaded. Returns `mixed` - Class name on success or false otherwise. Since 11.1 Overrides `JFormHelper::loadFieldClass`
`public static mixed`	# `loadHeaderClass( string $type )` Attempt to import the FOFFormHeader class file if it isn't already imported. You can use this method outside of JForm for loading a field for inheritance or composition. Attempt to import the FOFFormHeader class file if it isn't already imported. You can use this method outside of JForm for loading a field for inheritance or composition. Parameters `$type` `string` - $type Type of a field whose class should be loaded. Returns `mixed` - Class name on success or false otherwise. Since 11.1
`public static mixed`	# `loadClass( string $entity, string $type )` Load a class for one of the form's entities of a particular type. Currently, it makes sense to use this method for the "field" and "rule" entities (but you can support more entities in your subclass). Load a class for one of the form's entities of a particular type. Currently, it makes sense to use this method for the "field" and "rule" entities (but you can support more entities in your subclass). Parameters `$entity` `string` - $entity One of the form entities (field or rule). `$type` `string` - $type Type of an entity. Returns `mixed` - Class name on success or false otherwise. Since 2.0 Overrides `JFormHelper::loadClass`
`public static array`	# `addHeaderPath( mixed $new = null )` Method to add a path to the list of header include paths. Method to add a path to the list of header include paths. Parameters `$new` `mixed` - $new A path or array of paths to add. Returns `array` - The list of paths that have been added.

Methods inherited from JFormHelper

addFieldPath(), addFormPath(), addPath(), addRulePath(), loadRuleClass(), loadRuleType(), parseShowOnConditions()

Magic methods summary

Properties summary

Properties inherited from JFormHelper

$entities, $paths

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFFormHelper

Methods summary

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

Overrides

Parameters

Returns

Methods inherited from JFormHelper

Magic methods summary

Properties summary

Properties inherited from JFormHelper