1. class
  2. SilverStripe
  3. \
  4. Security
  5. \
  6. Confirmation
  7. \
  8. Item

Item

class Item

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

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

No description

string
getToken()

Returns the token of the item

string
getName()

Returns the item name (human readable)

string
getDescription()

Returns the human readable description of the item

bool
isConfirmed()

Returns whether the item has been confirmed

confirm()

Mark the item as confirmed

Details

at line 48
__construct(string $token, string $name, string $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

at line 61
string getToken()

Returns the token of the item

Return Value

string

at line 71
string getName()

Returns the item name (human readable)

Return Value

string

at line 81
string getDescription()

Returns the human readable description of the item

Return Value

string

at line 91
bool isConfirmed()

Returns whether the item has been confirmed

Return Value

bool

at line 99
confirm()

Mark the item as confirmed