Files
yii2-usuario/docs/index.md
Antonio Ramirez c19646bf74 update docs
2017-06-12 13:27:02 +02:00

5.1 KiB

Yii2 Usuario Extension

Documentation Status Join the chat at https://gitter.im/2amigos/yii2-usuario Packagist Version Latest Stable Version Total Downloads Latest Unstable Version
Scrutinizer Code Quality

Yii 2 usuario is a highly customizable and extensible user management, RBAC management, authentication, and authorization Yii2 module extension.

It works extensively with Yii's Container making it really easy to override absolutely anything within its core. The module is built to work out of the box with some minor config tweaks and it comes with the following features:

  • Backend user/profile/account management
  • Backend RBAC management
  • Login via username/email + password process
  • Login via social network process
  • Password recovery process

Getting Started

This extension has been built to be working out of the box, that is, after you install its migrations and configure the module on your application structure, you should be set to go.

Step 1 - Download

You can download it and place it on your third party libraries folder but we highly recommend that you install it through composer.

Either run

$ composer require 2amigos/yii2-usuario:~1.0

or add

"2amigos/yii2-usuario": "~1.0"

to the require section of your composer.json file.

Step 2 - Apply database schema migrations

This is obvious extension like our which deals with users, roles, permissions, etc. have to use some database. Our migrations are namespaced and available in Da\User\Migration namespace.

Before starting to work with database, please ensure you have deleted m130524_201442_init.php migration file which comes from the default installation of the Advanced Application Template. It's located at %PROJECT_DIR%/console/migrations/m130524_201442_init.php path.

There are two ways to apply migrations of this extension, the first one:

./yii migrate --migrationPath="@Da/User/Migration"
./yii migrate

First command applies migration set of the user module, and the second one is for application migrations.

Note, you cannot mix two ways: choose one of them, and stick with it.

The second way is more comfortable, and you don't have to remember to launch first command every time you obtain new version of our extension. First of all add the following lines to the file %PROJECT_DIR%/console/config/main.php:

return [
    // ...
    'controllerMap' => [
        'migrate' => [
            'class' => \yii\console\controllers\MigrateController::class,
            'migrationNamespaces' => [
                'Da\User\Migration',
            ],
        ],
    ],
    // ...
];

This basically instructs your application to always try to use migrations from the given namespace. Which again is very convenient way to track new migration classes coming from this and possibly other extensions and sources.

Namespaced migrations were introduced in Yii 2.0.10, so before using them consider updating your framework installation version.

Step 3 - Configure

Once we have it installed, we have to configure it on your config.php file.

'modules' => [
    'user' => [
        'class' => Da\User\Module::class,
    ]
]

Configuration may differ from template to template, the following are some guidelines for sidekit app template and the official Yii2 advanced application template:

See also all the possible configuration options available:

Enhancing and Overriding

Helpful Guides

Contributing

© 2amigos 2013-2017