Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe BaseDatabaseModel
+ Graphe d'héritage de BaseDatabaseModel:

Fonctions membres publiques

 __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 protégées

 _getList ($query, $limitstart=0, $limit=0)
 
 _getListCount ($query)
 
 _createTable ($name, $prefix='Table', $config=array())
 
 bootComponent ($component)
 
 dispatchEvent (EventInterface $event)
 

Attributs protégés

 $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()
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de BaseModel
static addIncludePath ($path='', $prefix='')
 
- Attributs protégés statiques hérités de BaseModel
static $paths
 

Description détaillée

Base class for a database aware Joomla Model

Acts as a Factory class for application specific objects and provides many supporting API functions.

Depuis
2.5.5

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $config = array(),
MVCFactoryInterface  $factory = null 
)

Constructor

Paramètres
array$configAn array of configuration options (name, state, dbo, table_path, ignore_request).
MVCFactoryInterface$factoryThe factory.
Depuis
3.0
Exceptions
Obsolète:
5.0 Database instance is injected through the setter function, subclasses should not use the db instance in constructor anymore

Références $component, $config, $db, $r, $this, Symfony\Contracts\Service\__construct(), elseif, Factory\getApplication(), ComponentHelper\getComponentName(), Factory\getDbo(), null, Joomla\Database\setDatabase(), Joomla\CMS\MVC\Model\setDbo(), Joomla\CMS\MVC\Factory\setMVCFactory(), et Text\sprintf().

Documentation des fonctions membres

◆ __get()

__get (   $name)

Proxy for _db variable.

Paramètres
string$nameThe name of the element
Renvoie
mixed The value of the element if set, null otherwise
Depuis
4.2.0
Obsolète:
5.0 Use getDatabase() instead of directly accessing _db

Références $name, Joomla\CMS\MVC\Model\getDbo(), et null.

◆ _createTable()

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

Method to load and return a table object.

Paramètres
string$nameThe name of the view
string$prefixThe class prefix. Optional.
array$configConfiguration settings to pass to Table::getInstance
Renvoie
Table|boolean Table object or boolean false if failed
Depuis
3.0
Voir également
::getInstance()

Références $config, $name, $prefix, Joomla\CMS\MVC\Model\getDbo(), et Joomla\CMS\MVC\Factory\getMVCFactory().

◆ _getList()

_getList (   $query,
  $limitstart = 0,
  $limit = 0 
)
protected

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

Paramètres
string$queryThe query.
integer$limitstartOffset.
integer$limitThe number of records.
Renvoie
object[] An array of results.
Depuis
3.0
Exceptions

Références $limit, $query, et Joomla\CMS\MVC\Model\getDbo().

◆ _getListCount()

_getListCount (   $query)
protected

Returns a record count for the query.

Note: Current implementation of this method assumes that getListQuery() returns a set of unique rows, thus it uses SELECT COUNT(*) to count the rows. In cases that getListQuery() uses DISTINCT then either this method must be overridden by a custom implementation at the derived Model Class or a GROUP BY clause should be used to make the set unique.

Paramètres
DatabaseQuery | string$queryThe query.
Renvoie
integer Number of rows for query.
Depuis
3.0

Références $query, Joomla\CMS\MVC\Model\getDbo(), et null.

◆ bootComponent()

bootComponent (   $component)
protected

Boots the component with the given name.

Paramètres
string$componentThe component name, eg. com_content.
Renvoie
ComponentInterface The service container
Depuis
4.0.0

Références $component, et Factory\getApplication().

◆ dispatchEvent()

dispatchEvent ( EventInterface  $event)
protected

Dispatches the given event on the internal dispatcher, does a fallback to the global one.

Paramètres
EventInterface$eventThe event
Renvoie
void
Depuis
4.1.0

Références class, Factory\getContainer(), Joomla\CMS\Application\getDispatcher(), et EventInterface\getName().

◆ getDbo()

getDbo ( )

Get the database driver.

Renvoie
DatabaseInterface The database driver.
Depuis
4.2.0
Exceptions

Implémente DatabaseModelInterface.

Références Joomla\Database\getDatabase().

◆ getTable()

getTable (   $name = '',
  $prefix = '',
  $options = array() 
)

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

Paramètres
string$nameThe table name. Optional.
string$prefixThe class prefix. Optional.
array$optionsConfiguration array for model. Optional.
Renvoie
Table A Table object
Depuis
3.0
Exceptions

Références $name, $options, $prefix, Joomla\CMS\MVC\Factory\getMVCFactory(), et Text\sprintf().

◆ isCheckedOut()

isCheckedOut (   $item)

Method to check if the given record is checked out by the current user

Paramètres
\stdClass$itemThe record to check
Renvoie
bool

Références $item.

◆ setDbo()

setDbo ( DatabaseInterface  $db = null)

Set the database driver.

Paramètres
DatabaseInterface$dbThe database driver.
Renvoie
void
Depuis
4.2.0
Obsolète:
5.0 Use setDatabase() instead

Références $db, null, et Joomla\Database\setDatabase().

Documentation des champs

◆ $event_clean_cache

$event_clean_cache = null
protected

◆ $option

$option = null
protected

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