erwane/cakephp-token

CakePHP plugin for tokens

3.0.0 2025-01-04 16:17 UTC

Requires

• php: ^8.1
• ext-json: *
• cakephp/cakephp: ^5.0
• cakephp/migrations: ^4.0

Requires (Dev)

• cakephp/cakephp-codesniffer: ^5.0
• php-parallel-lint/php-parallel-lint: ^1.3
• phpro/grumphp: ^2.0
• phpunit/phpunit: ^10.5.5 || ^11.1.3

MIT

• Erwane Breton

• cakephp
• token

README

Version map

Description

This is a really "simple to use" CakePHP plugin for generating and reading temporaries tokens

Installation

composer require erwane/cakephp-token
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