Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe ConfigModelForm
+ Graphe d'héritage de ConfigModelForm:

Fonctions membres publiques

 checkin ($pk=null)
 
 checkout ($pk=null)
 
 getForm ($data=array(), $loadData=true)
 
 validate ($form, $data, $group=null)
 
- Fonctions membres publiques hérités de ConfigModelCms
 __construct ($config=array())
 
 getName ()
 
 getState ()
 
 registerTablePaths ($config=array())
 
- Fonctions membres publiques hérités de JModelDatabase
 __construct (Registry $state=null, JDatabaseDriver $db=null)
 
 getDb ()
 
 setDb (JDatabaseDriver $db)
 
- Fonctions membres publiques hérités de JModelBase
 __construct (Registry $state=null)
 
 getState ()
 
 setState (Registry $state)
 

Fonctions membres protégées

 loadForm ($name, $source=null, $options=array(), $clear=false, $xpath=false)
 
 loadFormData ()
 
 preprocessData ($context, &$data)
 
 preprocessForm (JForm $form, $data, $group='content')
 
- Fonctions membres protégées hérités de ConfigModelCms
 cleanCache ($group=null, $clientId=0)
 
 populateState ()
 
 canDelete ($record)
 
 canEditState ($record)
 
- Fonctions membres protégées hérités de JModelDatabase
 loadDb ()
 
- Fonctions membres protégées hérités de JModelBase
 loadState ()
 

Attributs protégés

 $forms = array()
 
- Attributs protégés hérités de ConfigModelCms
 $name
 
 $option = null
 
 $text_prefix = null
 
 $__state_set = null
 
- Attributs protégés hérités de JModelDatabase
 $db
 
- Attributs protégés hérités de JModelBase
 $state
 

Description détaillée

Prototype form model.

Voir également
JForm
JFormField
JFormRule
Depuis
3.2

Documentation des fonctions membres

◆ checkin()

checkin (   $pk = null)

Method to checkin a row.

Paramètres
integer$pkThe numeric id of the primary key.
Renvoie
boolean False on failure or error, true otherwise.
Depuis
3.2
Exceptions
RuntimeException

Références $user.

◆ checkout()

checkout (   $pk = null)

Method to check-out a row for editing.

Paramètres
integer$pkThe numeric id of the primary key.
Renvoie
boolean False on failure or error, true otherwise.
Depuis
3.2

Références $user.

◆ getForm()

getForm (   $data = array(),
  $loadData = true 
)
abstract

Abstract method for getting the form from the model.

Paramètres
array$dataData for the form.
boolean$loadDataTrue if the form is to load its own data (default case), false if not.
Renvoie
mixed A JForm object on success, false on failure
Depuis
3.2

◆ loadForm()

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

Method to get a form object.

Paramètres
string$nameThe name of the form.
string$sourceThe form source. Can be XML string if file flag is set to false.
array$optionsOptional array of options for the form creation.
boolean$clearOptional argument to force load a new form.
string$xpathAn 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, ArrayHelper\getValue(), et JPATH_COMPONENT_ADMINISTRATOR.

◆ 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 
)
protected

Method to allow derived classes to preprocess the data.

Paramètres
string$contextThe context identifier.
mixed&$dataThe data to be processed. It gets altered directly.
Renvoie
void
Depuis
3.2

Références $context, $data, $dispatcher, $results, et JEventDispatcher\getInstance().

◆ preprocessForm()

preprocessForm ( JForm  $form,
  $data,
  $group = 'content' 
)
protected

Method to allow derived classes to preprocess the form.

Paramètres
JForm$formA JForm object.
mixed$dataThe data expected for the form.
string$groupThe name of the plugin group to import (defaults to "content").
Renvoie
void
Voir également
JFormField
Depuis
3.2
Exceptions
Exceptionif there is an error in the form event.

Références $data, $dispatcher, $form, $results, et JEventDispatcher\getInstance().

◆ validate()

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

Method to validate the form data.

Paramètres
JForm$formThe form to validate against.
array$dataThe data to validate.
string$groupThe name of the field group to validate.
Renvoie
mixed Array of filtered data if valid, false otherwise.
Voir également
JFormRule
JFilterInput
Depuis
3.2

Références $data, $form, $message, et $return.

Documentation des champs

◆ $forms

$forms = array()
protected

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