README

Installation

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

$ composer require artox-lab/clarc-notification-bundle

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require artox-lab/clarc-notification-bundle

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

// config/bundles.php

return [
    // ...
    ArtoxLab\Bundle\ClarcNotificationBundle\ArtoxLabClarcNotificationBundle::class => ['all' => true],
];

Usage

You need to implement in your application:

use App\Entities\Notification\ExampleNotification;
use ArtoxLab\Bundle\ClarcNotificationBundle\Notification\Entities\Notifier\NotifierInterface;
use ArtoxLab\Bundle\ClarcNotificationBundle\Notification\Entities\Recipient\EmailRecipient;
use ArtoxLab\Bundle\ClarcNotificationBundle\Notification\Entities\Recipient\SmsRecipient;

class Example
{

    /**
    * Notifier
    *
    * @var NotifierInterface
    */
    private $notifier;
    
    /**
    * Example constructor.
    * 
    * @param NotifierInterface $notifier Notifier
    */
    public function __construct(NotifierInterface $notifier) 
    {
        $this->notifier = $notifier;
    }
    
    /**
    * Notify example
    * 
    * @return void
    */
    public function notify(): void 
    {
        $notification   = new ExampleNotification('test');
        $smsRecipient   = new SmsRecipient('+123123123');
        $emailRecipient = new EmailRecipient('test@example.com');
        
        $this->notifier->notify($notification, $smsRecipient, $emailRecipient);
    }

}

artox-lab / clarc-notification-bundle

Maintainers

Details