public static
JFormField|boolean
|
#
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
JFormField|boolean - JFormField object on success, false otherwise.
Since
11.1
|
public static
JFormRule|boolean
|
#
loadRuleType( string $type, boolean $new = true )
Method to load a form rule object given a type.
Method to load a form rule object given a type.
Parameters
- $type
string - $type The rule type.- $new
boolean - $new Flag to toggle whether we should get a new instance of the object. Returns
JFormRule|boolean - JFormRule 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
|
public static
string|boolean
|
#
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
string|boolean - Class name on success or false otherwise.
Since
11.1
|
public static
string|boolean
|
#
loadRuleClass( string $type )
Attempt to import the JFormRule class file if it isn't already imported. You
can use this method outside of JForm for loading a rule for inheritance or
composition.
Attempt to import the JFormRule class file if it isn't already imported. You
can use this method outside of JForm for loading a rule for inheritance or
composition.
Parameters
- $type
string - $type Type of a rule whose class should be loaded. Returns
string|boolean - Class name on success or false otherwise.
Since
11.1
|
protected static
string|boolean
|
#
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
string|boolean - Class name on success or false otherwise.
Since
11.1
|
public static
array
|
#
addFieldPath( mixed $new = null )
Method to add a path to the list of field include paths.
Method to add a path to the list of field include paths.
Parameters
- $new
mixed - $new A path or array of paths to add. Returns
array - The list of paths that have been added.
Since
11.1
|
public static
array
|
#
addFormPath( mixed $new = null )
Method to add a path to the list of form include paths.
Method to add a path to the list of form include paths.
Parameters
- $new
mixed - $new A path or array of paths to add. Returns
array - The list of paths that have been added.
Since
11.1
|
public static
array
|
#
addRulePath( mixed $new = null )
Method to add a path to the list of rule include paths.
Method to add a path to the list of rule include paths.
Parameters
- $new
mixed - $new A path or array of paths to add. Returns
array - The list of paths that have been added.
Since
11.1
|
protected static
array
|
#
addPath( string $entity, mixed $new = null )
Method to add a path to the list of include paths for one of the form's
entities. Currently supported entities: field, rule and form. You are free to
support your own in a subclass.
Method to add a path to the list of include paths for one of the form's
entities. Currently supported entities: field, rule and form. You are free to
support your own in a subclass.
Parameters
- $entity
string - $entity Form's entity name for which paths will be added.- $new
mixed - $new A path or array of paths to add. Returns
array - The list of paths that have been added.
Since
11.1
|
public static
array
|
#
parseShowOnConditions( string $showOn, string $formControl = null, string $group = null )
Parse the show on conditions
Parse the show on conditions
Parameters
- $showOn
string - $showOn Show on conditions.- $formControl
string - $formControl Form name.- $group
string - $group The dot-separated form group path. Returns
array - Array with show on conditions.
Since
3.7.0
|
