README

Introduction

It allows the administration of system notifications through external services such as email servers and push notifications.

Installation

Using Composer

$ composer require kfit/yii2-parameters

Applying migrations

$ php yii migrate --migrationPath=@vendor/kfit/yii2-parameters/migrations

Configuration required in web.php file:

'modules'=>[
   'notifications' => [
        'class' => '\kfit\notifications\Module',
        'methodSendMail' => 'mailrelay',
        'mailrelayConfig' => [
            'apiKey' => '',
            'hostName' => 'midominio.ip-zone.com'
        ],
        'mailerConfig' => [
            'class' => 'yii\swiftmailer\Mailer',
            'transport' => [
                'class' => 'Swift_SmtpTransport',
                'host' => 'mail.midominio.com',
                'username' => 'noreply@midominio.com',
                'password' => '',
                'port' => '587',
                'encryption' => 'tls',
                'streamOptions' => [
                    'ssl' => [
                        'allow_self_signed' => true,
                        'verify_peer' => false,
                        'verify_peer_name' => false,
                    ],
                ]
            ],
        ],
        'onesignalConfig' => [
            'class' => '\rocketfirm\onesignal\OneSignal',
            'appId' => 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx',
            'apiKey' => '',
        ],
    ]
 ],

These initial settings must be added for the module. The position methodSendMail indicates the type of service that will be used to send the emails, this can have two possible values: mailrelay and smtp. Each type of associated service will have a configuration that must be provided in the following way:

For smtp: In the position mailerConfig all the information of the mail server will be supplied as well as the connection driver to it, in our example we will have Swiftmailer, which provides functions for the sending of mails by SMTP.
For mailrelay: En la posición mailrelayConfig se suministra tanto el apikey y el host que provee el servicio de Mailrelay.

Another service that must be configured is the onesignal for handling push notifications. For this we use the onesignal service which will provide us with the application identifier or appId and the apiKey, this information will go in the onesignalConfig position as well as the driver for its connection which by default must be \rocketfirm\onesignal\OneSignal.

Module architecture.

The module uses a simple architecture that is based on two components:

Notifications: It's entities with the information stored in the table notifications of the database. The notifications provide the subject and content of the message plus some metadata necessary for the shipment.
Channels: Channels are objects that provide the necessary interface for sending notifications, each of the channels corresponds to a service, in the case of mailrelay there is a channel Mailrelay.

Advanced configurations.

In the configuration of the module you can also pass some other configurations, then we explain them to you.

Property	Description	Default value
onesignalConfig	Configuration for the push notification service.	[]
mailerConfig	Configuration for the service of emails by SMTP.	[]
mailrelayConfig	Configuration for email service through Mailrelay.	[]
methodSendMail	Method of sending emails, this can be SMTP or Mailrelay.	'smtp'
channels	Configuration of the default channels for the module, these can be modified in order to extend the functionality or create new channels.	{Check the following code for the table}
breadcrumbsBase	Arrange with the breadcrumbs that will be shown in the module.	null
controllerNamespace	Location of the controllers for the module.	'kfit\notifications\controllers'

[
    'smtp' => [
        'class' => 'kfit\notifications\components\channels\EmailChannel'
    ],
    'onesignal' => [
        'class' => 'kfit\notifications\components\channels\OnesignalChannel'
    ],
    'mailrelay' => [
        'class' => 'kfit\notifications\components\channels\MailRelayChannel'
    ],
    'sms' => [
        'class' => 'kfit\notifications\components\channels\SMSChannel'
    ],
]

License

BSD-3-Clause. Created by: KulturFit Developer Team.

kfit / yii2-notifications

Maintainers

Details