Référence de la classe FormModel

Graphe d'héritage de FormModel:

Fonctions membres publiques
	checkin ($pk=null)
	checkout ($pk=null)
	validate ($form, $data, $group=null)
Fonctions membres publiques hérités de FormModel
	__construct ($config=array(), MVCFactoryInterface $factory=null, FormFactoryInterface $formFactory=null)
	checkin ($pk=null)
	checkout ($pk=null)
	validate ($form, $data, $group=null)
Fonctions membres publiques hérités de BaseDatabaseModel
	__construct ($config=array(), MVCFactoryInterface $factory=null)
	getTable ($name='', $prefix='', $options=array())
	isCheckedOut ($item)
	getDbo ()
	setDbo (DatabaseInterface $db=null)
	__get ($name)
Fonctions membres publiques hérités de BaseModel
	__construct ($config=array())
	getName ()
Fonctions membres publiques hérités de CMSObject
	__construct ($properties=null)
	__toString ()
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)
Fonctions membres publiques hérités de StatefulModelInterface
	getState ($property=null, $default=null)
	setState ($property, $value=null)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)
Fonctions membres publiques hérités de CurrentUserInterface
	setCurrentUser (User $currentUser)
Fonctions membres publiques hérités de CacheControllerFactoryAwareInterface
	setCacheControllerFactory (CacheControllerFactoryInterface $factory)
Fonctions membres publiques hérités de DatabaseAwareInterface
	setDatabase (DatabaseInterface $db)
Fonctions membres publiques hérités de FormFactoryAwareInterface
	setFormFactory (FormFactoryInterface $factory)
Fonctions membres publiques hérités de FormModelInterface
	getForm ($data=array(), $loadData=true)

Fonctions membres protégées
	loadForm ($name, $source=null, $options=array(), $clear=false, $xpath=false)
	loadFormData ()
	preprocessData ($context, &$data, $group='content')
	preprocessForm (Form $form, $data, $group='content')
Fonctions membres protégées hérités de BaseDatabaseModel
	_getList ($query, $limitstart=0, $limit=0)
	_getListCount ($query)
	_createTable ($name, $prefix='Table', $config=array())
	bootComponent ($component)
	dispatchEvent (EventInterface $event)

Attributs protégés
	$forms = array()
Attributs protégés hérités de FormModel
	$events_map = null
Attributs protégés hérités de BaseDatabaseModel
	$option = null
	$event_clean_cache = null
Attributs protégés hérités de BaseModel
	$name
Attributs protégés hérités de CMSObject
	$_errors = array()

Membres hérités additionnels
Fonctions membres publiques statiques hérités de BaseModel
static	addIncludePath ($path='', $prefix='')
Attributs protégés statiques hérités de BaseModel
static	$paths

Description détaillée

Prototype form model.

Voir également

JForm

Depuis

3.2

Documentation des fonctions membres

checkin()

checkin

(

$pk = null

)

Method to checkin a row.

Paramètres

integer

$pk

The numeric id of the primary key.

Renvoie

boolean False on failure or error, true otherwise.

Depuis

3.2

Exceptions

Références $user, et Factory\getUser().

checkout()

checkout

(

$pk = null

)

Method to check-out a row for editing.

Paramètres

integer

$pk

The numeric id of the primary key.

Renvoie

boolean False on failure or error, true otherwise.

Depuis

3.2

Références $user, Text\_(), et Factory\getUser().

loadForm()

loadForm (   $name,   $source = null,   $options = array(),   $clear = false,   $xpath = false  )

protected

Method to get a form object.

Paramètres

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.

Renvoie

mixed JForm object on success, False on error.

Voir également

JForm

Depuis

3.2

Références $data, $form, $hash, $name, $options, Form\addFormPath(), Factory\getApplication(), Form\getInstance(), ArrayHelper\getValue(), JPATH_ADMINISTRATOR, JPATH_SITE, Joomla\CMS\MVC\Model\loadFormData(), et Joomla\CMS\MVC\Model\preprocessForm().

loadFormData()

loadFormData ( )

protected

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

Renvoie

array The default data is an empty array.

Depuis

3.2

preprocessData()

preprocessData (   $context, &  $data,   $group = 'content'  )

protected

Method to allow derived classes to preprocess the data.

Paramètres

string	$context	The context identifier.
mixed	&$data	The data to be processed. It gets altered directly.
string	$group	The name of the plugin group to import (defaults to "content").

Renvoie

void

Depuis

3.2

Références $context, $data, Factory\getApplication(), et PluginHelper\importPlugin().

preprocessForm()

preprocessForm ( Form  $form,   $data,   $group = 'content'  )

protected

Method to allow derived classes to preprocess the form.

Paramètres

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

Renvoie

void

Voir également

Depuis

3.2

Exceptions

Références $data, $form, Factory\getApplication(), et PluginHelper\importPlugin().

validate()

validate	(		$form,
			$data,
			$group = null
	)

Method to validate the form data.

Paramètres

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

Renvoie

mixed Array of filtered data if valid, false otherwise.

Voir également

JFilterInput

Depuis

3.2

Références $data, $form, $message, $return, et Factory\getApplication().

Documentation des champs

$forms

$forms = array()

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• components/com_config/src/Model/FormModel.php