wearesho-team/yii2-tokens

Storing tokens (authorization, registration) in redis database.

1.1.1 2024-11-04 22:53 UTC

Requires

• php: ^7.4 | ^8.0
• nesbot/carbon: ^2.24 || ^1.22
• ramsey/uuid: ^3.6
• yiisoft/yii2: ^2.0.47
• yiisoft/yii2-redis: ^2.0

Requires (Dev)

• horat1us/yii2-asset-free: ^1.0
• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3.7

MIT

• Alexander Letnikow

README

Storing tokens (authorization, registration) in redis database.

Installation

composer require wearesho-team/yii2-tokens:^1.0.0

Usage

Repository

To store tokens you should use Repository that will receive token entity and generate UUIDv4 hash. Then, you can receive token using generated hash.

<?php

use Wearesho\Yii2\Token;

$repository = new Token\Repository([
    'redis' => 'redis', // your yii2-redis connection
]);

$token = new Token\Entity(
    $type = 'registration',
    $tokenOwner = '[e-mail]',
    $value = 'random-token',
    (new \DateTime())->add('PT30M') // expire after 30 minutes
);

$hash = $repository->put($token);

// If you want to receive token

$token = $repository->get($hash); // entity or null

ValidationBehavior

To validate model attributes, that contains hash, owner and value you should use validation behavior, instead of validators because three attributes have to be validated one-time. {attribute} is invalid. message will be add to attribute errors and validation will fail (beforeValidate event).

<?php

use yii\base;
use Wearesho\Yii2\Token;

class Model extends base\Model {
    /** @var string */
    public $hash;
    
    /** @var string */
    public $tokenOwner; // or `phone`, `email` etc.
    
    /** @var string */
    public $token;
    
    public function behaviors(): array
    {
        return [
            'validateToken' => [
                'class' => Token\ValidationBehavior::class,
                'type' => 'registration',
            ],    
        ];
    }
    
    public function rules(): array
    {
        return [
            [['hash', 'tokenOwner', 'token',], 'safe',], // to load using $model->load    
        ];
    }
}

$repository = new Token\Repository;

$model = new Model;
$model->hash = 'some-invalid-hash';
$model->owner = '[e-mail]';
$model->token = 'some-random-token';

$model->validate(); // false

$hash = $repository->put(new Token\Entity(
    'registration',
    $model->tokenWwner,
    $model->token,
    (new \DateTime)->add(new \DateInterval('PT1M'))
));

$model->hash = $hash;

$model->validate(); // true

TODO

• Fix test to rely on the order in which methods are invoked (Upgrade PHPUnit to 10)

Contributors

• Alexander Letnikow

License

MIT