forthelocal/laravel-tokens

This package is abandoned and no longer maintained. No replacement package was suggested.

php implementation of https://github.com/fnando/tokens.

v0.7.0 2017-12-07 03:36 UTC

Requires

• php: ^7.1.8
• illuminate/database: ^5.5

Requires (Dev)

• orchestra/database: ^3.5
• orchestra/testbench: ^3.5
• phpunit/phpunit: ^6.3

MIT

README

PHP implementation of https://github.com/fnando/tokens.

Usage

Installation

composer require forthelocal/laravel-tokens

class User extends Model
{
    use Tokenizable;
}

// create a new user; remember that the token requires an existing record
// because it depends on its id
$user = User::create();

// create token that never expires
$user->addToken("activate");

// uses custom expires_at
user->addToken("valid", ["expires_at" => strtotime('1 day', time())]);

// uses the default size (48 characters)
$user->addToken("activate");

// uses custom size (up to 240)
$user->addToken("activate", ["length" => 120]);

// uses custom token value
$user->addToken("activate", ["token" => "abc123"]);

// create token with arbitrary data.
$user->addToken("activate", ["data" => [ "action" => "do something"]]);

// find token by name
$user->findTokenByName("reset_account");

// find valid token per user context.
$user->findValidToken("reset_account", "ea2f14aeac40");

// check if a token has expired
$user->tokens()->first()->isExpired();

// find user by token
User::findByToken("activate", "ea2f14aeac40");

// remove all expired tokens except those with NULL values
Token::clean();

// generate a token as string, without saving it
User::generateToken();

// remove a token by its name
$user->removeToken("activate");

// find user by valid token (same name, same hash, not expired)
User::findByValidToken("activate", "ea2f14aeac40");

// Token hash
echo $token; //=> ea2f14aeac40

License

MIT