\AccountInterface

Summary

Methods
Constants
__construct()
setVariables()
getLoginId()
getEmail()
getName()
getNotifications()
getAllDisputes()
getUrl()
getRole()
__toString()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

__construct()

__construct(Array|Int  $account) 

Constructor should create a sub-classed Account object.

Parameters

Array|Int $account

Associative array corresponding to the account, taken from the database. OR an integer corresponding to the login_id of the account.

setVariables()

setVariables(Array|Int  $account) 

Called by constructor - repopulates the object properties from the database. Usually done after a refresh.

Parameters

Array|Int $account

Associative array corresponding to the account, taken from the database. OR an integer corresponding to the login_id of the account.

getLoginId()

getLoginId() : integer

Gets the login ID representing the account in the database.

Returns

integer

getEmail()

getEmail() : String

Gets the email associated with the account.

Returns

String

getName()

getName() : String

Gets the name of the account.

Returns

String

getNotifications()

getNotifications() : \Array<Notification>

Gets all unread notifications associated with the account.

Returns

\Array

getAllDisputes()

getAllDisputes() : \Array<Dispute>

Gets all disputes associated with the account.

Returns

\Array

getUrl()

getUrl() : \Url

Gets the URL to the account's public profile.

Returns

\Url

getRole()

getRole() : String

Returns the type of account, displayed to the user.

Example: 'Agent', 'Law Firm'

Returns

String —

Account type.

__toString()

__toString() : String

Account should be rendered as follows: <a href="/link/to/account/profile">Account Name</a>

Returns

String