Docs For Class JModelForm

Description

Prototype form model.

see: JForm
see: JFormRule
see: JFormField
abstract:
since: 12.2

Located in /libraries/legacy/model/form.php (line 22)

JObject
   |
   --JModelLegacy
      |
      --JModelForm

Direct descendents

Class	Description
BannersModelDownload	Download model.
MenusModelMenu	Menu Item Model for Menus.
MessagesModelConfig	Message configuration model.
TemplatesModelTemplate	Template model class.
ContactModelContact
UsersModelLogin	Rest model class for Users.
UsersModelProfile	Profile model class for Users.
UsersModelRegistration	Registration model class for Users.
UsersModelRemind	Remind model class for Users.
UsersModelReset	Rest model class for Users.
JModelAdmin	Prototype form 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: 12.2
access: protected

Inherited Variables

Inherited from JModelLegacy

JModelLegacy::$event_clean_cache
JModelLegacy::$name
JModelLegacy::$option
JModelLegacy::$state
JModelLegacy::$_db
JModelLegacy::$__state_set

Inherited from JObject

JObject::$_errors

Methods

checkin (line 41)

Method to checkin a row.

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

boolean checkin ([integer $pk = null])

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

Redefined in descendants as:

UsersModelProfile::checkin() : Method to check in a user.

checkout (line 84)

Method to check-out a row for editing.

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

boolean checkout ([integer $pk = null])

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

Redefined in descendants as:

UsersModelProfile::checkout() : Method to check out a user for editing.

getForm (line 134)

Abstract method for getting the form from the model.

return: A JForm object on success, false on failure
abstract:
since: 12.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:

BannersModelDownload::getForm() : Method to get the record form.
MenusModelMenu::getForm() : Method to get the menu item form.
MessagesModelConfig::getForm() : Method to get the record form.
TemplatesModelTemplate::getForm() : Method to get the record form.
ContactModelContact::getForm() : Method to get the contact form.
UsersModelLogin::getForm() : Method to get the login form.
UsersModelProfile::getForm() : Method to get the profile form.
UsersModelRegistration::getForm() : Method to get the registration form.
UsersModelRemind::getForm() : Method to get the username remind request form.
UsersModelReset::getForm() : Method to get the password reset request form.
BannersModelBanner::getForm() : Method to get the record form.
BannersModelClient::getForm() : Method to get the record form.
CategoriesModelCategory::getForm() : Method to get the row form.
ContactModelContact::getForm() : Method to get the row form.
ContentModelArticle::getForm() : Method to get the record form.
FinderModelFilter::getForm() : Method to get the record form.
LanguagesModelLanguage::getForm() : Method to get the group form.
LanguagesModelOverride::getForm() : Method to get the record form.
MenusModelItem::getForm() : Method to get the row form.
MessagesModelMessage::getForm() : Method to get the record form.
ModulesModelModule::getForm() : Method to get the record form.
NewsfeedsModelNewsfeed::getForm() : Method to get the record form.
PluginsModelPlugin::getForm() : Method to get the record form.
RedirectModelLink::getForm() : Method to get the record form.
TagsModelTag::getForm() : Method to get the row form.
TemplatesModelStyle::getForm() : Method to get the record form.
UsersModelGroup::getForm() : Method to get the record form.
UsersModelLevel::getForm() : Method to get the record form.
UsersModelMail::getForm() : Method to get the row form.
UsersModelNote::getForm() : Method to get the record form.
UsersModelUser::getForm() : Method to get the record form.
AdminModelProfile::getForm() : Method to get the record form.
WeblinksModelWeblink::getForm() : Abstract method for getting the form from the model.

loadForm (line 150)

Method to get a form object.

return: JForm object on success, False on error.
see: JForm
since: 12.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 211)

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

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

array loadFormData ()

Redefined in descendants as:

