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

Fonctions membres publiques

 onContentPrepareForm (EventInterface $event)
 
 onAfterDisplay (DisplayEvent $event)
 
 onWorkflowBeforeTransition (WorkflowTransitionEvent $event)
 
 onWorkflowAfterTransition (WorkflowTransitionEvent $event)
 
 onContentBeforeChangeFeatured (FeatureEvent $event)
 
 onContentVersioningPrepareTable (EventInterface $event)
 
 onTableBeforeStore (BeforeStoreEvent $event)
 
 onWorkflowFunctionalityUsed (WorkflowFunctionalityUsedEvent $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

 enhanceItemForm (Form $form, $data)
 
 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
 
 $supportFunctionality = 'core.featured'
 
- Attributs protégés hérités de CMSPlugin
 $_name = null
 
 $_type = null
 
 $autoloadLanguage = false
 
 $allowLegacyListeners = true
 

Membres hérités additionnels

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

Description détaillée

Workflow Featuring Plugin

Depuis
4.0.0

Documentation des fonctions membres

◆ enhanceItemForm()

enhanceItemForm ( Form  $form,
  $data 
)
protected

Disable certain fields in the item form view, when we want to take over this function in the transition Check also for the workflow implementation and if the field exists

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

Références $component, $context, $data, $form, $label, $option, $options, $parts, $text, $value, ENT_COMPAT, et null.

◆ getSubscribedEvents()

static getSubscribedEvents ( )
static

Returns an array of events this subscriber will listen to.

Renvoie
array
Depuis
4.0.0

Implémente SubscriberInterface.

◆ 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, $model, $parts, TableInterface\hasField(), et Joomla\CMS\Workflow\supportFunctionality().

◆ onAfterDisplay()

onAfterDisplay ( DisplayEvent  $event)

Manipulate the generic list view

Paramètres
DisplayEvent$event
Depuis
4.0.0

Références $app, $component, $section, et AbstractEvent\getArgument().

◆ onContentBeforeChangeFeatured()

onContentBeforeChangeFeatured ( FeatureEvent  $event)

Change Feature State of an item. Used to disable Feature state change

Paramètres
FeatureEvent$event
Renvoie
boolean
Exceptions
Exception
Depuis
4.0.0

Références $extension, AbstractEvent\getArgument(), et FeatureEvent\setAbort().

◆ onContentPrepareForm()

onContentPrepareForm ( EventInterface  $event)

The form event.

Paramètres
EventInterface$eventThe event
Depuis
4.0.0

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

◆ onContentVersioningPrepareTable()

onContentVersioningPrepareTable ( EventInterface  $event)

We remove the featured field from the versioning

Paramètres
EventInterface$event
Renvoie
boolean
Depuis
4.0.0

Références $component, $context, $model, $parts, $subject, et EventInterface\getArgument().

◆ onTableBeforeStore()

onTableBeforeStore ( BeforeStoreEvent  $event)

Pre-processor for $table->store($updateNulls)

Paramètres
BeforeStoreEvent$eventThe event to handle
Renvoie
void
Depuis
4.0.0

Références $component, $field, $model, $parts, $subject, et AbstractEvent\getArgument().

◆ onWorkflowAfterTransition()

onWorkflowAfterTransition ( WorkflowTransitionEvent  $event)

Change Feature State of an item. Used to disable feature state change

Paramètres
WorkflowTransitionEvent$event
Renvoie
void
Depuis
4.0.0

Références $component, $context, $model, $options, $value, et AbstractEvent\getArgument().

◆ onWorkflowBeforeTransition()

onWorkflowBeforeTransition ( WorkflowTransitionEvent  $event)

Check if we can execute the transition

Paramètres
WorkflowTransitionEvent$event
Renvoie
boolean
Depuis
4.0.0

Here it becomes tricky. We would like to use the component models featured method, so we will Execute the normal "onContentBeforeChangeFeatured" plugins. But they could cancel the execution, So we have to precheck and cancel the whole transition stuff if not allowed.

Références $context, $this, $value, AbstractEvent\getArgument(), et WorkflowTransitionEvent\setStopTransition().

◆ onWorkflowFunctionalityUsed()

onWorkflowFunctionalityUsed ( WorkflowFunctionalityUsedEvent  $event)

If plugin supports the functionality we set the used variable

Paramètres
WorkflowFunctionalityUsedEvent$event
Depuis
4.0.0

Références AbstractEvent\getArgument(), et WorkflowFunctionalityUsedEvent\setUsed().

Documentation des champs

◆ $app

$app
protected

◆ $autoloadLanguage

$autoloadLanguage = true
protected

◆ $supportFunctionality

$supportFunctionality = 'core.featured'
protected

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