Ubiquity  2.0.3
php rapid development framework
ApiTokens Class Reference

Public Member Functions

 __construct ($length=10, $duration=3600, $tokens=[])
 
 getTokens ()
 
 getDuration ()
 
 getToken ($key)
 
 isExpired ($key)
 
 addToken ()
 
 clearAll ()
 
 removeExpireds ()
 
 remove ($key)
 
 storeToCache ($key="_apiTokens")
 

Static Public Member Functions

static getFromCache ($folder, $key="_apiTokens", $length=10, $duration=3600)
 

Protected Member Functions

 generateToken ()
 

Private Attributes

 $tokens
 
 $length
 
 $duration
 

Static Private Attributes

static $cache
 

Detailed Description

Definition at line 8 of file ApiTokens.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $length = 10,
  $duration = 3600,
  $tokens = [] 
)

Definition at line 14 of file ApiTokens.php.

Member Function Documentation

◆ addToken()

addToken ( )

Definition at line 48 of file ApiTokens.php.

◆ clearAll()

clearAll ( )

Definition at line 54 of file ApiTokens.php.

◆ generateToken()

generateToken ( )
protected

Definition at line 20 of file ApiTokens.php.

◆ getDuration()

getDuration ( )

Definition at line 31 of file ApiTokens.php.

◆ getFromCache()

static getFromCache (   $folder,
  $key = "_apiTokens",
  $length = 10,
  $duration = 3600 
)
static
Parameters
$folder
string$key
number$length
number$duration
Returns
ApiTokens

Definition at line 87 of file ApiTokens.php.

◆ getToken()

getToken (   $key)

Definition at line 35 of file ApiTokens.php.

◆ getTokens()

getTokens ( )

Definition at line 27 of file ApiTokens.php.

◆ isExpired()

isExpired (   $key)

Definition at line 41 of file ApiTokens.php.

◆ remove()

remove (   $key)

Definition at line 67 of file ApiTokens.php.

◆ removeExpireds()

removeExpireds ( )

Definition at line 58 of file ApiTokens.php.

◆ storeToCache()

storeToCache (   $key = "_apiTokens")

Definition at line 75 of file ApiTokens.php.

Field Documentation

◆ $cache

$cache
staticprivate

Definition at line 12 of file ApiTokens.php.

◆ $duration

$duration
private

Definition at line 11 of file ApiTokens.php.

◆ $length

$length
private

Definition at line 10 of file ApiTokens.php.

◆ $tokens

$tokens
private

Definition at line 9 of file ApiTokens.php.


The documentation for this class was generated from the following file: