fixes + add events documentation

This commit is contained in:
Antonio Ramirez
2017-06-13 00:01:30 +02:00
parent 9f4a29941c
commit 692358adb6
6 changed files with 107 additions and 8 deletions

View File

@ -0,0 +1,47 @@
Social Network Connect Events
=============================
The following is the list of the social network connection events and where they happen:
On Controllers
--------------
- **RegistrationController**
- **SocialNetworkConnectEvent::EVENT_BEFORE_CONNECT**: Occurs before a user's social network has been connected
- **SocialNetworkConnectEvent::EVENT_AFTER_CONNECT**: Occurs after a user's social network has been connected
- **SettingsController**
- **SocialNetworkConnectEvent::EVENT_BEFORE_DISCONNECT**: Occurs before a user is disconnecting a social network
- **SocialNetworkConnectEvent::EVENT_AFTER_DISCONNECT**: Occurs after a a user is disconnecting a social network
How to Work With Social Network Connect Events
----------------------------------------------
This event when triggered will contain a `Da\User\Model\User` model instance and also a
`Da\User\Model\SocialNetworkAccount` instance. For example:
```php
<?php
// events.php file
use Da\User\Controller\RegistrationController;
use Da\User\Event\SocialNetworkConnectEvent;
use yii\base\Event;
Event::on(
RegistrationController::class,
SocialNetworkConnectEvent::EVENT_BEFORE_CONNECT,
function (SocialNetworkConnectEvent $event) {
$user = $event->getUser(); // $token is a Da\User\Model\User instance
$account = $event->getAccount(); // $account is a Da\User\Model\SocialNetworkAccount
// ... your logic here
});
```
© [2amigos](http://www.2amigos.us/) 2013-2017