class Item (View source)

Confirmation item is a simple data object incapsulating a single confirmation unit, its unique identifier (token), its human friendly name, description and the status whether it has already been confirmed.

Methods

public
__construct(string $token, string $name, string $description)

No description

public
string
getToken()

Returns the token of the item

public
string
getName()

Returns the item name (human readable)

public
string
getDescription()

Returns the human readable description of the item

public
bool
isConfirmed()

Returns whether the item has been confirmed

public
confirm()

Mark the item as confirmed

Details

__construct(string $token, string $name, string $description)

No description

Parameters

string $token

unique token of this confirmation item

string $name

Human readable name of the item

string $description

Human readable description of the item

string getToken()

Returns the token of the item

Return Value

string

string getName()

Returns the item name (human readable)

Return Value

string

string getDescription()

Returns the human readable description of the item

Return Value

string

bool isConfirmed()

Returns whether the item has been confirmed

Return Value

bool

confirm()

Mark the item as confirmed