FormHelper

Form's helper class.

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

since

1.7.0

package

Application

Methods

addFieldPath

Method to add a path to the list of field include paths.

addFieldPath(mixed new = null) : array
static
since

1.7.0

Arguments

new

mixedA path or array of paths to add.

Response

arrayThe list of paths that have been added.

addFieldPrefix

Method to add a namespace prefix to the list of field lookups.

addFieldPrefix(mixed new = null) : array
static
since

3.8.0

Arguments

new

mixedA namespaces or array of namespaces to add.

Response

arrayThe list of namespaces that have been added.

addFilterPath

Method to add a path to the list of filter include paths.

addFilterPath(mixed new = null) : array
static
since

4.0.0

Arguments

new

mixedA path or array of paths to add.

Response

arrayThe list of paths that have been added.

addFilterPrefix

Method to add a namespace to the list of filter lookups.

addFilterPrefix(mixed new = null) : array
static
since

4.0.0

Arguments

new

mixedA namespace or array of namespaces to add.

Response

arrayThe list of namespaces that have been added.

addFormPath

Method to add a path to the list of form include paths.

addFormPath(mixed new = null) : array
static
since

1.7.0

Arguments

new

mixedA path or array of paths to add.

Response

arrayThe list of paths that have been added.

addFormPrefix

Method to add a namespace to the list of form lookups.

addFormPrefix(mixed new = null) : array
static
since

3.8.0

Arguments

new

mixedA namespace or array of namespaces to add.

Response

arrayThe list of namespaces that have been added.

addPath

Method to add a path to the list of include paths for one of the form's entities.

addPath(string entity, mixed new = null) : array
static

Currently supported entities: field, rule and form. You are free to support your own in a subclass.

since

1.7.0

Arguments

entity

stringForm's entity name for which paths will be added.

new

mixedA path or array of paths to add.

Response

arrayThe list of paths that have been added.

addPrefix

Method to add a namespace to the list of namespaces for one of the form's entities.

addPrefix(string entity, mixed new = null) : array
static

Currently supported entities: field, rule and form. You are free to support your own in a subclass.

since

3.8.0

Arguments

entity

stringForm's entity name for which paths will be added.

new

mixedA namespace or array of namespaces to add.

Response

arrayThe list of namespaces that have been added.

addRulePath

Method to add a path to the list of rule include paths.

addRulePath(mixed new = null) : array
static
since

1.7.0

Arguments

new

mixedA path or array of paths to add.

Response

arrayThe list of paths that have been added.

addRulePrefix

Method to add a namespace to the list of rule lookups.

addRulePrefix(mixed new = null) : array
static
since

3.8.0

Arguments

new

mixedA namespace or array of namespaces to add.

Response

arrayThe list of namespaces that have been added.

loadClass

Load a class for one of the form's entities of a particular type.

loadClass(string entity, string type) : string|bool
static

Currently, it makes sense to use this method for the "field" and "rule" entities (but you can support more entities in your subclass).

since

1.7.0

Arguments

entity

stringOne of the form entities (field or rule).

type

stringType of an entity.

Response

string|boolClass name on success or false otherwise.

loadFieldClass

Attempt to import the FormField class file if it isn't already imported.

loadFieldClass(string type) : string|bool
static

You can use this method outside of Form for loading a field for inheritance or composition.

since

1.7.0

Arguments

type

stringType of a field whose class should be loaded.

Response

string|boolClass name on success or false otherwise.

loadFieldType

Method to load a form field object given a type.

loadFieldType(string type, bool new = true) : \Joomla\CMS\Form\FormField|bool
static
since

1.7.0

Arguments

type

stringThe field type.

new

boolFlag to toggle whether we should get a new instance of the object.

Response

\Joomla\CMS\Form\FormField|boolFormField object on success, false otherwise.

loadFilterClass

Attempt to import the FormFilter class file if it isn't already imported.

loadFilterClass(string type) : string|bool
static

You can use this method outside of Form for loading a filter for inheritance or composition.

since

4.0.0

Arguments

type

stringType of a filter whose class should be loaded.

Response

string|boolClass name on success or false otherwise.

loadFilterType

Method to load a form filter object given a type.

loadFilterType(string type, bool new = true) : \Joomla\CMS\Form\FormFilterInterface|bool
static
since

4.0.0

Arguments

type

stringThe rule type.

new

boolFlag to toggle whether we should get a new instance of the object.

Response

\Joomla\CMS\Form\FormFilterInterface|boolFormRule object on success, false otherwise.

loadRuleClass

Attempt to import the FormRule class file if it isn't already imported.

loadRuleClass(string type) : string|bool
static

You can use this method outside of Form for loading a rule for inheritance or composition.

since

1.7.0

Arguments

type

stringType of a rule whose class should be loaded.

Response

string|boolClass name on success or false otherwise.

loadRuleType

Method to load a form rule object given a type.

loadRuleType(string type, bool new = true) : \Joomla\CMS\Form\FormRule|bool
static
since

1.7.0

Arguments

type

stringThe rule type.

new

boolFlag to toggle whether we should get a new instance of the object.

Response

\Joomla\CMS\Form\FormRule|boolFormRule object on success, false otherwise.

loadType

Method to load a form entity object given a type.

loadType(string entity, string type, bool new = true) : mixed
static

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).

since

1.7.0

Arguments

entity

stringThe entity.

type

stringThe entity type.

new

boolFlag to toggle whether we should get a new instance of the object.

Response

mixedEntity object on success, false otherwise.

parseShowOnConditions

Parse the show on conditions

parseShowOnConditions(string showOn, string formControl = null, string group = null) : array
static
since

3.7.0

Arguments

showOn

stringShow on conditions.

formControl

stringForm name.

group

stringThe dot-separated form group path.

Response

arrayArray with show on conditions.

Properties

paths

Array with paths where entities(field, rule, form) can be found.

static

Array's structure:

paths: {ENTITY_NAME}:

  • /path/1
  • /path/2
since

1.7.0

Type(s)

array

prefixes

The class namespaces.

static
since

3.8.0

Type(s)

string

entities

Static array of Form's entity objects for re-use.

static

Prototypes for all fields and rules are here.

Array's structure: entities: {ENTITY_NAME}: {KEY}: {OBJECT}

since

1.7.0

Type(s)

array