Token

Token.php : 14 Copy path

Extends ValueObject

The base class for all value objects and structs.

Supports readonly properties by marking them as protected. In this case they will only be writable using constructor, and need to be documented using property-read <$var> annotation in class doc in addition to inline property doc. Writable properties must be public and must be documented inline.

Constants¶

MAX_LENGTH ¶

Token.php : 16 Copy path

public mixed MAX_LENGTH = 255

Methods¶

__construct() ¶

Token.php : 32 Copy path

Construct object optionally with a set of properties.

    
                        public __construct(int $id, string $type, string $token, string|null $identifier, DateTimeImmutable $created, DateTimeImmutable $expires, bool $revoked)

Readonly properties values must be set using $properties as they are not writable anymore after object has been created.

Parameters

Name	Type	Default value	Description
$id	int	-	-
$type	string	-	-
$token	string	-	-
$identifier	string\|null	-	-
$created	DateTimeImmutable	-	-
$expires	DateTimeImmutable	-	-
$revoked	bool	-	-

__toString() ¶

Token.php : 87 Copy path

public __toString() : string

Return values

string

getCreated() ¶

Token.php : 72 Copy path

public getCreated() : DateTimeImmutable

Return values

DateTimeImmutable

getExpires() ¶

Token.php : 77 Copy path

public getExpires() : DateTimeImmutable

Return values

DateTimeImmutable

getId() ¶

Token.php : 52 Copy path

public getId() : int

Return values

int

getIdentifier() ¶

Token.php : 67 Copy path

public getIdentifier() : string|null

Return values

string|null

getToken() ¶

Token.php : 62 Copy path

public getToken() : string

Return values

string

getType() ¶

Token.php : 57 Copy path

public getType() : string

Return values

string

isRevoked() ¶

Token.php : 82 Copy path

public isRevoked() : bool

Return values

bool

getProperties() ¶

ValueObject.php : 50 Copy path

Function where list of properties are returned.

    
                        protected getProperties([array<string|int, mixed> $dynamicProperties = [] ]) : array<string|int, mixed>

Used by attributes(), override to add dynamic properties

Parameters

Name	Type	Default value	Description
$dynamicProperties	array<string\|int, mixed>	[]	Additional dynamic properties exposed on the object

Return values

array<string|int, mixed>