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

Fonctions membres publiques

 __construct ($config=array(), MVCFactoryInterface $factory=null)
 
 getForm ($data=array(), $loadData=true)
 
 getItem ($pk=null)
 
 getTable ($type='Extension', $prefix='JTable', $config=array())
 
 save ($data)
 
 getHelp ()
 
- Fonctions membres publiques hérités de AdminModel
 __construct ($config=array(), MVCFactoryInterface $factory=null, FormFactoryInterface $formFactory=null)
 
 batch ($commands, $pks, $contexts)
 
 checkin ($pks=array())
 
 checkout ($pk=null)
 
 delete (&$pks)
 
 getItem ($pk=null)
 
 publish (&$pks, $value=1)
 
 reorder ($pks, $delta=0)
 
 save ($data)
 
 saveorder ($pks=array(), $order=null)
 
 generateTitle ($categoryId, $table)
 
 initBatch ()
 
 editAssociations ($data)
 
- Fonctions membres publiques hérités de FormModel
 __construct ($config=array(), MVCFactoryInterface $factory=null, FormFactoryInterface $formFactory=null)
 
 checkin ($pk=null)
 
 checkout ($pk=null)
 
 validate ($form, $data, $group=null)
 
- 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

 loadFormData ()
 
 populateState ()
 
 preprocessForm (Form $form, $data, $group='content')
 
 getReorderConditions ($table)
 
 cleanCache ($group=null, $clientId=0)
 
- Fonctions membres protégées hérités de AdminModel
 batchAccess ($value, $pks, $contexts)
 
 batchCopy ($value, $pks, $contexts)
 
 cleanupPostBatchCopy (TableInterface $table, $newId, $oldId)
 
 batchLanguage ($value, $pks, $contexts)
 
 batchMove ($value, $pks, $contexts)
 
 batchTag ($value, $pks, $contexts)
 
 canDelete ($record)
 
 canEditState ($record)
 
 generateNewTitle ($categoryId, $alias, $title)
 
 getReorderConditions ($table)
 
 populateState ()
 
 prepareTable ($table)
 
 checkCategoryId ($categoryId)
 
 redirectToAssociations ($data)
 
- 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)
 

Attributs protégés

 $helpKey = 'Plugins:_Name_of_Plugin'
 
 $helpURL
 
 $_cache
 
- Attributs protégés hérités de AdminModel
 $text_prefix = null
 
 $event_after_delete = null
 
 $event_after_save = null
 
 $event_before_delete = null
 
 $event_before_save = null
 
 $event_before_change_state = null
 
 $event_change_state = null
 
 $event_before_batch = null
 
 $batch_copymove = 'category_id'
 
 $batch_commands
 
 $associationsContext = null
 
 $batchSet = null
 
 $user = null
 
 $table = null
 
 $tableClassName = null
 
 $contentType = null
 
 $type = null
 
- Attributs protégés hérités de FormModel
 $events_map = null
 
- 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()
 

Membres hérités additionnels

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

Description détaillée

Plugin model.

Depuis
1.6

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.2

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

Documentation des fonctions membres

◆ cleanCache()

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

Custom clean cache method, plugins are cached in 2 places for different clients.

Paramètres
string$groupCache group name.
integer$clientId

◆ getForm()

getForm (   $data = array(),
  $loadData = true 
)

Method to get the record form.

Paramètres
array$dataData for the form.
boolean$loadDataTrue if the form is to load its own data (default case), false if not.
Renvoie
Form|bool A Form object on success, false on failure.
Depuis
1.6

Implémente FormModelInterface.

Références $data, $folder, $form, $item, Form\addFieldPath(), ArrayHelper\getValue(), JPATH_PLUGINS, Joomla\CMS\MVC\Model\loadForm(), et Joomla\CMS\MVC\Model\setState().

◆ getHelp()

getHelp ( )

Get the necessary data to load an item help screen.

Renvoie
object An object with key, url, and local properties for loading the item help screen.
Depuis
1.6

◆ getItem()

getItem (   $pk = null)

Method to get a single record.

Paramètres
integer$pkThe id of the primary key.
Renvoie
mixed Object on success, false on failure.

Références $path, $return, class, Path\clean(), Joomla\CMS\MVC\Model\getState(), JPATH_PLUGINS, null, et ArrayHelper\toObject().

◆ getReorderConditions()

getReorderConditions (   $table)
protected

A protected method to get a set of ordering conditions.

Paramètres
object$tableA record object.
Renvoie
array An array of conditions to add to ordering queries.
Depuis
1.6

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

◆ getTable()

getTable (   $type = 'Extension',
  $prefix = 'JTable',
  $config = array() 
)

Returns a reference to the Table object, always creating it.

Paramètres
string$typeThe table type to instantiate.
string$prefixA prefix for the table class name. Optional.
array$configConfiguration array for model. Optional.
Renvoie
Table A database object

Références $config, $prefix, $type, et Table\getInstance().

◆ loadFormData()

loadFormData ( )
protected

Method to get the data that should be injected in the form.

Renvoie
mixed The data for the form.
Depuis
1.6

Références $data, Factory\getApplication(), et Joomla\CMS\MVC\Model\preprocessData().

◆ populateState()

populateState ( )
protected

Auto-populate the model state.

Note. Calling getState in this method will result in recursion.

Renvoie
void
Depuis
1.6

Références $app, Factory\getApplication(), Joomla\CMS\MVC\Model\populateState(), et Joomla\CMS\MVC\Model\setState().

◆ preprocessForm()

preprocessForm ( Form  $form,
  $data,
  $group = 'content' 
)
protected

Preprocess the form.

Paramètres
Form$formA form object.
mixed$dataThe data expected for the form.
string$groupCache group name.
Renvoie
mixed True if successful.
Depuis
1.6
Exceptions

Références $app, $data, $db, $folder, $form, $helpURL, $lang, $query, $xml, Text\_(), Route\_(), Path\clean(), Factory\getApplication(), Joomla\Database\getDatabase(), Factory\getLanguage(), Joomla\CMS\MVC\Model\getState(), JPATH_ADMINISTRATOR, JPATH_PLUGINS, Joomla\CMS\MVC\Model\preprocessForm(), et Text\sprintf().

◆ save()

save (   $data)

Override method to save the form data.

Paramètres
array$dataThe form data.
Renvoie
boolean True on success.
Depuis
1.6

Références $data.

Documentation des champs

◆ $_cache

$_cache
protected

◆ $helpKey

$helpKey = 'Plugins:_Name_of_Plugin'
protected

◆ $helpURL

$helpURL
protected

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