Files

Carsten Brandt a6ba4b2208 Update first-steps.md (#389 )

Add missing step for deleting the administrator role.

2020-07-16 07:44:38 +02:00

3.7 KiB

Raw Blame History

First steps to use Yii2-usuario

After installing the extension and having configured everything, you need setup your application with the all the user related stuff, e.g.

creating first users, roles, permissions, ...
assigning permissions and roles to users
extending your controllers with access restrictions
starting user management

Creating your first user

There are several ways to do that:

using migrations
using the Command line Console Commands

Creating the first Administrator during a migration

This is helpful e.g. when using you Yii2 applicatio with Docker and need to start the Docker Container with basic user settings.

We will create an adminuser with a adminisrator role.

Put this in your migration:

class m... extends Migration
{
    public function safeUp()
    {
        $auth = Yii::$app->authManager;
            
        // create a role named "administrator"
        $administratorRole = $auth->createRole('administrator');
        $administratorRole->description = 'Administrator';
        $auth->add($administratorRole);

        // create permission for certain tasks
        $permission = $auth->createPermission('user-management');
        $permission->description = 'User Management';
        $auth->add($permission);

        // let administrators do user management
        $auth->addChild($administratorRole, $auth->getPermission('user-management'));

        // create user "admin" with password "verysecret"
        $user = new \Da\User\Model\User([
            'scenario' => 'create', 
            'email' => "email@example.com", 
            'username' => "admin", 
            'password' => "verysecret"  // >6 characters!
        ]);
        $user->confirmed_at = time();
        $user->save();
        
        // assign role to our admin-user
        $auth->assign($administratorRole, $user->id);
    }

    public function safeDown()
    {
        $auth = Yii::$app->authManager;

        // delete permission
        $auth->remove($auth->getPermission('user-management'));

        // delete admin-user and administrator role
        $administratorRole = $auth->getRole("administrator");
        $user = \Da\User\Model\User::findOne(['name'=>"admin"]);
        $auth->revoke($administratorRole, $user->id);
        $user->delete();
        $auth->remove($administratorRole);
    }

User Management

Having setup the admin user you can start using user management at

http://yourapp/index.php?r=user/admin

You should be prompted a login screen and the enter admin/verysecret.

Working with authentication

Usually access restrictions to controller actions care specified in behaviors().

Additionally, in your code you can directly use permission checks. This is helpful e.g. in ./views/layouts/main.php.

Examples:

// Is current user a guest (not signed in?)
if (Yii::$app->user->isGuest) {
    ...
}

// Get roles of user
$roles = Yii::$app->authManager->getRolesByUser(Yii::$app->user->getId());

// Does current user have permission to do "user-management"?
if (Yii::$app->user->can("user-management")) {
    ...
}

3.7 KiB Raw Blame History