I need more examples about notify-plugin

[LukeTowers]

Registering event listeners for the plugin in Plugin.php -> boot():

\RainLab\Notify\Classes\Notifier::bindEvents([
    'captive.xm.shifts.staffmember.add' => \Captive\XM\Classes\Notify\Events\StaffAdded::class,
    'captive.xm.shifts.staffmember.remove' => \Captive\XM\Classes\Notify\Events\StaffRemoved::class
]);

Registering the custom plugin's support for the notify plugin in custom plugin's Plugin.php:

public function registerNotificationRules()
    {
        return [
            'events' => [
                \Captive\XM\Classes\Notify\Events\StaffAdded::class,
                \Captive\XM\Classes\Notify\Events\StaffRemoved::class,
            ],
            'actions' => [
                \Captive\XM\Classes\Notify\Actions\SendEmail::class,
                \Captive\XM\Classes\Notify\Actions\SendSMS::class,
            ],
            'conditions' => [],
            'groups' => [
                'shifts' => [
                    'label' => 'Shifts',
                    'icon' => 'icon-calendar'
                ],
            ],
            'presets' => '$/captive/xm/classes/notify/presets.yaml',
        ];
    }

presets.yaml

# ===================================
#  Event Presets
# ===================================

member_added:
    name: Member has been added to a shift
    event: Captive\XM\Classes\Notify\Events\StaffAdded
    items:
        - action: Captive\XM\Classes\Notify\Actions\SendSMS
          template: 'You are assigned to {{ shiftName }} - {{ eventName }} as a {{ role }} for {{ date }}. Details at {{ url }}'
        - action: Captive\XM\Classes\Notify\Actions\SendEmail
          mail_template: captive.xm::mail.shift.member_added
          file_name: myshift.ics
    conditions:
        - condition: RainLab\Notify\NotifyRules\ExecutionContextCondition
          subcondition: environment
          operator: is
          value: prod
          condition_text: Application environment <span class="operator">is</span> prod
member_removed:
    name: Member has been removed from a shift
    event: Captive\XM\Classes\Notify\Events\StaffRemoved
    items:
        - action: Captive\XM\Classes\Notify\Actions\SendSMS
          template: You have been removed from {{ shiftName }} - {{ eventName }} for {{ date }}.
        - action: Captive\XM\Classes\Notify\Actions\SendEmail
          mail_template: captive.xm::mail.shift.member_removed
    conditions:
        - condition: RainLab\Notify\NotifyRules\ExecutionContextCondition
          subcondition: environment
          operator: is
          value: prod
          condition_text: Application environment <span class="operator">is</span> prod

SendEmail.php action:

<?php namespace Captive\XM\Classes\Notify\Actions;

use Mail;
use System\Models\MailTemplate;

class SendEmail extends \RainLab\Notify\Classes\ActionBase
{
    /**
     * Returns information about this event, including name and description.
     */
    public function actionDetails()
    {
        return [
            'name'        => 'Send an email',
            'description' => 'Send an email to a staff member',
            'icon'        => 'icon-envelope-o'
        ];
    }

    /**
     * Field configuration for the action.
     */
    public function defineFormFields()
    {
        return 'fields.yaml';
    }

    public function getText()
    {
        $template = $this->host->mail_template;

        return 'Send a message using template: ' . $template;
    }

    public function getMailTemplateOptions()
    {
        $codes = array_keys(MailTemplate::listAllTemplates());
        return array_combine($codes, $codes);;
    }

    /**
     * Triggers this action.
     * @param array $params
     * @return void
     */
    public function triggerAction($params)
    {
        $emailCode = $this->host->mail_template;
        $fileName  = $this->host->file_name;
        $staffMember = $params['staffmember'];
        $mailData = $params['mailData'];
        $fileData = $params['fileData'];

        Mail::queue($emailCode, $mailData, function ($message) use ($staffMember, $fileData, $fileName) {
            $message->to($staffMember->email, $staffMember->full_name);
            if (!empty($fileData)) {
                $message->attachData($fileData, $fileName);
            }
        });
    }
}

SendEmail.php fields.yaml:

fields:
    mail_template:
        label: Mail template
        type: dropdown
        placeholder: Select template
    file_name:
        label: File Name
        type: text
        placeholder: The attached file name

StaffRemoved.php Event:

<?php namespace Captive\XM\Classes\Notify\Events;

class StaffRemoved extends \RainLab\Notify\Classes\EventBase
{
    /**
     * Returns information about this event, including name and description.
     */
    public function eventDetails()
    {
        return [
            'name'        => 'Staff member removed',
            'description' => 'Fired when a staff member has been removed from a shift',
            'group'       => 'shifts'
        ];
    }

    /**
     * Defines the usable parameters provided by this class.
     */
    public function defineParams()
    {
        return [
            'name' => [
                'title' => 'Name',
                'label' => 'Name of the staff member',
            ],
            'shiftName' => [
                'title' => 'Shift',
                'label' => 'Name of the shift',
            ],
            'eventName' => [
                'title' => 'Event',
                'label' => 'Name of the event',
            ],
            'role' => [
                'title' => 'Role',
                'label' => 'Name of the role',
            ],
            'date' => [
                'title' => 'Start time',
                'label' => "The shift's start time",
            ],
            'url' => [
                'title' => 'URL',
                'label' => 'The URL for the shift',
            ],
        ];
    }

    public static function makeParamsFromEvent(array $args, $eventName = null)
    {
        return [
            'shiftslot'     => array_get($args, 0),
            'staffmember'   => array_get($args, 1),
            'mailData'      => array_get($args, 2),
            'fileData'      => null,
        ];
    }
}

captive.xm.shifts.staffmember.remove event fired in the ShiftSlot model:

Event::fire('captive.xm.shifts.staffmember.remove', [$this, $member, $data]);

[XIOLog]

Thank you, Luke :-)

Almost got it.

Answer 2 more questions, please.

1. How do I send mail to all employees of the company so that they do not see each other?
2. How can I make a record in my own database table?

[LukeTowers]

If the content of all the emails is the same then add each address as a BCC recipient.

How can I make a record in my own database table?

No idea what you mean by that and it seems like such a basic question that this isn't the right place to ask it.

[XIOLog]

I will outline the situation.

I have a job site. The vacancy has a button "Respond to the vacancy".

I need to save vacancy ID and CV ID to a database. Then, send letters to the job seeker (URL of the vacancy) and to all employees of the company (URL of the resume of the job seeker).

How can I do this? Maybe you can give me a hint?

[LukeTowers]

Take a look at existing plugins for managing job listings: https://octobercms.com/plugins?search=job. It's also not that difficult to just create your own using the Builder plugin if you're comfortable doing some custom development as well.

[XIOLog]

Thank you, Luke. You always help me out :-)

[LukeTowers]

This plugin is probably not a good fit for what you're trying to do, custom development or those other plugins would be a better fit. This is a plugin that other developers can integrate their plugins with to offload the responsibility of notification management onto, not really a plugin meant to handle the notification rules for one-off site-specific plugins, since that's usually much easier to handle just by writing a small amount of custom code to handle whatever notifications you need directly.

Thank you, Luke. You always help me out :-)

Consider supporting me by sponsoring me through GitHub 😉