From ff548f9aecfa69be1363e1eaa514a543f26d0fe8 Mon Sep 17 00:00:00 2001 From: Marek Bartos Date: Sat, 21 Apr 2018 23:08:58 +0200 Subject: [PATCH] Restructured docs --- .docs/{application.md => README.md} | 19 ++++++++-- .docs/security.md | 57 ----------------------------- README.md | 5 ++- 3 files changed, 19 insertions(+), 62 deletions(-) rename .docs/{application.md => README.md} (75%) delete mode 100644 .docs/security.md diff --git a/.docs/application.md b/.docs/README.md similarity index 75% rename from .docs/application.md rename to .docs/README.md index de61b84..de5a789 100644 --- a/.docs/application.md +++ b/.docs/README.md @@ -1,9 +1,9 @@ -# Event Dispatcher > Nette Application Bridge +# Event Dispatcher Extra :recycle: ## Content :gift: - [Usage - how to register](#usage-tada) -- [Bridge - nette application](#bridge-wrench) +- [Bridge - events list](#bridge-wrench) - [Command - example command](#subscriber-bulb) ## Usage :tada: @@ -12,11 +12,14 @@ extensions: events: Contributte\EventDispatcher\DI\EventDispatcherExtension events2application: Contributte\Events\Extra\Application\DI\EventApplicationBridgeExtension + events2security: Contributte\Events\Extra\Security\DI\EventSecurityBridgeExtension ``` ## Bridge :wrench: -There are several Nette Application events on which you can listen to. +There are several events on which you can listen to. + +**Nette Application events:** ```php use Contributte\Events\Extra\Application\Event\ApplicationEvents; @@ -35,6 +38,16 @@ use Contributte\Events\Extra\Application\Event\StartupEvent; - `ResponseEvent::NAME` && `ApplicationEvents::ON_RESPONSE` - `ErrorEvent::NAME` && `ApplicationEvents::ON_ERROR` +**Nette Security events:** + +```php +use Contributte\Events\Extra\Security\Event\LoggedInEvent; +use Contributte\Events\Extra\Security\Event\LoggedOutEvent; +``` + +- `LoggedInEvent::NAME` && `SecurityEvents::ON_LOGGED_IN` +- `LoggedOutEvent::NAME` && `SecurityEvents::ON_LOGGED_OUT` + ## Subscriber :bulb: ```php diff --git a/.docs/security.md b/.docs/security.md deleted file mode 100644 index 0a0825d..0000000 --- a/.docs/security.md +++ /dev/null @@ -1,57 +0,0 @@ -# Event Dispatcher > Nette Security Bridge - -## Content :gift: - -- [Usage - how to register](#usage-tada) -- [Bridge - nette application](#bridge-wrench) -- [Command - example command](#subscriber-bulb) - -## Usage :tada: - -```yaml -extensions: - events: Contributte\EventDispatcher\DI\EventDispatcherExtension - events2security: Contributte\Events\Extra\Security\DI\EventSecurityBridgeExtension -``` - -## Bridge :wrench: - -There are several Nette Security events on which you can listen to. - -```php -use Contributte\Events\Extra\Security\Event\LoggedInEvent; -use Contributte\Events\Extra\Security\Event\LoggedOutEvent; -``` - -- `LoggedInEvent::NAME` && `SecurityEvents::ON_LOGGED_IN` -- `LoggedOutEvent::NAME` && `SecurityEvents::ON_LOGGED_OUT` - -## Subscriber :bulb: - -```php -use Contributte\EventDispatcher\EventSubscriber; -use Contributte\Events\Extra\Security\Event\LoggedInEvent; -use Contributte\Events\Extra\Security\Event\SecurityEvents; - -final class LoggedInSubscriber implements EventSubscriber -{ - - /** - * @return array - */ - public static function getSubscribedEvents() - { - return [SecurityEvents::ON_LOGGED_IN => 'onLoggedIn']; - } - - /** - * @param LoggedInEvent $event - * @return void - */ - public function onLoggedIn(LoggedInEvent $event) - { - // do magic - } - -} -``` diff --git a/README.md b/README.md index 28ab721..d232b5f 100644 --- a/README.md +++ b/README.md @@ -33,8 +33,9 @@ composer require contributte/event-dispatcher-extra ## Overview -- [Nette/Application bridge](https://github.com/contributte/event-dispatcher-extra/blob/master/.docs/application.md#usage-tada) -- [Nette/Security bridge](https://github.com/contributte/event-dispatcher-extra/blob/master/.docs/security.md#usage-tada) +- [Usage - how to register](https://github.com/contributte/event-dispatcher-extra/blob/master/.docs/README.md#usage-tada) +- [Bridge - events list](https://github.com/contributte/event-dispatcher-extra/blob/master/.docs/README.md#bridge-wrench) +- [Command - example command](https://github.com/contributte/event-dispatcher-extra/blob/master/.docs/README.md#subscriber-bulb) ## Maintainers