erwane / cakephp-token
Easy use token in CakePHP 4
Installs: 1 395
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 3
Forks: 2
Open Issues: 0
Type:cakephp-plugin
Requires
- php: >=7.2
- ext-json: *
- cakephp/cakephp: >=4.5 <5
- cakephp/migrations: ^3.0
Requires (Dev)
- cakephp/cakephp-codesniffer: ^3.0
- php-parallel-lint/php-parallel-lint: ^1.2
- phpro/grumphp: ^1.3
- phpunit/phpunit: ^9.0
README
Description
This is a really "simple to use" cakephp 4 plugin for generating and reading temporaries tokens
Installation
composer require erwane/cakephp-token:^2.0 bin/cake migrations migrate -p Token
Usage
Generate a token
/** * Create a token with data and return the id * @param array $content an array of custom data * @param string $expire expire exprimed in '+6 days +2 hours' format * @param int $length Token length * @return string The token id */ $myNewTokenId = \Token\Token::generate(array $content, $expire, 8);
Get token
// return null (expired or not found) or Token entity $token = \Token\Token::get($tokenId);
Delete token
Tokens deletion can be ignored, they will be destroyed on expire, but sometime you need to delete one token immediately
/** * Delete token from id or entity * * @param \Token\Model\Entity\Token|string $token Token entity or id * @return bool True if token was deleted */ $result = \Token\Token::delete($token);
Auto cleaning
Each time a token is read, expired tokens are pruned