Référence de la classe ConfigModelCms

Graphe d'héritage de ConfigModelCms:

Fonctions membres publiques
	__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
	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
	$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 admin model.

Depuis

3.2

Documentation des constructeurs et destructeur

__construct()

__construct

(

$config = array()

)

Constructor

Paramètres

array

$config

An array of configuration options (name, state, dbo, table_path, ignore_request).

Depuis

3.2

Exceptions

Exception

Références $config, $r, $state, elseif, name, null, et option.

Documentation des fonctions membres

canDelete()

canDelete (   $record )

protected

Method to test whether a record can be deleted.

Paramètres

object

$record

A record object.

Renvoie

boolean True if allowed to delete the record. Defaults to the permission set in the component.

Depuis

3.2

Références option.

canEditState()

canEditState (   $record )

protected

Method to test whether a record can have its state changed.

Paramètres

object

$record

A record object.

Renvoie

boolean True if allowed to change the state of the record. Defaults to the permission set in the component.

Depuis

3.2

Références option.

cleanCache()

cleanCache (   $group = null,   $clientId = 0  )

protected

Clean the cache

Paramètres

string	$group	The cache group
integer	$clientId	The ID of the client

Renvoie

void

Depuis

3.2

Références $clientId, $dispatcher, $options, JEventDispatcher\getInstance(), JPATH_ADMINISTRATOR, JPATH_SITE, et option.

getName()

getName

(

)

Method to get the model name

The model name. By default parsed using the classname or it can be set by passing a $config['name'] in the class constructor

Renvoie

string The name of the model

Depuis

3.2

Exceptions

Exception

Références $name, $r, name, et null.

getState()

getState

(

)

Method to get model state variables

Renvoie

object The property where specified, the state object where omitted

Depuis

3.2

Implémente JModel.

Références $state.

populateState()

populateState ( )

protected

Method to auto-populate the model state.

This method should only be called once per instantiation and is designed to be called on the first call to the getState() method unless the model configuration flag to ignore the request is set.

Renvoie

void

Note

Calling getState in this method will result in recursion.

Depuis

3.2

registerTablePaths()

registerTablePaths

(

$config = array()

)

Method to register paths for tables

Paramètres

array

$config

Configuration array

Renvoie

object The property where specified, the state object where omitted

Depuis

3.2

Références $config, elseif, et JPATH_COMPONENT_ADMINISTRATOR.

Documentation des champs

$__state_set

$__state_set = null

protected

$name

$name

protected

$option

$option = null

protected

$text_prefix

$text_prefix = null

protected

---

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

• components/com_config/model/cms.php