Docs For Class ConfigModelForm

Description

Prototype form model.

see: JForm
see: JFormRule
see: JFormField
abstract:
since: 3.2

Located in /components/com_config/model/form.php (line 22)

JModelBase
   |
   --JModelDatabase
      |
      --ConfigModelCms
         |
         --ConfigModelForm

Direct descendents

Class	Description
ConfigModelApplication	Model for the global configuration
ConfigModelComponent	Model for component configuration
ConfigModelConfig	Model for the global configuration
ConfigModelTemplates	Template style model.

Variable Summary

array $forms

Method Summary

boolean checkin ([integer $pk = null])

boolean checkout ([integer $pk = null])

mixed getForm ([array $data = array()], [boolean $loadData = true])

mixed loadForm (string $name, [string $source = null], [array $options = array()], [boolean $clear = false], [string $xpath = false])

array loadFormData ()

void preprocessData (string $context, mixed &$data)

void preprocessForm (JForm $form, mixed $data, [string $group = 'content'])

mixed validate (JForm $form, array $data, [string $group = null])

Variables

array $forms = array() (line 30)

Array of form objects.

since: 3.2
access: protected

Inherited Variables

Inherited from ConfigModelCms

ConfigModelCms::$name
ConfigModelCms::$option
ConfigModelCms::$text_prefix
ConfigModelCms::$__state_set

Inherited from JModelDatabase

JModelDatabase::$db

Inherited from JModelBase

JModelBase::$state

Methods

checkin (line 42)

Method to checkin a row.

return: False on failure or error, true otherwise.
since: 3.2
throws: RuntimeException
access: public

boolean checkin ([integer $pk = null])

integer $pk: The numeric id of the primary key.

checkout (line 82)

Method to check-out a row for editing.

return: False on failure or error, true otherwise.
since: 3.2
access: public

boolean checkout ([integer $pk = null])

integer $pk: The numeric id of the primary key.

getForm (line 123)

Abstract method for getting the form from the model.

return: A JForm object on success, false on failure
abstract:
since: 3.2
access: public

mixed getForm ([array $data = array()], [boolean $loadData = true])

array $data: Data for the form.
boolean $loadData: True if the form is to load its own data (default case), false if not.

Redefined in descendants as:

ConfigModelApplication::getForm() : Method to get a form object.
ConfigModelComponent::getForm() : Method to get a form object.
ConfigModelConfig::getForm() : Method to get a form object.
ConfigModelTemplates::getForm() : Method to get the record form.

loadForm (line 139)

Method to get a form object.

return: JForm object on success, False on error.
see: JForm
since: 3.2
access: protected

mixed loadForm (string $name, [string $source = null], [array $options = array()], [boolean $clear = false], [string $xpath = false])

string $name: The name of the form.
string $source: The form source. Can be XML string if file flag is set to false.
array $options: Optional array of options for the form creation.
boolean $clear: Optional argument to force load a new form.
string $xpath: An optional xpath to search for the fields.

loadFormData (line 213)

Method to get the data that should be injected in the form.

return: The default data is an empty array.
since: 3.2
access: protected

array loadFormData ()

preprocessData (line 228)

Method to allow derived classes to preprocess the data.

since: 3.2
access: protected

void preprocessData (string $context, mixed &$data)

string $context: The context identifier.
mixed &$data: The data to be processed. It gets altered directly.

preprocessForm (line 257)

Method to allow derived classes to preprocess the form.

see: JFormField
throws: Exception if there is an error in the form event.
since: 3.2
access: protected

void preprocessForm (JForm $form, mixed $data, [string $group = 'content'])

JForm $form: A JForm object.
mixed $data: The data expected for the form.
string $group: The name of the plugin group to import (defaults to "content").

Redefined in descendants as:

ConfigModelTemplates::preprocessForm() : Method to preprocess the form

validate (line 294)

Method to validate the form data.

return: Array of filtered data if valid, false otherwise.
see: JFormRule
see: JFilterInput
since: 3.2
access: public

mixed validate (JForm $form, array $data, [string $group = null])

JForm $form: The form to validate against.
array $data: The data to validate.
string $group: The name of the field group to validate.

Inherited Methods

Inherited From ConfigModelCms

ConfigModelCms::__construct()
ConfigModelCms::canDelete()
ConfigModelCms::canEditState()
ConfigModelCms::cleanCache()
ConfigModelCms::getName()
ConfigModelCms::getState()
ConfigModelCms::populateState()
ConfigModelCms::registerTablePaths()

Inherited From JModelDatabase

JModelDatabase::__construct()
JModelDatabase::getDb()
JModelDatabase::loadDb()
JModelDatabase::setDb()

Inherited From JModelBase

JModelBase::__construct()
JModelBase::getState()
JModelBase::loadState()
JModelBase::setState()