BannersModelDownload::loadFormData() : Method to get the data that should be injected in the form.
MenusModelMenu::loadFormData() : Method to get the data that should be injected in the form.
TemplatesModelTemplate::loadFormData() : Method to get the data that should be injected in the form.
ContactModelContact::loadFormData()
UsersModelLogin::loadFormData() : Method to get the data that should be injected in the form.
UsersModelProfile::loadFormData() : Method to get the data that should be injected in the form.
UsersModelRegistration::loadFormData() : Method to get the data that should be injected in the form.
BannersModelBanner::loadFormData() : Method to get the data that should be injected in the form.
BannersModelClient::loadFormData() : Method to get the data that should be injected in the form.
CategoriesModelCategory::loadFormData() : Method to get the data that should be injected in the form.
ContactModelContact::loadFormData() : Method to get the data that should be injected in the form.
ContentModelArticle::loadFormData() : Method to get the data that should be injected in the form.
FinderModelFilter::loadFormData() : Method to get the data that should be injected in the form.
LanguagesModelLanguage::loadFormData() : Method to get the data that should be injected in the form.
LanguagesModelOverride::loadFormData() : Method to get the data that should be injected in the form.
MenusModelItem::loadFormData() : Method to get the data that should be injected in the form.
MessagesModelMessage::loadFormData() : Method to get the data that should be injected in the form.
ModulesModelModule::loadFormData() : Method to get the data that should be injected in the form.
NewsfeedsModelNewsfeed::loadFormData() : Method to get the data that should be injected in the form.
PluginsModelPlugin::loadFormData() : Method to get the data that should be injected in the form.
RedirectModelLink::loadFormData() : Method to get the data that should be injected in the form.
TagsModelTag::loadFormData() : Method to get the data that should be injected in the form.
TemplatesModelStyle::loadFormData() : Method to get the data that should be injected in the form.
UsersModelGroup::loadFormData() : Method to get the data that should be injected in the form.
UsersModelLevel::loadFormData() : Method to get the data that should be injected in the form.
UsersModelMail::loadFormData() : Method to get the data that should be injected in the form.
UsersModelNote::loadFormData() : Method to get the data that should be injected in the form.
UsersModelUser::loadFormData() : Method to get the data that should be injected in the form.
AdminModelProfile::loadFormData() : Method to get the data that should be injected in the form.
WeblinksModelWeblink::loadFormData() : Method to get the data that should be injected in the form.

preprocessData (line 226)

Method to allow derived classes to preprocess the data.

since: 3.1
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 255)

Method to allow derived classes to preprocess the form.

see: JFormField
throws: Exception if there is an error in the form event.
since: 12.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:

UsersModelLogin::preprocessForm() : Override JModelAdmin::preprocessForm to ensure the correct plugin group is loaded.
UsersModelProfile::preprocessForm() : Override preprocessForm to load the user plugin group instead of content.
UsersModelRegistration::preprocessForm() : Override preprocessForm to load the user plugin group instead of content.
UsersModelRemind::preprocessForm() : Override preprocessForm to load the user plugin group instead of content.
UsersModelReset::preprocessForm() : Override preprocessForm to load the user plugin group instead of content.
CategoriesModelCategory::preprocessForm() : Method to preprocess the form.
ContactModelContact::preprocessForm()
ContentModelArticle::preprocessForm() : Auto-populate the model state.
MenusModelItem::preprocessForm()
ModulesModelModule::preprocessForm() : Method to preprocess the form
NewsfeedsModelNewsfeed::preprocessForm()
PluginsModelPlugin::preprocessForm()
TagsModelTag::preprocessForm() : Method to preprocess the form.
TemplatesModelStyle::preprocessForm() : TODO
UsersModelGroup::preprocessForm() : Override preprocessForm to load the user plugin group instead of content.
UsersModelLevel::preprocessForm() : Override preprocessForm to load the user plugin group instead of content.
UsersModelMail::preprocessForm() : Override preprocessForm to load the user plugin group instead of content.
UsersModelUser::preprocessForm() : Override JModelAdmin::preprocessForm to ensure the correct plugin group is loaded.

validate (line 292)

Method to validate the form data.

return: Array of filtered data if valid, false otherwise.
see: JFormRule
see: JFilterInput
since: 12.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.

Redefined in descendants as:

ModulesModelModule::validate() : Loads ContentHelper for filters before validating data.

Inherited Methods

Inherited From JModelLegacy

JModelLegacy::__construct()
JModelLegacy::addIncludePath()
JModelLegacy::addTablePath()
JModelLegacy::cleanCache()
JModelLegacy::getDbo()
JModelLegacy::getInstance()
JModelLegacy::getName()
JModelLegacy::getState()
JModelLegacy::getTable()
JModelLegacy::loadHistory()
JModelLegacy::populateState()
JModelLegacy::setDbo()
JModelLegacy::setState()
JModelLegacy::_createFileName()
JModelLegacy::_createTable()
JModelLegacy::_getList()
JModelLegacy::_getListCount()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()