[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/plugins/workflow/notification/ -> notification.php (summary)

(no description)

Copyright: (C) 2020 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 344 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

PlgWorkflowNotification:: (6 methods):
  getSubscribedEvents()
  onContentPrepareForm()
  onWorkflowAfterTransition()
  getUsersFromGroup()
  isSupported()
  removeLocked()


Class: PlgWorkflowNotification  - X-Ref

Workflow Notification Plugin

getSubscribedEvents()   X-Ref
Returns an array of events this subscriber will listen to.

return: array

onContentPrepareForm(EventInterface $event)   X-Ref
The form event.

param: Form      $form  The form
param: stdClass  $data  The data
return: boolean

onWorkflowAfterTransition(WorkflowTransitionEvent $event)   X-Ref
Send a Notification to defined users a transition is performed

param: string  $context  The context for the content passed to the plugin.
param: array   $pks      A list of primary key ids of the content that has changed stage.
param: object  $data     Object containing data about the transition
return: boolean

getUsersFromGroup($data)   X-Ref
Get user_ids of receivers

param: object  $data  Object containing data about the transition
return: array  $userIds  The receivers

isSupported($context)   X-Ref
Check if the current plugin should execute workflow related activities

param: string  $context
return: boolean

removeLocked(array $userIds)   X-Ref
Remove receivers who have locked their message inputbox

param: array  $userIds  The userIds which must be checked
return: array  users with active message input box



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer