php-solution/notification

Library for create notify functionality

Notification component

Notification component helps developer to create functionality for send notification system., _(*1)

Concept

Parts of logic:

• Context
• Manager
• Extension
• Type
• Rule
• Notifier

Main Flow:

1) Client create Context and set some parameter for notification, specify Type of notification(string name or object) and send this info to Manager, _(*2)

$type = new NotificationType();
$context = new Context(['parameter' => 'parameter value']);
$notificationManager->notifyType($type, $context);

or, _(*3)

$context = new Context(['parameter' => 'parameter value']);
$notificationManager->notifyType(NotificationType::getName(), $context);

2) Manager prepare Type and Context via Extension(if Extension is specified for Manager) 3) Type build Rule/Rules(some simple info for Notifier) 4) Notifier accept Rule(parameters) and send real notification. For example: Email Notifier accept parameters(Rule) for email sending(from, to, cc,text) and send via smtp mail, _(*4)

Manager

This is a service for send notification, has 2 public methods for send notification: * notify(string $name, Context $context = null) - will get Type from TypeRegistry * notifyType(TypeInterface $type, Context $context = null) - use accepted Type, _(*5)

Extension

Implements functionality for prepare Type, Context info before build Rules, _(*6)

Context

Some value object of parameters for Type, _(*7)

Type

Rule builder, _(*8)

Rule

Some value object of parameters for Notifier, _(*9)

Notifier

Implements functionality for real notification sending, _(*10)

Installing

1. Add to your composer.json

    "require": {
        ...
        "php-solution/notification": "dev-master",
        ...
    }    

2) run:, _(*11)

    composer update php-solution/notification

Examples:

• basic usage: link
• use Symfony context configurator extension, for resolve context parameters link
• use Symfony Event dispatcher extension link