diff --git a/docs/index.md b/docs/index.md index 9806b91..95cfea6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -121,6 +121,7 @@ See also all the possible configuration options available: - [RBAC](installation/rbac.md) - [Console Commands](installation/console-commands.md) - [Mailer](installation/mailer.md) +- [Available Actions](installation/available-actions.md) Enhancing and Overriding ------------------------ diff --git a/docs/installation/available-actions.md b/docs/installation/available-actions.md new file mode 100644 index 0000000..05c2c89 --- /dev/null +++ b/docs/installation/available-actions.md @@ -0,0 +1,66 @@ +Available Actions +================= + +The following is the list of action provided by the module: + +- **/user/registration/register** Displays registration form +- **/user/registration/resend** Displays resend form +- **/user/registration/confirm** Confirms a user (requires *id* and *token* query params) +- **/user/security/login** Displays login form +- **/user/security/logout** Logs the user out (available only via POST method) +- **/user/recovery/request** Displays recovery request form +- **/user/recovery/reset** Displays password reset form (requires *id* and *token* query params) +- **/user/settings/profile** Displays profile settings form +- **/user/settings/account** Displays account settings form (email, username, password) +- **/user/settings/networks** Displays social network accounts settings page +- **/user/profile/show** Displays user's profile (requires *id* query param) +- **/user/admin/index** Displays user management interface +- **/user/admin/create** Displays create user form +- **/user/admin/update** Displays update user form (requires *id* query param) +- **/user/admin/update-profile** Displays update user's profile form (requires *id* query param) +- **/user/admin/info** Displays user info (requires *id* query param) +- **/user/admin/assignments** Displays rbac user assignments (requires *id* query param) +- **/user/admin/confirm** Confirms a user (requires *id* query param) +- **/user/admin/delete** Deletes a user (requires *id* query param) +- **/user/admin/block** Blocks a user (requires *id* query param) +- **/user/admin/switch-identity** Switch identities between the current admin and user on list +- **/user/role/index** Displays rbac roles management interface +- **/user/role/create** Displays create rbac role form +- **/user/role/update** Displays update rbac role form (requires *name* query param) +- **/user/role/delete** Deletes a rbac role (requires *name* query param) +- **/user/permission/index** Displays rbac permissions management interface +- **/user/permission/create** Displays create rbac permission form +- **/user/permission/update** Displays update rbac permission form (requires *name* query param) +- **/user/permission/delete** Deletes a rbac permission (requires *name* query param) +- **/user/rule/index** Displays rbac permissions management interface +- **/user/rule/create** Displays create rbac rule form +- **/user/rule/update** Displays update rbac rule form (requires *name* query param) +- **/user/rule/delete** Deletes a rbac rule (requires *name* query param) + +The module overrides some to make it simpler: + +```php +'' => 'profile/show', +'' => 'security/', +'' => 'registration/', +'confirm//' => 'registration/confirm', +'forgot' => 'recovery/request', +'recover//' => 'recovery/reset' +``` + +So they become: + +- **/user/{id}** Displays user's profile (requires *id* query param) +- **/user/login** Displays login form +- **/user/logout** Logs out a user +- **/user/register** Displays registration form +- **/user/resend** Displays resend form +- **/user/confirm/{id}/{token}** Confirms a user (requires *id* and *token* query params) +- **/user/forgot** Displays recovery request form +- **/user/recover/{id}/{token}** Displays password reset form (requires *id* and *token* query params) + + +You can override them by setting the module's routes to an empty array. Then, configure the routes as you please. + + +© [2amigos](http://www.2amigos.us/) 2013-2017