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

Fonctions membres publiques

 __construct ($config=array(), MVCFactoryInterface $factory=null)
 
 delete (&$pks)
 
 getTable ($type='Map', $prefix='Administrator', $config=array())
 
 publish (&$pks, $value=1)
 
 purge ()
 
- Fonctions membres publiques hérités de ListModel
 __construct ($config=array(), MVCFactoryInterface $factory=null)
 
 getIsEmptyState ()
 
 getActiveFilters ()
 
 getItems ()
 
 getPagination ()
 
 getTotal ()
 
 getStart ()
 
 getFilterForm ($data=array(), $loadData=true)
 
 getUserStateFromRequest ($key, $request, $default=null, $type='none', $resetPage=true)
 
- 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 protégées

 canDelete ($record)
 
 canEditState ($record)
 
 getListQuery ()
 
 _getListCount ($query)
 
 getStoreId ($id='')
 
 populateState ($ordering='branch_title, a.lft', $direction='ASC')
 
 getEmptyStateQuery ()
 
- Fonctions membres protégées hérités de ListModel
 getEmptyStateQuery ()
 
 _getListQuery ()
 
 getListQuery ()
 
 getStoreId ($id='')
 
 loadFormData ()
 
 populateState ($ordering=null, $direction=null)
 
 refineSearchStringToRegex ($search, $regexDelimiter='/')
 
- 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)
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de BaseModel
static addIncludePath ($path='', $prefix='')
 
- Attributs protégés hérités de ListModel
 $cache = array()
 
 $context = null
 
 $filter_fields = array()
 
 $query = array()
 
 $lastQueryStoreId = null
 
 $filterFormName = null
 
 $htmlFormName = 'adminForm'
 
 $filterBlacklist = array()
 
 $filterForbiddenList = array()
 
 $listBlacklist = array('select')
 
 $listForbiddenList = array('select')
 
- 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

Maps model for the Finder package.

Depuis
2.5

Documentation des constructeurs et destructeur

◆ __construct()

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

Constructor.

Paramètres
array$configAn optional associative array of configuration settings.
MVCFactoryInterface$factoryThe factory.
Voir également
Depuis
3.7

Références $config, et Symfony\Contracts\Service\__construct().

Documentation des fonctions membres

◆ _getListCount()

_getListCount (   $query)
protected

Returns a record count for the query.

Paramètres

Références $query, et Joomla\Database\getDatabase().

◆ canDelete()

canDelete (   $record)
protected

Method to test whether a record can be deleted.

Paramètres
object$recordA record object.
Renvoie
boolean True if allowed to delete the record. Defaults to the permission for the component.
Depuis
2.5

Références Factory\getUser().

◆ canEditState()

canEditState (   $record)
protected

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

Paramètres
object$recordA record object.
Renvoie
boolean True if allowed to change the state of the record. Defaults to the permission for the component.
Depuis
2.5

Références Factory\getUser().

◆ delete()

delete ( $pks)

Method to delete one or more records.

Paramètres
array$pksAn array of record primary keys.
Renvoie
boolean True if successful, false if an error occurs.
Depuis
2.5

Références $context, $i, $name, $result, Text\_(), Factory\getApplication(), et PluginHelper\importPlugin().

◆ getEmptyStateQuery()

getEmptyStateQuery ( )
protected

Manipulate the query to be used to evaluate if this is an Empty State to provide specific conditions for this extension.

Renvoie
DatabaseQuery
Depuis
4.0.0

Références $query, $title, et Joomla\Database\getDatabase().

◆ getListQuery()

getListQuery ( )
protected

Build an SQL query to load the list data.

Renvoie
Depuis
2.5

Références $db, $query, $state, $this, Joomla\Database\getDatabase(), et Joomla\CMS\MVC\Model\getState().

◆ getStoreId()

getStoreId (   $id = '')
protected

Method to get a store id based on model configuration state.

This is necessary because the model is used by the component and different modules that might need different sets of data or different ordering requirements.

Paramètres
string$idA prefix for the store id. [optional]
Renvoie
string A store id.
Depuis
2.5

Références $id, et Joomla\CMS\MVC\Model\getState().

◆ getTable()

getTable (   $type = 'Map',
  $prefix = 'Administrator',
  $config = array() 
)

Returns a Table object, always creating it.

Paramètres
string$typeThe table type to instantiate. [optional]
string$prefixA prefix for the table class name. [optional]
array$configConfiguration array for model. [optional]
Renvoie
A database object
Depuis
2.5

Références $config, $prefix, et $type.

◆ populateState()

populateState (   $ordering = 'branch_title,
a.lft'  ,
  $direction = 'ASC' 
)
protected

Method to auto-populate the model state. Calling getState in this method will result in recursion.

Paramètres
string$orderingAn optional ordering field. [optional]
string$directionAn optional direction. [optional]
Renvoie
void
Depuis
2.5

Références $direction, $ordering, $params, ComponentHelper\getParams(), Joomla\CMS\MVC\Model\populateState(), et Joomla\CMS\MVC\Model\setState().

◆ publish()

publish ( $pks,
  $value = 1 
)

Method to change the published state of one or more records.

Paramètres
array$pksA list of the primary keys to change.
integer$valueThe value of the published state. [optional]
Renvoie
boolean True on success.
Depuis
2.5

Références $context, $i, $name, $result, $user, $value, Text\_(), Factory\getApplication(), Factory\getUser(), et PluginHelper\importPlugin().

◆ purge()

purge ( )

Method to purge all maps from the taxonomy.

Renvoie
boolean Returns true on success, false on failure.
Depuis
2.5

Références $db, $query, et Joomla\Database\getDatabase().


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