ApiOpenStudio PHPDoc

User
in package

Class User.

DB class for for storing user row data.

Table of Contents

$active  : int|null
User active status.
$addressCity  : string|null
User city.
$addressCountry  : string|null
User country.
$addressPostcode  : string|null
User postcode.
$addressState  : string|null
User county/state.
$addressStreet  : string|null
User street.
$addressSuburb  : string|null
User suburb.
$company  : string|null
User company.
$email  : string|null
User email.
$hash  : string|null
User hashed password.
$honorific  : string|null
User honorific.
$nameFirst  : string|null
User first name.
$nameLast  : string|null
User last name.
$passwordReset  : string|null
User reset token.
$passwordResetTtl  : string|null
User reset token TTL.
$phoneMobile  : string|null
User mobile phone.
$phoneWork  : string|null
User work phone.
$uid  : int|null
User ID.
$username  : string|null
User username.
$website  : string|null
User website.
__construct()  : mixed
User constructor.
dump()  : array<string|int, mixed>
Return the values as an associative array.
getActive()  : int
Get the active status.
getAddressCity()  : string
Get the city.
getAddressCountry()  : string
Get the country.
getAddressPostcode()  : string
Get the postcode.
getAddressState()  : string
Get the state.
getAddressStreet()  : string
Get the street address.
getAddressSuburb()  : string
Get the suburb.
getCompany()  : string
Get the company.
getEmail()  : string
Get the user email.
getHash()  : string
Get the hash.
getHonorific()  : string
Get the honorific.
getNameFirst()  : string
Get the first name.
getNameLast()  : string
Get the last name.
getPasswordReset()  : string
Get the password reset token.
getPasswordResetTtl()  : string
Get the password reset token TTL.
getPhoneMobile()  : string
Get the mobile phone number.
getPhoneWork()  : string
Get the work phone number.
getUid()  : int
Get user ID.
getUsername()  : string
Get the username.
getWebsite()  : string
Get the website.
setActive()  : void
Set the active status.
setAddressCity()  : void
Set the city.
setAddressCountry()  : void
Set the country.
setAddressPostcode()  : void
Set the postcode.
setAddressState()  : void
Set the state.
setAddressStreet()  : void
Set the street address.
setAddressSuburb()  : void
Set the suburb.
setCompany()  : void
Set the company.
setEmail()  : void
Set the email.
setHash()  : void
Set the hash.
setHonorific()  : void
Set the honorific.
setNameFirst()  : void
Set the first name.
setNameLast()  : void
Set the last name.
setPassword()  : void
Set the password. This will also create the hash.
setPasswordReset()  : void
Set the password reset token.
setPasswordResetTtl()  : void
Set the password reset token TTL.
setPhoneMobile()  : void
Set the mobile phone number.
setPhoneWork()  : void
Set the work phone number.
setUid()  : void
Set the user ID.
setUsername()  : void
Set the username.
setWebsite()  : void
Set the website.

Properties

$active

User active status.

protected int|null $active

User active status.

$addressCity

User city.

protected string|null $addressCity

User city address.

$addressCountry

User country.

protected string|null $addressCountry

User country address.

$addressPostcode

User postcode.

protected string|null $addressPostcode

User postcode address.

$addressState

User county/state.

protected string|null $addressState

User state/county address.

$addressStreet

User street.

protected string|null $addressStreet

User street address.

$addressSuburb

User suburb.

protected string|null $addressSuburb

User suburb address.

$company

User company.

protected string|null $company

User's company.

$email

User email.

protected string|null $email

User email.

$hash

User hashed password.

protected string|null $hash

User password hash.

$honorific

User honorific.

protected string|null $honorific

User honorific.

$nameFirst

User first name.

protected string|null $nameFirst

User first name.

$nameLast

User last name.

protected string|null $nameLast

User last name.

$passwordReset

User reset token.

protected string|null $passwordReset

Password reset token.

$passwordResetTtl

User reset token TTL.

protected string|null $passwordResetTtl

Password reset TTL.

$phoneMobile

User mobile phone.

protected string|null $phoneMobile

User mobile number.

$phoneWork

User work phone.

protected string|null $phoneWork

User work number.

$uid

User ID.

protected int|null $uid

User ID.

$username

User username.

protected string|null $username

Username.

$website

User website.

protected string|null $website

User's website.

Methods

__construct()

User constructor.

public __construct([int|null $uid = null ][, int|null $active = null ][, string|null $username = null ][, string|null $hash = null ][, string|null $email = null ][, string|null $honorific = null ][, string|null $nameFirst = null ][, string|null $nameLast = null ][, string|null $company = null ][, string|null $website = null ][, string|null $addressStreet = null ][, string|null $addressSuburb = null ][, string|null $addressCity = null ][, string|null $addressState = null ][, string|null $addressCountry = null ][, string|null $addressPostcode = null ][, string|null $phoneMobile = null ][, string|null $phoneWork = null ][, string|null $passwordReset = null ][, string|null $passwordResetTtl = null ]) : mixed
Parameters
$uid : int|null = null

User ID.

$active : int|null = null

Active status.

$username : string|null = null

Username.

$hash : string|null = null

Password hash.

$email : string|null = null

User email.

$honorific : string|null = null

User honorific.

$nameFirst : string|null = null

First name.

$nameLast : string|null = null

Last name.

$company : string|null = null

Company.

$website : string|null = null

Website.

$addressStreet : string|null = null

Street address.

$addressSuburb : string|null = null

Suburb.

$addressCity : string|null = null

City.

$addressState : string|null = null

State.

$addressCountry : string|null = null

