Class JModelForm

Prototype form model.

JObject

JModelLegacy

JModelForm

Direct known subclasses

JModelAdmin

Abstract
Package: Joomla\Legacy\Model
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 1.6
See: JForm
See: JFormField
See: JFormRule
Located at legacy/model/form.php

Methods summary

`public`	# `__construct( array $config = array() )` Constructor. Constructor. Parameters `$config` `array` - $config An optional associative array of configuration settings. Throws `Exception` Since 3.6 See `JModelLegacy` Overrides `JModelLegacy::__construct`
`public boolean`	# `checkin( integer $pk = null )` Method to checkin a row. Method to checkin a row. Parameters `$pk` `integer` - $pk The numeric id of the primary key. Returns `boolean` - False on failure or error, true otherwise. Since 1.6
`public boolean`	# `checkout( integer $pk = null )` Method to check-out a row for editing. Method to check-out a row for editing. Parameters `$pk` `integer` - $pk The numeric id of the primary key. Returns `boolean` - False on failure or error, true otherwise. Since 1.6
`abstract public JForm\|boolean`	# `getForm( array $data = array(), boolean $loadData = true )` Abstract method for getting the form from the model. Abstract method for getting the form from the model. Parameters `$data` `array` - $data Data for the form. `$loadData` `boolean` - $loadData True if the form is to load its own data (default case), false if not. Returns `JForm\|boolean` - A JForm object on success, false on failure Since 1.6
`protected JForm\|boolean`	# `loadForm( string $name, string $source = null, array $options = array(), boolean $clear = false, string $xpath = false )` Method to get a form object. Method to get a form object. Parameters `$name` `string` - $name The name of the form. `$source` `string` - $source The form source. Can be XML string if file flag is set to false. `$options` `array` - $options Optional array of options for the form creation. `$clear` `boolean` - $clear Optional argument to force load a new form. `$xpath` `string` - $xpath An optional xpath to search for the fields. Returns `JForm\|boolean` - JForm object on success, false on error. Since 1.6 See `JForm`
`protected array`	# `loadFormData( )` Method to get the data that should be injected in the form. Method to get the data that should be injected in the form. Returns `array` - The default data is an empty array. Since 1.6
`protected`	# `preprocessData( string $context, mixed & $data, string $group = 'content' )` Method to allow derived classes to preprocess the data. Method to allow derived classes to preprocess the data. Parameters `$context` `string` - $context The context identifier. `$data` `mixed` - &$data The data to be processed. It gets altered directly. `$group` `string` - $group The name of the plugin group to import (defaults to "content"). Since 3.1
`protected`	# `preprocessForm( JForm $form, mixed $data, string $group = 'content' )` Method to allow derived classes to preprocess the form. Method to allow derived classes to preprocess the form. Parameters `$form` `JForm` - $form A JForm object. `$data` `mixed` - $data The data expected for the form. `$group` `string` - $group The name of the plugin group to import (defaults to "content"). Throws `Exception` - if there is an error in the form event. Since 1.6 See `JFormField`
`public array\|boolean`	# `validate( JForm $form, array $data, string $group = null )` Method to validate the form data. Method to validate the form data. Parameters `$form` `JForm` - $form The form to validate against. `$data` `array` - $data The data to validate. `$group` `string` - $group The name of the field group to validate. Returns `array\|boolean` - Array of filtered data if valid, false otherwise. Since 1.6 See `JFormRule` `JFilterInput`

Methods inherited from JModelLegacy

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

Methods inherited from JObject

__toString(), def(), get(), getError(), getErrors(), getProperties(), set(), setError(), setProperties()

Magic methods summary

Properties summary

`protected JForm[]`	`$_forms`	# Array of form objects. Array of form objects. Since 1.6
`protected array`	`$events_map`	# Maps events to plugin groups. Maps events to plugin groups. Since 3.6

Properties inherited from JModelLegacy

$__state_set, $_db, $event_clean_cache, $name, $option, $state

Properties inherited from JObject

$_errors

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JModelForm

Direct known subclasses

Methods summary

Parameters

Throws

Since

See

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

See

Returns

Since

Parameters

Since

Parameters

Throws

Since

See

Parameters

Returns

Since

See

Methods inherited from JModelLegacy

Methods inherited from JObject

Magic methods summary

Properties summary

Since

Since

Properties inherited from JModelLegacy

Properties inherited from JObject