README

特性

1. 注册
2. 登录
3. 注销
4. 激活账户
5. 锁定账户
6. 删除账户
7. 更改密码

注册

要注册用户，您使用注册方法，只需三个参数。具体来说

1. 电子邮件
2. 密码
3. verifyPassword

在注册用户时，您可以通过在配置设置中将 auto_login 设置为 true 来在注册后自动登录。

    // calling it as a registered service
    $auth = app()->load('auth');
    
    // registering a user
    $auth->register(
        'example@email.com',
        'password',
        'password'
    );
    
    // If auto_login is not enabled then you can login manually
    $auth->login(
        'example@email.com',
        'password'
    );

登录

login 方法用于登录用户。要在用户登录后自动重定向，您需要在配置设置中将 auto_redirect 设置为 true。

        // calling it as a registered service
        $auth = app()->load('auth');
        
        // log user in
        $auth->login(
            'example@email.com',
            'password'
        );

注销

    $auth = app()->load('auth');
    $auth->logout();

激活账户

要激活账户，您需要使用 activateAccount 方法。此方法只需一个参数，即用户的确认码。默认情况下，用户的账户在注册时不会被激活，但您可以通过在配置设置中将 auto_activate 设置为 true 来允许自动激活。

        
        // calling as registered service
        $auth = app()->load('auth');
        
        $confirmation_code = '********';
        $auth->activateAccount($confirmation_code);

锁定账户

要锁定账户，您需要使用 blockAccount 方法。此方法只需一个参数，可以是用户的电子邮件或用户ID。

        // calling as registered service
        $auth = app()->load('auth');
        
        // Blocking account using email
        $auth->blockAccount(
            'user@email.com'
        );
        
        // Blocking account using id
        $userId = 5;
        $auth->blockAccount($userId);

解锁账户

要解锁账户，您需要使用 unblockAccount 方法。此方法只需一个参数，可以是用户的电子邮件或用户ID，就像 blockAccount 方法一样。

        // calling as registered service
        $auth = app()->load('auth');
        
        // Blocking account using email
        $auth->unblockAccount(
            'user@email.com'
        );
        
        // Blocking account using id
        $userId = 5;
        $auth->unblockAccount($userId);

删除账户

要删除账户，使用 deleteAccount 方法。它需要一个参数，可以是用户的电子邮件或用户ID。如果账户成功删除，该方法返回 true。

        // calling as registered service
        $auth = app()->load('auth');
        
        // Delete account using email
        $auth->deleteAccount(
            'user@email.com'
        );
        
        // Delete account using id
        $userId = 5;
        $auth->deleteAccount($userId);

更改密码

要更新用户的密码，您可以使用 changePassword 方法。该方法需要两个参数，即

1. 旧密码
2. 新密码

第一个参数（旧密码）必须是用户的当前密码，第二个参数（新密码）必须是新密码。如果密码成功更改，该方法返回 true。

        // calling as registered service
        $auth = app()->load('auth');
        
        $oldPassword = 'old-password';
        $newPassword = 'new-password';
        
        $auth->changePassword(
            $oldPassword,
            $newPassword
        );