Référence de la classe JModel

Graphe d'héritage de JModel:

Graphe de collaboration de JModel:

Liste de tous les membres

Fonctions membres publiques
	__construct ($config=array())
	getDbo ()
	getName ()
	getState ($property=null, $default=null)
	getTable ($name= '', $prefix= 'Table', $options=array())
	setDbo (&$db)
	setState ($property, $value=null)
Fonctions membres publiques inherited from JObject
	__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)
	toString ()

Fonctions membres publiques statiques
static	addIncludePath ($path= '', $prefix= '')
static	addTablePath ($path)
static	getInstance ($type, $prefix= '', $config=array())

Fonctions membres protégées
	_getList ($query, $limitstart=0, $limit=0)
	_getListCount ($query)
	_createTable ($name, $prefix= 'Table', $config=array())
	populateState ()
	cleanCache ($group=null, $client_id=0)

Fonctions membres protégées statiques
static	_createFileName ($type, $parts=array())

Attributs protégés
	$__state_set = null
	$_db
	$name
	$option = null
	$state
	$event_clean_cache = null
Attributs protégés inherited from JObject
	$_errors = array()

---

Documentation des constructeurs et destructeur

JModel::__construct

(

$config = array()

)

Constructor

Paramètres:

array

$config

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

Depuis:

11.1

Réimplémentée à partir de JObject.

Réimplémentée dans JModelAdmin, ContentModelCategory, JModelList, NewsfeedsModelCategory, ContactModelCategory, ContactModelFeatured, FinderModelIndex, WeblinksModelCategory, InstallerModelLanguages, InstallerModel, LanguagesModelOverrides, MenusModelMenus, FinderModelFilters, FinderModelMaps, InstallerModelManage, UsersModelUsers, CategoriesModelCategories, InstallerModelUpdate, RedirectModelLinks, SearchModelSearches, UsersModelNotes, ContactModelContacts, ContentModelArticles, LanguagesModelLanguages, MessagesModelMessages, ModulesModelModules, ModulesModelPositions, NewsfeedsModelNewsfeeds, PluginsModelPlugins, TemplatesModelStyles, WeblinksModelWeblinks, ContentModelArticles, BannersModelBanners, BannersModelClients, BannersModelTracks, ContentModelFeatured, MenusModelItems, TemplatesModelTemplates, UsersModelGroups, et UsersModelLevels.

Références $config, JText\_(), elseif, JFactory\getDbo(), null, et JError\raiseError().

Voici le graphe d'appel pour cette fonction :

---

Documentation des fonctions membres

static JModel::_createFileName (   $type,   $parts = array()  )

staticprotected

Create the filename for a resource

Paramètres:

string	$type	The resource type to create the filename for.
array	$parts	An associative array of filename information.

Renvoie:

string The filename

Depuis:

11.1

Références $parts, et $type.

JModel::_createTable (   $name,   $prefix = 'Table',   $config = array()  )

protected

Method to load and return a model object.

Paramètres:

string	$name	The name of the view
string	$prefix	The class prefix. Optional.
array	$config	Configuration settings to pass to JTable::getInstance

Renvoie:

mixed Model object or boolean false if failed

Depuis:

11.1

Voir également:

JTable::getInstance

Références $config, $name, et JTable\getInstance().

Voici le graphe d'appel pour cette fonction :

JModel::_getList (   $query,   $limitstart = 0,   $limit = 0  )

protected

Gets an array of objects from the results of database query.

Paramètres:

string	$query	The query.
integer	$limitstart	Offset.
integer	$limit	The number of records.

Renvoie:

array An array of results.

Depuis:

11.1

Réimplémentée dans ContentModelArchive, ModulesModelModules, PluginsModelPlugins, et InstallerModel.

Références $limit, et $query.

JModel::_getListCount (   $query )

protected

Returns a record count for the query

Paramètres:

string

$query

The query.

Renvoie:

integer Number of rows for query

Depuis:

11.1

Références $query.

static JModel::addIncludePath (   $path = '',   $prefix = ''  )

static

Add a directory where JModel should search for models. You may either pass a string or an array of directories.

Paramètres:

mixed	$path	A path or array[sting] of paths to search.
string	$prefix	A prefix for models.

Renvoie:

array An array with directory elements. If prefix is equal to '', all directories are returned.

Depuis:

11.1

Réimplémentée dans JModelLegacy.

Références $path, JPath\clean(), et jimport().

Référencé par JController\addModelPath().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static JModel::addTablePath (   $path )

static

Adds to the stack of model table paths in LIFO order.

Paramètres:

mixed

$path

The directory as a string or directories as an array to add.

Renvoie:

void

Depuis:

11.1

Références $path, JTable\addIncludePath(), et jimport().

Voici le graphe d'appel pour cette fonction :

JModel::cleanCache (   $group = null,   $client_id = 0  )

protected

Clean the cache

Paramètres:

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

Renvoie:

void

Depuis:

11.1

