\App\Models\Database\EntitiesApiKey

API key entity

Summary

Methods
Properties
Constants
getId()
__clone()
__construct()
getKey()
getHash()
getDescription()
setDescription()
getExpiration()
setExpiration()
isExpired()
verify()
jsonSerialize()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$id
$key
$hash
$salt
$description
$expiration
N/A

Properties

$id

$id : int|null

Type

normal — ID

$key

$key : string|null

Type

normal — API key

$hash

$hash : string

Type

normal — API key hash

$salt

$salt : string

Type

normal — API key hash salt

$description

$description : string

Type

normal — API key description

$expiration

$expiration : \DateTime|null

Type

normal — API key expiration

Methods

getId()

getId() : int|null

Returns ID

Returns

int|null —

ID

__clone()

__clone() : mixed

Creates a deep copy

Returns

mixed

__construct()

__construct(string  $description, \DateTime|null  $expiration) : mixed

Constructor

Parameters

string $description

API key description

\DateTime|null $expiration

API key expiration

Returns

mixed

getKey()

getKey() : string|null

Returns API key

Returns

string|null —

API key

getHash()

getHash() : string

Returns API key hash

Returns

string —

API key hash

getDescription()

getDescription() : string

Returns API key description

Returns

string —

API key description

setDescription()

setDescription(string  $description) : void

Sets API key description

Parameters

string $description

API key description

getExpiration()

getExpiration() : \DateTime|null

Returns API key expiration

Returns

\DateTime|null —

API key expiration

setExpiration()

setExpiration(\DateTime|null  $expiration) : void

Sets API key expiration

Parameters

\DateTime|null $expiration

API key expiration

isExpired()

isExpired() : bool

Checks if API key is expired

Returns

bool —

Is API key expired

verify()

verify(string  $key) : bool

Verifies API key

Parameters

string $key

API key

Returns

bool —

Is API key

jsonSerialize()

jsonSerialize() : array<string,int|string|null>

Returns JSON serialized data

Returns

array

JSON serialized data