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())
• & getInstance ($type, $prefix= '', $config=array())
• setState ($property, $value=null)
• getState ($property=null)
• & getDBO ()
• setDBO (&$db)
• getName ()
• & getTable ($name='', $prefix='Table', $options=array())
• addIncludePath ($path='')
• & _getList ($query, $limitstart=0, $limit=0)
• _getListCount ($query)
• & _createTable ($name, $prefix= 'Table', $config=array())
• _createFileName ($type, $parts=array())

Fonctions membres publiques statiques

• addTablePath ($path)

Attributs publics

• $_name
• $_db
• $_state

---

Documentation des constructeurs et destructeur

JModel::__construct

(

$

config = array()

)

Constructor

Depuis:

1.5

Réimplémentée dans JInstallationModel.

Références $config, et JFactory::getDBO().

Voici le graphe d'appel pour cette fonction :

---

Documentation des fonctions membres

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

Create the filename for a resource

private

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:

1.5

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

Référencé par getInstance().

Voici le graphe d'appel pour cette fonction :

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

Method to load and return a model object.

private

Paramètres:

string	The name of the view
string	The class prefix. Optional.

Renvoie:

mixed Model object or boolean false if failed

Depuis:

1.5

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

Voici le graphe d'appel pour cette fonction :

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

Returns an object list

Paramètres:

string	The query
int	Offset
int	The number of records

Renvoie:

array protected

Depuis:

1.5

Réimplémentée dans ContentModelArchive.

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

JModel::_getListCount

(

$

query

)

Returns a record count for the query

Paramètres:

string

The query

Renvoie:

int protected

Depuis:

1.5

Références $query.

JModel::addIncludePath

(

$

path = ''

)

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

public

Paramètres:

string

A path to search.

Renvoie:

array An array with directory elements

Depuis:

1.5

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

Référencé par JController::addModelPath(), getInstance(), et restoreTrash().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JModel::addTablePath

(

$

path

)

[static]

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

Paramètres:

string|array

The directory (-ies) to add.

Renvoie:

void

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

Voici le graphe d'appel pour cette fonction :

& JModel::getDBO

(

)

Method to get the database connector object

public

Renvoie:

object JDatabase connector object

Depuis:

1.5

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

Returns a reference to the a Model object, always creating it

Paramètres:

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

Renvoie:

mixed A model object, or false on failure

Depuis:

1.5

Références $config, $path, $type, _createFileName(), addIncludePath(), JPath::find(), jimport(), et JError::raiseWarning().

Référencé par JController::_createModel(), WeblinksViewCategory::display(), et restoreTrash().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour 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

public

Renvoie:

string The name of the model

Depuis:

1.5

Références $name, et JError::raiseError().

Voici le graphe d'appel pour cette fonction :

JModel::getState

(

$

property = null

)

Method to get model state variables

public

Paramètres:

string

Optional parameter name

Renvoie:

object The property where specified, the state object where omitted

Depuis:

1.5

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

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

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

public

Paramètres:

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

Renvoie:

object The table

Depuis:

1.5

Références $name, et JError::raiseError().

Voici le graphe d'appel pour cette fonction :

JModel::setDBO

(

&$

db

)

Method to set the database connector object

Paramètres:

object

$db

A JDatabase based object

Renvoie:

void

Depuis:

1.5

Références $db.

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

Method to set model state variables

public

Paramètres:

string	The name of the property
mixed	The value of the property to set

Renvoie:

mixed The previous value of the property

Depuis:

1.5

---

Documentation des données membres

JModel::$_db

JModel::$_name

JModel::$_state

---

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

• libraries/joomla/application/component/model.php