Documentation

Tokens
in package

Tokens utils class.

Table of Contents

delete()  : void
Delete token.
execute()  : bool
Execute token method.
generate()  : string
Generate token.
get()  : array<string|int, mixed>|null
Get token detail.
generateUid()  : string
Generate uid function.

Methods

delete()

Delete token.

public static delete(string $uid) : void
Parameters
$uid : string
Return values
void

execute()

Execute token method.

public static execute(string $uid[, array<string|int, mixed>|null $tokenData = null ]) : bool
Parameters
$uid : string
$tokenData : array<string|int, mixed>|null = null
Return values
bool

generate()

Generate token.

public static generate(string $method, array<string|int, mixed> $params[, string|null $expirationDate = null ]) : string
Parameters
$method : string

Method name

$params : array<string|int, mixed>
$expirationDate : string|null = null

Date and time until which the token is valid

Return values
string

get()

Get token detail.

public static get(string $uid[, bool $remove = true ]) : array<string|int, mixed>|null
Parameters
$uid : string
$remove : bool = true
Return values
array<string|int, mixed>|null

generateUid()

Generate uid function.

private static generateUid() : string
Return values
string

        

Search results