ApiOpenStudio PHPDoc

Invite
in package

Class Invite.

DB class for storing invite row data.

Table of Contents

$created  : string|null
Invite email.
$email  : string|null
Invite created date.
$iid  : int|null
Invite ID.
$token  : string|null
Invite token.
__construct()  : mixed
Invite constructor.
dump()  : array<string|int, mixed>
Return the invite as an associative array.
getCreated()  : string
Get the created date.
getEmail()  : string
Get the invite email.
getIid()  : int
Get the invite ID.
getToken()  : string
Get the invite token.
setCreated()  : void
Set the created date time.
setEmail()  : void
Set the invite email.
setIid()  : void
Set the invite ID.
setToken()  : void
Set the invite token.

Properties

$created

Invite email.

protected string|null $created

Email.

$email

Invite created date.

protected string|null $email

Created.

$iid

Invite ID.

protected int|null $iid

Invite ID.

$token

Invite token.

protected string|null $token

Invite token.

Methods

__construct()

Invite constructor.

public __construct([int|null $iid = null ][, string|null $email = null ][, string|null $token = null ]) : mixed
Parameters
$iid : int|null = null

Invite ID.

$email : string|null = null

Invite email.

$token : string|null = null

Invite token.

Return values
mixed —

dump()

Return the invite as an associative array.

public dump() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Invite.

getCreated()

Get the created date.

public getCreated() : string
Return values
string —

Created date time.

getEmail()

Get the invite email.

public getEmail() : string
Return values
string —

Invite email.

getIid()

Get the invite ID.

public getIid() : int
Return values
int —

Invite ID.

getToken()

Get the invite token.

public getToken() : string
Return values
string —

Invite token.

setCreated()

Set the created date time.

public setCreated(string $created) : void
Parameters
$created : string

Created date time.

Return values
void —

setEmail()

Set the invite email.

public setEmail(string $email) : void
Parameters
$email : string

Invite email.

Return values
void —

setIid()

Set the invite ID.

public setIid(int $iid) : void
Parameters
$iid : int

Invite ID.

Return values
void —

setToken()

Set the invite token.

public setToken(string $token) : void
Parameters
$token : string

Invite token.

Return values
void —

Search results