Skip to content

Commit

Permalink
Expand usage documentation for each action class
Browse files Browse the repository at this point in the history
  • Loading branch information
josegonzalez committed Dec 3, 2016
1 parent ad26084 commit a74cd56
Showing 1 changed file with 68 additions and 12 deletions.
80 changes: 68 additions & 12 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -29,42 +29,98 @@ The table holding your user schema and data should contain these fields:

## Features

- LoginAction (beforeLogin, afterLogin, beforeRender), use it:
### Crud Action Classes

```
The following action classes can be mapped

#### LoginAction

Enable it via:

```php
$this->Crud->mapAction('login', 'CrudUsers.Login');
```

- LogoutAction (beforeLogout, afterLogout)
Triggers:

```
- beforeLogin
- afterLogin
- beforeRender

#### LogoutAction

Enable it via:

```php
$this->Crud->mapAction('logout', 'CrudUsers.Logout');
```

- RegisterAction (beforeRegister, afterRegister)
Triggers:

```
- beforeLogout
- afterLogout

#### RegisterAction

Enable it via:

```php
$this->Crud->mapAction('register', 'CrudUsers.Register');
```

- ForgotPasswordAction (beforeForgotPassword, afterForgotPassword)
Triggers:

```
- beforeRegister
- afterRegister

#### ForgotPasswordAction

Enable it via:

```php
$this->Crud->mapAction('forgotPassword', 'CrudUsers.ForgotPassword');
```

- ResetPasswordAction (beforeRender, beforeFind, afterFind, verifyToken, beforeSave, afterSave, afterResetPassword)
Triggers:

```
- beforeForgotPassword
- afterForgotPassword

#### ResetPasswordAction

Enable it via:

```php
$this->Crud->mapAction('resetPassword', 'CrudUsers.ResetPassword');
```

- VerifyAction (beforeFind, afterFind, verifyToken, beforeSave, afterSave, afterVerify)
Triggers:

```
- beforeRender
- beforeFind
- afterFind
- verifyToken
- beforeSave
- afterSave
- afterResetPassword

#### VerifyAction

Enable it via:

```php
$this->Crud->mapAction('verify', 'CrudUsers.Verify');
```

Triggers:

- beforeFind
- afterFind
- verifyToken
- beforeSave
- afterSave
- afterVerify

# Bugs

If you happen to stumble upon a bug, please feel free to create a pull request with a fix
Expand Down

0 comments on commit a74cd56

Please sign in to comment.