Référence de la classe ModulesModel

Graphe d'héritage de ModulesModel:

Fonctions membres publiques
	getForm ($data=array(), $loadData=true)
	getPositions ()
Fonctions membres publiques hérités de FormModel
	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 statiques
static	getActivePositions ($clientId, $editPositions=false)
Fonctions membres publiques statiques hérités de BaseModel
static	addIncludePath ($path='', $prefix='')

Fonctions membres protégées
	populateState ()
	preprocessForm (Form $form, $data, $group='content')
Fonctions membres protégées hérités de FormModel
	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)

Fonctions membres privées statiques
static	createOption ($value='', $text='')
static	createOptionGroup ($label='', $options=array())

Membres hérités additionnels
Attributs protégés hérités de FormModel
	$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()
Attributs protégés statiques hérités de BaseModel
static	$paths

Description détaillée

Config Module model.

Depuis

3.2

Documentation des fonctions membres

createOption()

static createOption (   $value = '',   $text = ''  )

staticprivate

Create and return a new Option

Paramètres

string	$value	The option value [optional]
string	$text	The option text [optional]

Renvoie

object The option as an object (stdClass instance)

Depuis

3.6.3

Références $option, $text, et $value.

createOptionGroup()

static createOptionGroup (   $label = '',   $options = array()  )

staticprivate

Create and return a new Option Group

Paramètres

string	$label	Value and label for group [optional]
array	$options	Array of options to insert into group [optional]

Renvoie

array Return the new group as an array

Depuis

3.6.3

Références $label, et $options.

getActivePositions()

static getActivePositions (   $clientId,   $editPositions = false  )

static

Get a list of modules positions

Paramètres

integer	$clientId	Client ID
boolean	$editPositions	Allow to edit the positions

Renvoie

array A list of positions

Depuis

3.6.3

Références $clientId, $db, $options, $position, $positions, $query, Text\_(), HTMLHelper\_(), Factory\getApplication(), et Factory\getDbo().

getForm()

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

Method to get the record form.

Paramètres

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

Renvoie

Form A Form object on success, false on failure

Depuis

3.2

Implémente FormModelInterface.

Références $form, et Joomla\CMS\MVC\Model\loadForm().

getPositions()

getPositions

(

)

Method to get list of module positions in current template

Renvoie

array

Depuis

3.2

Références $lang, $option, $path, $position, $text, $value, $xml, Text\_(), Path\clean(), Factory\getApplication(), Factory\getLanguage(), et JPATH_BASE.

populateState()

populateState ( )

protected

Method to auto-populate the model state.

Note. Calling getState in this method will result in recursion.

Renvoie

void

Depuis

3.2

Références $app, Factory\getApplication(), et Joomla\CMS\MVC\Model\setState().

preprocessForm()

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

protected

Method 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

Depuis

3.2

Exceptions

Références $basePath, $data, $form, $lang, $module, $xml, Text\_(), Form\addFormPath(), Path\clean(), Factory\getLanguage(), Joomla\CMS\MVC\Model\getState(), JPATH_BASE, et Joomla\CMS\MVC\Model\preprocessForm().

---

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

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