README

CakePHP 插件，用于生成各种（安全）令牌。

要求

CakePHP 3.+

强烈建议 PHP 5.x 用户安装 paragonie/random_compat polyfill composer 包，以确保生成的令牌真正安全。

安装

使用 composer 安装插件

composer require alt3/cakephp-tokens:1.0.x-dev

要启用插件，可以运行以下命令
```
bin/cake plugin load Alt3/CakeTokens
```
或者手动将以下行添加到您的 config/bootstrap.php 文件中
```
Plugin::load('Alt3/CakeTokens');
```
通过运行以下命令创建用于存储令牌所需的表
```
bin/cake migrations migrate --plugin Alt3/CakeTokens
```

用法

在您的控制器内部

use Alt3\Tokens\RandomBytesToken

public function test() {

  // create a token object
  $token = new RandomBytesToken();
  $token->setCategory('password-reset');
  $token->setLifetime('+1 week');

  // save the token object
  $table = TableRegistry::get('Alt3/CakeTokens.Tokens');
  $entity = $table->newEntity($token->toArray());

  if ($table->save($entity)) {
    pr('Successfully saved token with id ' . $entity->id);
  }
}

访问 alt3/tokens 获取有关创建令牌对象和创建您自己的特定令牌适配器的更多信息。

方法

TokensTable 包含以下方法

setStatus($id, $status): 设置具有指定 ID 的令牌的状态
deleteAllExpired(): 删除所有已过期的令牌
deleteAllWithStatus($status): 删除所有匹配给定状态的令牌

自定义查找器

TokensTable 包含以下自定义查找器

findValidToken: 当给定的令牌值（必须传递）存在，状态为 0 且未过期时返回 true
findAllActive: 返回所有状态为 0 的令牌

贡献

在提交 PR 之前请确保

PHPUnit 测试通过（composer run-script tests）
PSR-2 Code Sniffer 测试通过（composer run-script cs）
Coveralls 代码覆盖率保持为 100%

alt3 / cakephp-tokens

维护者

详细信息

README

要求

安装

用法

方法

自定义查找器

贡献