Réimplémentée dans MenusModelItem, ModulesModelModule, CategoriesModelCategory, TemplatesModelStyle, ContentModelArticle, PluginsModelPlugin, MenusModelMenu, LanguagesModelLanguages, LanguagesModelLanguage, et FinderModelFilter.

Références $dispatcher, $options, JRequest\getCmd(), JFactory\getConfig(), JDispatcher\getInstance(), JCache\getInstance(), JPATH_ADMINISTRATOR, et JPATH_SITE.

Voici le graphe d'appel pour cette fonction :

JModel::getDbo

(

)

Method to get the database driver object

Renvoie:

JDatabase

static JModel::getInstance (   $type,   $prefix = '',   $config = array()  )

static

Returns a Model object, always creating it

Paramètres:

string	$type	The model type to instantiate
string	$prefix	Prefix for the model class name. Optional.
array	$config	Configuration array for model. Optional.

Renvoie:

mixed A model object or false on failure

Depuis:

11.1

Références $config, $path, $type, JPath\find(), jimport(), null, JError\raiseWarning(), et JText\sprintf().

Référencé par JController\createModel(), ContactViewContact\display(), NewsfeedsViewNewsfeed\display(), ContactModelContact\getContactQuery(), UsersModelUser\getGroups(), JFormFieldMenutype\getInput(), ContentModelCategory\getItems(), modBannersHelper\getList(), modWeblinksHelper\getList(), modArticlesNewsHelper\getList(), modArticlesPopularHelper\getList(), modArticlesLatestHelper\getList(), modArticlesCategoryHelper\getList(), modLatestHelper\getList(), modPopularHelper\getList(), MenusModelMenus\getModules(), plgContentJoomla\onContentAfterSave(), et MessagesModelMessage\save().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

JModel::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:

11.1

Références $name, JText\_(), null, et JError\raiseError().

Voici le graphe d'appel pour cette fonction :

JModel::getState	(		$property = null,
			$default = null
	)

Method to get model state variables

Paramètres:

string	$property	Optional parameter name
mixed	$default	Optional default value

Renvoie:

object The property where specified, the state object where omitted

Depuis:

11.1

Réimplémentée dans MediaModelList, et MediaModelManager.

Références null.

Référencé par ModulesControllerModule\postSaveHook(), et JControllerForm\save().

Voici le graphe des appelants de cette fonction :

JModel::getTable	(		$name = '',
			$prefix = 'Table',
			$options = array()
	)

Method to get a table object, load it if necessary.

Paramètres:

string	$name	The table name. Optional.
string	$prefix	The class prefix. Optional.
array	$options	Configuration array for model. Optional.

Renvoie:

JTable A JTable object

Depuis:

11.1

Réimplémentée dans MenusModelItem, ModulesModelModule, BannersModelBanner, ContactModelContact, TemplatesModelStyle, FinderModelIndex, ContentModelArticle, FinderModelMaps, BannersModelBanners, NewsfeedsModelNewsfeed, PluginsModelPlugin, FinderModelFilter, UsersModelLevel, CategoriesModelCategory, MessagesModelMessage, UsersModelNote, WeblinksModelWeblink, BannersModelClient, RedirectModelLink, MenusModelMenu, UsersModelGroup, UsersModelUser, ContentModelFeature, et LanguagesModelLanguage.

Références $name, $options, null, JError\raiseError(), et JText\sprintf().

Référencé par JControllerForm\save().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

JModel::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:

11.1

Réimplémentée dans MenusModelItem, JModelAdmin, UsersModelRegistration, UsersModelProfile, LanguagesModelOverride, PluginsModelPlugin, UsersModelNote, FinderModelSuggestions, CategoriesModelCategory, UsersModelReset, TemplatesModelTemplate, MenusModelMenu, UsersModelLogin, UsersModelRemind, ModulesModelModule, TemplatesModelStyle, ConfigModelComponent, InstallerModelInstall, ContactModelContact, WeblinksModelForm, LanguagesModelLanguage, ContentModelArticle, NewsfeedsModelNewsfeed, WeblinksModelWeblink, TemplatesModelSource, MessagesModelMessage, ContentModelForm, BannersModelDownload, MessagesModelConfig, et LoginModelLogin.

JModel::setDbo

(

&

$db

)

Method to set the database driver object

Paramètres:

JDatabase

&$db

A JDatabase based object

Renvoie:

void

Depuis:

11.1

Références $db.

JModel::setState	(		$property,
			$value = null
	)

Method to set model state variables

Paramètres:

string	$property	The name of the property.
mixed	$value	The value of the property to set or null.

Renvoie:

mixed The previous value of the property or null if not set.

Depuis:

11.1

---

Documentation des données membres

JModel::$__state_set = null

protected

JModel::$_db

protected

JModel::$event_clean_cache = null

protected

JModel::$name

protected

JModel::$option = null

protected

Réimplémentée dans LanguagesModelInstalled.

JModel::$state

protected

---

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

• model.php