Auth

Testing Is Documentation

tests/Auth/ManagerTest.phpAuth - 图1

QueryPHP 提供了一组简单的认证组件用于登陆验证，通常我们使用代理 \Leevel\Auth\Proxy\Auth 类进行静态调用。

内置支持的认证驱动类型包括 session、token，分别用于 web 和 api 的认证服务。

使用方式

使用容器 auths 服务

  1. \App::make('auths')->login(array $data, ?int $loginTime = null): void;

依赖注入

  1. class Demo
  2. {
  3.     private \Leevel\Auth\Manager $auth;
  5.     public function __construct(\Leevel\Auth\Manager $auth)
  6.     {
  7.         $this->auth = $auth;
  8.     }
  9. }

使用静态代理

  1. \Leevel\Auth\Proxy\Auth::login(array $data, ?int $loginTime = null): void;

auth 配置

系统的 auth 配置位于应用下面的 option/auth.php 文件。

可以定义多个认证连接，并且支持切换，每一个连接支持驱动设置。

  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of the your app package.
  7.  *
  8.  * The PHP Application For Code Poem For You.
  9.  * (c) 2018-2099 http://yourdomian.com All rights reserved.
  10.  *
  11.  * For the full copyright and license information, please view the LICENSE
  12.  * file that was distributed with this source code.
  13.  */
  15. return [
  16.     /*
  17.      * ---------------------------------------------------------------
  18.      * 默认认证类型
  19.      * ---------------------------------------------------------------
  20.      *
  21.      * 这里可以是 web 或者 api
  22.      */
  23.     'default' => 'api',
  25.     /*
  26.      * ---------------------------------------------------------------
  27.      * 默认 WEB 驱动
  28.      * ---------------------------------------------------------------
  29.      *
  30.      * WEB 认证驱动连接
  31.      */
  32.     'web_default' => 'session',
  34.     /*
  35.      * ---------------------------------------------------------------
  36.      * 默认 API 驱动
  37.      * ---------------------------------------------------------------
  38.      *
  39.      * API 认证驱动连接
  40.      */
  41.     'api_default' => 'token',
  43.     /*
  44.      * ---------------------------------------------------------------
  45.      * auth 连接参数
  46.      * ---------------------------------------------------------------
  47.      *
  48.      * 这里为所有的 auth 的连接参数，每一种不同的驱动拥有不同的配置
  49.      * 虽然有不同的驱动，但是在验证使用上却有着一致性
  50.      */
  51.     'connect' => [
  52.         'session' => [
  53.             // driver
  54.             'driver' => 'session',
  56.             // token
  57.             'token' => 'token',
  58.         ],
  60.         'token' => [
  61.             // driver
  62.             'driver' => 'token',
  64.             // token
  65.             'token' => null,
  67.             // input token
  68.             'input_token' => 'token',
  69.         ],
  70.     ],
  71. ];

auth 参数根据不同的连接会有所区别，通用的 auth 参数如下：

配置项配置描述
web_defaultWEB 认证驱动连接
api_defaultAPI 认证驱动连接

Uses

  1. <?php
  3. use Leevel\Auth\Manager;
  4. use Leevel\Cache\File as CacheFile;
  5. use Leevel\Di\Container;
  6. use Leevel\Di\IContainer;
  7. use Leevel\Http\Request;
  8. use Leevel\Option\Option;
  9. use Leevel\Session\File as SessionFile;

认证基本使用

login 原型

  1. # Leevel\Auth\IAuth::login
  2. /**
  3.  * 登录写入数据.
  4.  */
  5. public function login(array $data, ?int $loginTime = null): void;

$loginTime 过期时间规则如下：

  • null 表示默认登陆缓存时间
  • 小与等于 0 表示永久缓存
  • 其它表示缓存多少时间，单位
  1. public function testBaseUse(): void
  2. {
  3.     $manager = $this->createManager();
  5.     $this->assertFalse($manager->isLogin());
  6.     $this->assertSame([], $manager->getLogin());
  8.     $this->assertNull($manager->login(['foo' => 'bar', 'hello' => 'world'], 10));
  10.     $this->assertTrue($manager->isLogin());
  11.     $this->assertSame(['foo' => 'bar', 'hello' => 'world'], $manager->getLogin());
  13.     $this->assertNull($manager->logout());
  15.     $this->assertFalse($manager->isLogin());
  16.     $this->assertSame([], $manager->getLogin());
  17. }

setTokenName 设置认证名字

  1. public function testWithToken(): void
  2. {
  3.     $manager = $this->createManagerWithToken();
  5.     $manager->setTokenName('token');
  7.     $this->assertFalse($manager->isLogin());
  8.     $this->assertSame([], $manager->getLogin());
  10.     $this->assertNull($manager->login(['foo' => 'bar', 'hello' => 'world'], 10));
  12.     $this->assertTrue($manager->isLogin());
  13.     $this->assertSame(['foo' => 'bar', 'hello' => 'world'], $manager->getLogin());
  15.     $this->assertNull($manager->logout());
  17.     $this->assertFalse($manager->isLogin());
  18.     $this->assertSame([], $manager->getLogin());
  19. }

setDefaultConnect 设置默认驱动

  1. public function testSetDefaultDriver(): void
  2. {
  3.     $manager = $this->createManagerWithTokenAndSession();
  5.     $manager->setDefaultConnect('token');
  7.     $manager->setTokenName('token');
  9.     $this->assertFalse($manager->isLogin());
  10.     $this->assertSame([], $manager->getLogin());
  12.     $this->assertNull($manager->login(['foo' => 'bar', 'hello' => 'world'], 10));
  14.     $this->assertTrue($manager->isLogin());
  15.     $this->assertSame(['foo' => 'bar', 'hello' => 'world'], $manager->getLogin());
  17.     $this->assertNull($manager->logout());
  19.     $this->assertFalse($manager->isLogin());
  20.     $this->assertSame([], $manager->getLogin());
  21. }