API Documentation
\
TriTan
Cache
Command
Common
Acl
Context
Hooks
Options
Plugin
Post
Posttype
Site
User
Exception
Interfaces
Acl
Cache
Hooks
Options
Password
Plugin
Plugins
Post
Posttype
Site
User
Queue
Traits

\TriTan\Common\UserUser

User Domain

Summary

Methods
Properties
Constants
getId()
setId()
getLogin()
setLogin()
getFname()
setFname()
getLname()
setLname()
getEmail()
setEmail()
getPassword()
setPassword()
getUrl()
setUrl()
getAddedBy()
setAddedBy()
getRegistered()
setRegistered()
getModified()
setModified()
getActivationKey()
setActivationKey()
__isset()
__get()
__set()
__unset()
get()
hasProp()
toArray()
setRole()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$user_id
$user_login
$user_fname
$user_lname
$user_email
$user_pass
$user_url
$user_addedby
$user_registered
$user_modified
$user_activation_key
N/A

Properties

$user_id

$user_id : integer

User user_id.

Type

integer

$user_login

$user_login : string

User username/login.

Type

string

$user_fname

$user_fname : string

User first name.

Type

string

$user_lname

$user_lname : string

User last name.

Type

string

$user_email

$user_email : string

User email.

Type

string

$user_pass

$user_pass : string

User password.

Type

string

$user_url

$user_url : string

User url.

Type

string

$user_addedby

$user_addedby : integer

Person who created user.

Type

integer

$user_registered

$user_registered : string

User registration datetime.

Type

string

$user_modified

$user_modified : string

User modified datetime.

Type

string

$user_activation_key

$user_activation_key : string

User activation key.

Type

string

Methods

getId()

getId()

setId()

setId(\TriTan\Common\User\int  $id)

Parameters

\TriTan\Common\User\int $id

getLogin()

getLogin()

setLogin()

setLogin(\TriTan\Common\User\string  $login)

Parameters

\TriTan\Common\User\string $login

getFname()

getFname()

setFname()

setFname(\TriTan\Common\User\string  $fname)

Parameters

\TriTan\Common\User\string $fname

getLname()

getLname()

setLname()

setLname(\TriTan\Common\User\string  $lname)

Parameters

\TriTan\Common\User\string $lname

getEmail()

getEmail()

setEmail()

setEmail(\TriTan\Common\User\string  $email)

Parameters

\TriTan\Common\User\string $email

getPassword()

getPassword()

setPassword()

setPassword(\TriTan\Common\User\string  $password)

Parameters

\TriTan\Common\User\string $password

getUrl()

getUrl()

setUrl()

setUrl(\TriTan\Common\User\string  $url)

Parameters

\TriTan\Common\User\string $url

getAddedBy()

getAddedBy()

setAddedBy()

setAddedBy(\TriTan\Common\User\int  $addedby)

Parameters

\TriTan\Common\User\int $addedby

getRegistered()

getRegistered()

setRegistered()

setRegistered(\TriTan\Common\User\string  $registered)

Parameters

\TriTan\Common\User\string $registered

getModified()

getModified()

setModified()

setModified(\TriTan\Common\User\string  $modified)

Parameters

\TriTan\Common\User\string $modified

getActivationKey()

getActivationKey()

setActivationKey()

setActivationKey(\TriTan\Common\User\string  $activationkey)

Parameters

\TriTan\Common\User\string $activationkey

__isset()

__isset(string  $key) : boolean

Magic method for checking the existence of a certain custom field.

Parameters

string $key

User meta key to check if set.

Returns

boolean —

Whether the given user meta key is set.

__get()

__get(string  $key) : mixed

Magic method for accessing custom fields.

Parameters

string $key

User meta key to retrieve.

Returns

mixed —

Value of the given user meta key (if set). If $key is 'id', the user ID.

__set()

__set(string  $key, mixed  $value)

Magic method for setting custom user fields.

This method does not update custom fields in the user document. It only stores the value on the User instance.

Parameters

string $key

User meta key.
mixed $value

User meta value.

__unset()

__unset(string  $key)

Magic method for unsetting a certain custom field.

Parameters

string $key

User meta key to unset.

get()

get(string  $key) : mixed

Retrieve the value of a property or meta key.

Retrieves from the users and usermeta table.

Parameters

string $key

Property

Returns

mixed

hasProp()

hasProp(string  $key) : boolean

Determine whether a property or meta key is set

Consults the users and usermeta tables.

Parameters

string $key

Property

Returns

boolean

toArray()

toArray() : array

Return an array representation.

Returns

array —

Array representation.

setRole()

setRole(\TriTan\Common\User\string  $role)

Parameters

\TriTan\Common\User\string $role