Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wintercms/wn-notify-plugin
Manage notifications in Winter CMS
https://github.com/wintercms/wn-notify-plugin
hacktoberfest
Last synced: about 1 month ago
JSON representation
Manage notifications in Winter CMS
- Host: GitHub
- URL: https://github.com/wintercms/wn-notify-plugin
- Owner: wintercms
- License: mit
- Created: 2021-03-06T05:30:07.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T17:39:54.000Z (9 months ago)
- Last Synced: 2024-04-14T00:37:56.557Z (8 months ago)
- Topics: hacktoberfest
- Language: PHP
- Homepage:
- Size: 135 KB
- Stars: 3
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-wintercms - Winter.Notify - Notification management engine. (Uncategorized / Uncategorized)
README
# Notification Engine Plugin
[](https://github.com/wintercms/wn-notify-plugin/blob/main/LICENSE)
>**NOTE:** Plugin is currently in Beta status. Proceed with caution.
Adds support for sending notifications across a variety of different channels, including mail, SMS and Slack.
Notifications are managed in the backend area by navigating to *Settings > Notification rules*.
## Installation
This plugin is available for installation via [Composer](http://getcomposer.org/).
```bash
composer require winter/wn-notify-plugin
```
After installing the plugin you will need to run the migrations and (if you are using a [public folder](https://wintercms.com/docs/develop/docs/setup/configuration#using-a-public-folder)) [republish your public directory](https://wintercms.com/docs/develop/docs/console/setup-maintenance#mirror-public-files).
```bash
php artisan migrate
```
## Notification workflow
When a notification fires, it uses the following workflow:
1. Plugin registers associated actions, conditions and events using `registerNotificationRules`
1. A notification class is bound to a system event using `Notifier::bindEvent`
1. A system event is fired `Event::fire`
1. The parameters of the event are captured, along with any global context parameters
1. A command is pushed on the queue to process the notification `Queue::push`
1. The command finds all notification rules using the notification class and triggers them
1. The notification conditions are checked and only proceed if met
1. The notification actions are triggered
Here is an example of a plugin registering notification rules. The `groups` definition will create containers that are used to better organise events. The `presets` definition specifies notification rules defined by the system.
```php
public function registerNotificationRules()
{
return [
'events' => [
\Winter\User\NotifyRules\UserActivatedEvent::class,
],
'actions' => [
\Winter\User\NotifyRules\SaveToDatabaseAction::class,
],
'conditions' => [
\Winter\User\NotifyRules\UserAttributeCondition::class
],
'groups' => [
'user' => [
'label' => 'User',
'icon' => 'icon-user'
],
],
'presets' => '$/winter/user/config/notify_presets.yaml',
];
}
```
Here is an example of triggering a notification. The system event `winter.user.activate` is bound to the `UserActivatedEvent` class.
```php
// Bind to a system event
\Winter\Notify\Classes\Notifier::bindEvents([
'winter.user.activate' => \Winter\User\NotifyRules\UserActivatedEvent::class
]);
// Fire the system event
Event::fire('winter.user.activate', [$this]);
```
Here is an example of registering context parameters, which are available globally to all notifications.
```php
\Winter\Notify\Classes\Notifier::instance()->registerCallback(function($manager) {
$manager->registerGlobalParams([
'user' => Auth::getUser()
]);
});
```
Here is an example of an event preset:
```yaml
# ===================================
# Event Presets
# ===================================
welcome_email:
name: Send welcome email to user
event: Winter\User\NotifyRules\UserRegisteredEvent
items:
- action: Winter\Notify\NotifyRules\SendMailTemplateAction
mail_template: winter.user::mail.welcome
send_to_mode: user
conditions:
- condition: Winter\Notify\NotifyRules\ExecutionContextCondition
subcondition: environment
operator: is
value: dev
condition_text: Application environment is dev
```
## Creating Event classes
An event class is responsible for preparing the parameters passed to the conditions and actions. The static method `makeParamsFromEvent` will take the arguments provided by the system event and convert them in to parameters.
```php
class UserActivatedEvent extends \Winter\Notify\Classes\EventBase
{
/**
* @var array Local conditions supported by this event.
*/
public $conditions = [
\Winter\User\NotifyRules\UserAttributeCondition::class
];
/**
* Returns information about this event, including name and description.
*/
public function eventDetails()
{
return [
'name' => 'Activated',
'description' => 'A user is activated',
'group' => 'user'
];
}
/**
* Defines the usable parameters provided by this class.
*/
public function defineParams()
{
return [
'name' => [
'title' => 'Name',
'label' => 'Name of the user',
],
// ...
];
}
public static function makeParamsFromEvent(array $args, $eventName = null)
{
return [
'user' => array_get($args, 0)
];
}
}
```
## Creating Action classes
Action classes define the final step in a notification and subsequently perform the notification itself. Some examples might be sending and email or writing to the database.
```php
class SendMailTemplateAction extends \Winter\Notify\Classes\ActionBase
{
/**
* Returns information about this event, including name and description.
*/
public function actionDetails()
{
return [
'name' => 'Compose a mail message',
'description' => 'Send a message to a recipient',
'icon' => 'icon-envelope'
];
}
/**
* Field configuration for the action.
*/
public function defineFormFields()
{
return 'fields.yaml';
}
public function getText()
{
$template = $this->host->template_name;
return 'Send a message using '.$template;
}
/**
* Triggers this action.
* @param array $params
* @return void
*/
public function triggerAction($params)
{
$email = '[email protected]';
$template = $this->host->template_name;
Mail::sendTo($email, $template, $params);
}
}
```
A form fields definition file is used to provide form fields when the action is established. These values are accessed from condition using the host model via the `$this->host` property.
```yaml
# ===================================
# Field Definitions
# ===================================
fields:
template_name:
label: Template name
type: text
```
An action may choose to provide no form fields by simply returning false from the `defineFormFields` method.
```php
public function defineFormFields()
{
return false;
}
```
## Creating Condition classes
A condition class should specify how it should appear in the user interface, providing a name, title and summary text. It also must declare an `isTrue` method for evaluating whether the condition is true or not.
```php
class MyCondition extends \Winter\Notify\Classes\ConditionBase
{
/**
* Return either ConditionBase::TYPE_ANY or ConditionBase::TYPE_LOCAL
*/
public function getConditionType()
{
// If the condition should appear for all events
return ConditionBase::TYPE_ANY;
// If the condition should appear only for some events
return ConditionBase::TYPE_LOCAL;
}
/**
* Field configuration for the condition.
*/
public function defineFormFields()
{
return 'fields.yaml';
}
public function getName()
{
return 'My condition is checked';
}
public function getTitle()
{
return 'My condition';
}
public function getText()
{
$value = $this->host->mycondition;
return 'My condition is '.$value;
}
/**
* Checks whether the condition is TRUE for specified parameters
* @param array $params
* @return bool
*/
public function isTrue(&$params)
{
return true;
}
}
```
A form fields definition file is used to provide form fields when the condition is established. These values are accessed from condition using the host model via the `$this->host` property.
```yaml
# ===================================
# Field Definitions
# ===================================
fields:
mycondition:
label: My condition
type: dropdown
options:
true: True
false: False
```
## Model attribute condition classes
Model attribute conditions are designed specially for applying conditions to sets of model attributes.
```php
class UserAttributeCondition extends \Winter\Notify\Classes\ModelAttributesConditionBase
{
protected $modelClass = \Winter\User\Models\User::class;
public function getGroupingTitle()
{
return 'User attribute';
}
public function getTitle()
{
return 'User attribute';
}
/**
* Checks whether the condition is TRUE for specified parameters
* @param array $params Specifies a list of parameters as an associative array.
* @return bool
*/
public function isTrue(&$params)
{
$hostObj = $this->host;
$attribute = $hostObj->subcondition;
if (!$user = array_get($params, 'user')) {
throw new ApplicationException('Error evaluating the user attribute condition: the user object is not found in the condition parameters.');
}
return parent::evalIsTrue($user);
}
}
```
An attributes definition file is used to specify which attributes should be included in the condition.
```yaml
# ===================================
# Condition Attribute Definitions
# ===================================
attributes:
name:
label: Name
email:
label: Email address
country:
label: Country
type: relation
relation:
model: Winter\Location\Models\Country
label: Name
nameFrom: name
keyFrom: id
```
## Save to database action
There is a dedicated table in the database for storing events and their parameters. This table is accessed using the `Winter\Notify\Models\Notification` model and can be referenced as a relation from your own models. In this example the `MyProject` model contains its own notification channel called `notifications`.
```php
class MyProject extends Model
{
// ...
public $morphMany = [
'my_notifications' => [
\Winter\Notify\Models\Notification::class,
'name' => 'notifiable'
]
];
}
```
This channel should be registered with the `Winter\Notify\NotifyRules\SaveDatabaseAction` so it appears as a related object when selecting the action.
```php
SaveDatabaseAction::extend(function ($action) {
$action->addTableDefinition([
'label' => 'Project activity',
'class' => MyProject::class,
'relation' => 'my_notifications',
'param' => 'project'
]);
});
```
The **label** is shown as the related object, the **class** references the model class, the **relation** refers to the relation name. The **param** defines the parameter name, passed to the triggering event.
So essentially if you pass a `project` to the event parameters, or if `project` is a global parameter, a notification model is created with the parameters stored in the `data` attribute. Equivalent to the following code:
```php
$myproject->my_notifications()->create([
// ...
'data' => $params
]);
```
## Dynamically adding conditions to events
Events can be extended to include new local conditions. Simply add the condition class to the event `$conditions` array property.
```php
UserActivatedEvent::extend(function($event) {
$event->conditions[] = \Winter\UserPlus\NotifyRules\UserLocationAttributeCondition::class;
});
```