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

Fonctions membres publiques

 onContentPrepareForm (EventInterface $event)
 
 onWorkflowAfterTransition (WorkflowTransitionEvent $event)
 
- Fonctions membres publiques hérités de CMSPlugin
 __construct (&$subject, $config=array())
 
 loadLanguage ($extension='', $basePath=JPATH_ADMINISTRATOR)
 
 setApplication (CMSApplicationInterface $application)
 
- Fonctions membres publiques hérités de DispatcherAwareInterface
 setDispatcher (DispatcherInterface $dispatcher)
 
- Fonctions membres publiques hérités de PluginInterface
 registerListeners ()
 

Fonctions membres publiques statiques

static getSubscribedEvents ()
 

Fonctions membres protégées

 isSupported ($context)
 
- Fonctions membres protégées hérités de CMSPlugin
 registerLegacyListener (string $methodName)
 
 registerListener (string $methodName)
 
 getApplication ()
 

Attributs protégés

 $autoloadLanguage = true
 
 $app
 
 $db
 
- Attributs protégés hérités de CMSPlugin
 $_name = null
 
 $_type = null
 
 $autoloadLanguage = false
 
 $allowLegacyListeners = true
 

Fonctions membres privées

 getUsersFromGroup ($data)
 
 removeLocked (array $userIds)
 

Membres hérités additionnels

- Champs de données hérités de CMSPlugin
 $params = null
 

Description détaillée

Workflow Notification Plugin

Depuis
4.0.0

Documentation des fonctions membres

◆ getSubscribedEvents()

static getSubscribedEvents ( )
static

Returns an array of events this subscriber will listen to.

Renvoie
array
Depuis
4.0.0

Implémente SubscriberInterface.

◆ getUsersFromGroup()

getUsersFromGroup (   $data)
private

Get user_ids of receivers

Paramètres
object$dataObject containing data about the transition
Renvoie
array $userIds The receivers
Depuis
4.0.0

Références $data, $groups, et $model.

◆ isSupported()

isSupported (   $context)
protected

Check if the current plugin should execute workflow related activities

Paramètres
string$context
Renvoie
boolean
Depuis
4.0.0

Références $component, $context, et $parts.

◆ onContentPrepareForm()

onContentPrepareForm ( EventInterface  $event)

The form event.

Paramètres
Form$formThe form
stdClass$dataThe data
Renvoie
boolean
Depuis
4.0.0

Références $context, $data, $form, et EventInterface\getArgument().

◆ onWorkflowAfterTransition()

onWorkflowAfterTransition ( WorkflowTransitionEvent  $event)

Send a Notification to defined users a transition is performed

Paramètres
string$contextThe context for the content passed to the plugin.
array$pksA list of primary key ids of the content that has changed stage.
object$dataObject containing data about the transition
Renvoie
boolean
Depuis
4.0.0

Références $component, $container, $context, $item, $key, $lang, $message, $model, $title, $user, class, AbstractEvent\getArgument(), et Joomla\DI\getContainer().

◆ removeLocked()

removeLocked ( array  $userIds)
private

Remove receivers who have locked their message inputbox

Paramètres
array$userIdsThe userIds which must be checked
Renvoie
array users with active message input box
Depuis
4.0.0

Références $query.

Documentation des champs

◆ $app

$app
protected

◆ $autoloadLanguage

$autoloadLanguage = true
protected

◆ $db

$db
protected

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