phant/notifier

Manage notifications easily

0.1 2023-01-13 12:59 UTC

Requires

• php: >=8.1
• phant/data-structure: 4.*
• phant/email-sender: 2.*

Requires (Dev)

• friendsofphp/php-cs-fixer: 3.*
• phpstan/phpstan: 1.*
• phpunit/phpunit: 9.*

MIT

• Lenny ROUANET

• notification manager
• notification service
• notification component
• notification sender
• notifier manager
• notifier component
• notifier service
• notifier sender

README

Requirements

PHP >= 8.1

Install

composer require phant/notifier

Usages

use Phant\Notifier\Service\Handler as NotifierHandler;
use Phant\Notifier\Entity\Notification\Action as NotificationAction;
use Phant\Notifier\Entity\Notification\Type as NotificationType;
use Phant\Notifier\Factory\Notification as NotificationFactory;
use Phant\Notifier\Factory\Notification\Content as NotificationContentFactory;
use Phant\Notifier\Entity\Transport\Channel;
use Phant\Notifier\Entity\Transport\Collection as NotifierTransportCollection;
use Phant\Notifier\Entity\Transport\Email as NotifierTransportEmail;
use App\EmailBuilder;
use App\EmailSender;

$notifierHandler = new NotifierHandler(
	(new NotifierTransportCollection())
		->add(
			new NotifierTransportEmail(
				new EmailBuilder(),
				new EmailSender(),
				'[e-mail]',
				'Best app'
			)
		)
);

$notifierHandler->dispatch(
	NotificationFactory::make(
		NotificationType::Information,
		NotificationContentFactory::make(
			'Hello world!',
			'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.',
			[
				'Foo' => 'Bar'
			]
		),
		new NotificationAction(
			'https://domain.ext/path',
			'Action'
		),
		'[e-mail]'
		Channel::Email
	)
);