JModelForm
Extends \JModelPrototype form model.
Acts as a Factory class for application specific objects and provides many supporting API functions.
package |
Joomla.Platform |
---|---|
subpackage |
Application |
see | \JForm \JFormField \JformRule |
since |
11.1 |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct(mixed $properties = null)
since |
11.1 |
---|
Arguments
- $properties
mixed
Either and associative array or another object to set the initial properties of the object.
__toString
Magic method to convert the object to a string gracefully.
__toString() : string
since |
11.1 |
---|---|
deprecated |
12.3 Classes should provide their own __toString() implementation. |
Response
string
The classname.
_createFileName
Create the filename for a resource
_createFileName(string $type, array $parts = array()) : string
since |
11.1 |
---|
Arguments
- $type
string
The resource type to create the filename for.- $parts
array
An associative array of filename information.
Response
string
The filename
_createTable
Method to load and return a model object.
_createTable(string $name, string $prefix = 'Table', array $config = array()) : mixed
since |
11.1 |
---|---|
see | \JTable::getInstance |
Arguments
- $name
string
The name of the view- $prefix
string
The class prefix. Optional.- $config
array
Configuration settings to pass to JTable::getInstance
Response
mixed
Model object or boolean false if failed
_getList
Gets an array of objects from the results of database query.
_getList(string $query, integer $limitstart, integer $limit) : array
since |
11.1 |
---|
Arguments
- $query
string
The query.- $limitstart
integer
Offset.- $limit
integer
The number of records.
Response
array
An array of results.
_getListCount
Returns a record count for the query
_getListCount(string $query) : integer
since |
11.1 |
---|
Arguments
- $query
string
The query.
Response
integer
Number of rows for query
addIncludePath
Add a directory where JModel should search for models. You may either pass a string or an array of directories.
addIncludePath(mixed $path = '', string $prefix = '') : array
since |
11.1 |
---|
Arguments
- $path
mixed
A path or array[sting] of paths to search.- $prefix
string
A prefix for models.
Response
array
An array with directory elements. If prefix is equal to '', all directories are returned.
addTablePath
Adds to the stack of model table paths in LIFO order.
addTablePath(mixed $path) : void
since |
11.1 |
---|
Arguments
- $path
mixed
The directory as a string or directories as an array to add.
checkin
Method to checkin a row.
checkin(integer $pk = null) : boolean
since |
11.1 |
---|
Arguments
- $pk
integer
The numeric id of the primary key.
Response
boolean
False on failure or error, true otherwise.
checkout
Method to check-out a row for editing.
checkout(integer $pk = null) : boolean
since |
11.1 |
---|
Arguments
- $pk
integer
The numeric id of the primary key.
Response
boolean
False on failure or error, true otherwise.
cleanCache
Clean the cache
cleanCache(string $group = null, integer $client_id) : void
since |
11.1 |
---|
Arguments
- $group
string
The cache group- $client_id
integer
The ID of the client
def
Sets a default value if not alreay assigned
def(string $property, mixed $default = null) : mixed
since |
11.1 |
---|
Arguments
- $property
string
The name of the property.- $default
mixed
The default value.
Response
mixed
get
Returns a property of the object or the default value if the property is not set.
get(string $property, mixed $default = null) : mixed
since |
11.1 |
---|---|
see | \JObject::getProperties() |
Arguments
- $property
string
The name of the property.- $default
mixed
The default value.
Response
mixed
The value of the property.
getError
Get the most recent error message.
getError(integer $i = null, boolean $toString = true) : string
since |
11.1 |
---|---|
see | \JError |
deprecated |
12.3 JError has been deprecated |
Arguments
- $i
integer
Option error index.- $toString
boolean
Indicates if JError objects should return their error message.
Response
string
Error message
getErrors
Return all errors, if any.
getErrors() : array
since |
11.1 |
---|---|
see | \JError |
deprecated |
12.3 JError has been deprecated |
Response
array
Array of error messages or JErrors.
getForm
Abstract method for getting the form from the model.
getForm(array $data = array(), boolean $loadData = true) : mixed
since |
11.1 |
---|
Arguments
- $data
array
Data for the form.- $loadData
boolean
True if the form is to load its own data (default case), false if not.
Response
mixed
A JForm object on success, false on failure
getInstance
Returns a Model object, always creating it
getInstance(string $type, string $prefix = '', array $config = array()) : mixed
since |
11.1 |
---|
Arguments
- $type
string
The model type to instantiate- $prefix
string
Prefix for the model class name. Optional.- $config
array
Configuration array for model. Optional.
Response
mixed
A model object or false on failure
getName
Method to get the model name
getName() : string
The model name. By default parsed using the classname or it can be set by passing a $config['name'] in the class constructor
since |
11.1 |
---|
Response
string
The name of the model
getProperties
Returns an associative array of object properties.
getProperties(boolean $public = true) : array
since |
11.1 |
---|---|
see | \JObject::get() |
Arguments
- $public
boolean
If true, returns only the public properties.
Response
array
getState
Method to get model state variables
getState(string $property = null, mixed $default = null) : object
since |
11.1 |
---|
Arguments
- $property
string
Optional parameter name- $default
mixed
Optional default value
Response
object
The property where specified, the state object where omitted
getTable
Method to get a table object, load it if necessary.
getTable(string $name = '', string $prefix = 'Table', array $options = array()) : \JTable
since |
11.1 |
---|
Arguments
- $name
string
The table name. Optional.- $prefix
string
The class prefix. Optional.- $options
array
Configuration array for model. Optional.
Response
\JTable
A JTable object
loadForm
Method to get a form object.
loadForm(string $name, string $source = null, array $options = array(), boolean $clear = false, string $xpath = false) : mixed
see | \JForm |
---|---|
since |
11.1 |
Arguments
- $name
string
The name of the form.- $source
string
The form source. Can be XML string if file flag is set to false.- $options
array
Optional array of options for the form creation.- $clear
boolean
Optional argument to force load a new form.- $xpath
string
An optional xpath to search for the fields.
Response
mixed
JForm object on success, False on error.
loadFormData
Method to get the data that should be injected in the form.
loadFormData() : array
since |
11.1 |
---|
Response
array
The default data is an empty array.
populateState
Method to auto-populate the model state.
populateState() : void
This method should only be called once per instantiation and is designed to be called on the first call to the getState() method unless the model configuration flag to ignore the request is set.
note |
Calling getState in this method will result in recursion. |
---|---|
since |
11.1 |
preprocessForm
Method to allow derived classes to preprocess the form.
preprocessForm(\JForm $form, mixed $data, string $group = 'content') : void
see | \JFormField |
---|---|
since |
11.1 |
throws |
|
Arguments
- $form
\JForm
A JForm object.- $data
mixed
The data expected for the form.- $group
string
The name of the plugin group to import (defaults to "content").
set
Modifies a property of the object, creating it if it does not already exist.
set(string $property, mixed $value = null) : mixed
since |
11.1 |
---|
Arguments
- $property
string
The name of the property.- $value
mixed
The value of the property to set.
Response
mixed
Previous value of the property.
setDbo
Method to set the database driver object
setDbo( &$db) : void
since |
11.1 |
---|
Arguments
- $db
setError
Add an error message.
setError(string $error) : void
since |
11.1 |
---|---|
see | \JError |
deprecated |
12.3 JError has been deprecated |
Arguments
- $error
string
Error message.
setProperties
Set the object properties based on a named array/hash.
setProperties(mixed $properties) : boolean
since |
11.1 |
---|---|
see | \JObject::set() |
Arguments
- $properties
mixed
Either an associative array or another object.
Response
boolean
setState
Method to set model state variables
setState(string $property, mixed $value = null) : mixed
since |
11.1 |
---|
Arguments
- $property
string
The name of the property.- $value
mixed
The value of the property to set or null.
Response
mixed
The previous value of the property or null if not set.
toString
Converts the object to a string (the class name).
toString() : string
validate
Method to validate the form data.
validate(\JForm $form, array $data, string $group = null) : mixed
see | \JFormRule \JFilterInput |
---|---|
since |
11.1 |
Arguments
- $form
\JForm
The form to validate against.- $data
array
The data to validate.- $group
string
The name of the field group to validate.
Response
mixed
Array of filtered data if valid, false otherwise.
Properties
_forms
Array of form objects.
since |
11.1 |
---|
Type(s)
array
__state_set
Indicates if the internal state has been set
since |
11.1 |
---|
Type(s)
boolean
_db
Database Connector
since |
11.1 |
---|
Type(s)
object
name
The model (base) name
note |
Replaces _name variable in 11.1 |
---|---|
since |
11.1 |
Type(s)
string
option
The URL option for the component.
since |
11.1 |
---|
Type(s)
string
state
A state object
note |
Replaces _state variable in 11.1 |
---|---|
since |
11.1 |
Type(s)
string
event_clean_cache
The event to trigger when cleaning cache.
since |
11.1 |
---|
Type(s)
string
_errors
An array of error messages or Exception objects.