Country.

$addressPostcode : string|null = null

Postcode.

$phoneMobile : string|null = null

Mobile number.

$phoneWork : string|null = null

Business number.

$passwordReset : string|null = null

Password reset token.

$passwordResetTtl : string|null = null

Password reset token TTL.

Return values
mixed

dump()

Return the values as an associative array.

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

User.

getActive()

Get the active status.

public getActive() : int
Return values
int

Active status.

getAddressCity()

Get the city.

public getAddressCity() : string
Return values
string

City.

getAddressCountry()

Get the country.

public getAddressCountry() : string
Return values
string

Country.

getAddressPostcode()

Get the postcode.

public getAddressPostcode() : string
Return values
string

Postcode.

getAddressState()

Get the state.

public getAddressState() : string
Return values
string

State.

getAddressStreet()

Get the street address.

public getAddressStreet() : string
Return values
string

Street address.

getAddressSuburb()

Get the suburb.

public getAddressSuburb() : string
Return values
string

Suburb.

getCompany()

Get the company.

public getCompany() : string
Return values
string

Company.

getEmail()

Get the user email.

public getEmail() : string
Return values
string

Email.

getHash()

Get the hash.

public getHash() : string
Return values
string

Hash.

getHonorific()

Get the honorific.

public getHonorific() : string
Return values
string

Honorific.

getNameFirst()

Get the first name.

public getNameFirst() : string
Return values
string

First name.

getNameLast()

Get the last name.

public getNameLast() : string
Return values
string

Last name.

getPasswordReset()

Get the password reset token.

public getPasswordReset() : string
Return values
string

Password reset token.

getPasswordResetTtl()

Get the password reset token TTL.

public getPasswordResetTtl() : string
Return values
string

Password reset token TTL.

getPhoneMobile()

Get the mobile phone number.

public getPhoneMobile() : string
Return values
string

Mobile phone number.

getPhoneWork()

Get the work phone number.

public getPhoneWork() : string
Return values
string

Work phone number.

getUid()

Get user ID.

public getUid() : int
Return values
int

User ID.

getUsername()

Get the username.

public getUsername() : string
Return values
string

Username.

getWebsite()

Get the website.

public getWebsite() : string
Return values
string

Website.

setActive()

Set the active status.

public setActive(int $active) : void
Parameters
$active : int

Active status.

Return values
void

setAddressCity()

Set the city.

public setAddressCity([string|null $addressCity = null ]) : void
Parameters
$addressCity : string|null = null

City.

Return values
void

setAddressCountry()

Set the country.

public setAddressCountry([string|null $addressCountry = null ]) : void
Parameters
$addressCountry : string|null = null

Country.

Return values
void

setAddressPostcode()

Set the postcode.

public setAddressPostcode([string|null $addressPostcode = null ]) : void
Parameters
$addressPostcode : string|null = null

Postcode.

Return values
void

setAddressState()

Set the state.

public setAddressState([string|null $addressState = null ]) : void
Parameters
$addressState : string|null = null

State.

Return values
void

setAddressStreet()

Set the street address.

public setAddressStreet([string|null $addressStreet = null ]) : void
Parameters
$addressStreet : string|null = null

Street address.

Return values
void

setAddressSuburb()

Set the suburb.

public setAddressSuburb([string|null $addressSuburb = null ]) : void
Parameters
$addressSuburb : string|null = null

Suburb.

Return values
void

setCompany()

Set the company.

public setCompany([string|null $company = null ]) : void
Parameters
$company : string|null = null

Company.

Return values
void

setEmail()

Set the email.

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

Email.

Return values
void

setHash()

Set the hash.

public setHash([string|null $hash = null ]) : void
Parameters
$hash : string|null = null

Hash.

Return values
void

setHonorific()

Set the honorific.

public setHonorific([string|null $honorific = null ]) : void
Parameters
$honorific : string|null = null

Honorific.

Return values
void

setNameFirst()

Set the first name.

public setNameFirst([string|null $nameFirst = null ]) : void
Parameters
$nameFirst : string|null = null

First name.

Return values
void

setNameLast()

Set the last name.

public setNameLast([string|null $nameLast = null ]) : void
Parameters
$nameLast : string|null = null

Last name.

Return values
void

setPassword()

Set the password. This will also create the hash.

public setPassword([string|null $password = null ]) : void
Parameters
$password : string|null = null

Password.

Return values
void

setPasswordReset()

Set the password reset token.

public setPasswordReset([string|null $passwordReset = null ]) : void
Parameters
$passwordReset : string|null = null

Password reset token.

Return values
void

setPasswordResetTtl()

Set the password reset token TTL.

public setPasswordResetTtl([string|null $passwordResetTtl = null ]) : void
Parameters
$passwordResetTtl : string|null = null

Password reset token TTL.

Return values
void

setPhoneMobile()

Set the mobile phone number.

public setPhoneMobile([string|null $phoneMobile = null ]) : void
Parameters
$phoneMobile : string|null = null

Mobile phone number.

Return values
void

setPhoneWork()

Set the work phone number.

public setPhoneWork([string|null $phoneWork = null ]) : void
Parameters
$phoneWork : string|null = null

Work phone number.

Return values
void

setUid()

Set the user ID.

public setUid(int $uid) : void
Parameters
$uid : int

User ID.

Return values
void

setUsername()

Set the username.

public setUsername(string $userName) : void
Parameters
$userName : string

Username.

Return values
void

setWebsite()

Set the website.

public setWebsite([string|null $website = null ]) : void
Parameters
$website : string|null = null

Website.

Return values
void

Search results