User<`T`>

Represents a valid user of the system.

interface User<T> extends Owner<T>

Copyright: 2015-2016 Appertly

License: Apache-2.0

Instance Methods

Public
Returns	Signature and Description
`string`	`getDisplayName`() Gets the entity's display name.
`string`	`getEmail`() Gets the user's email.
`ImmVector`<`Group`<`T`>>	`getGroups`() Gets any groups to which the owner belongs.
`T`	`getId`() Gets the entity ID.
`Owner`<`T`>	`getOwner`() Gets the user's owner, either a group, or itself.
`string`	`getSlug`() Gets the URL slug for this entity.
`DateTimeZone`	`getTimeZone`() Gets the TimeZone for this entity.
`bool`	`isDisabled`() Gets whether this group is disabled.
`array`<`string`,`mixed`>	`toArray`() Converts this entity to an array.

Method Details

getDisplayName

Inherited from Owner

abstract public function getDisplayName()

Gets the entity's display name.

Returns
Type	Description
`string`	The entity's display name

getEmail

abstract public function getEmail()

Gets the user's email.

Returns
Type	Description
`string`	The user's email

getGroups

abstract public function getGroups()

Gets any groups to which the owner belongs.

Returns
Type	Description
`ImmVector`<`Group`<`T`>>	The groups

getId

Inherited from Owner

abstract public function getId()

Gets the entity ID.

Returns
Type	Description
`T`	The entity's ID

getOwner

abstract public function getOwner()

Gets the user's owner, either a group, or itself.

Returns
Type	Description
`Owner`<`T`>	The owner record (possibly `$this`)

getSlug

Inherited from Owner

abstract public function getSlug()

Gets the URL slug for this entity.

Returns
Type	Description
`string`	The URL slug

getTimeZone

Inherited from Owner

abstract public function getTimeZone()

Gets the TimeZone for this entity.

If the entity belongs to a parent record, e.g. a user belonging to a group, the parent value should be returned if none is available on this entity.

Should default to system time zone if none is available.

Returns
Type	Description
`DateTimeZone`	The owner's time zone

isDisabled

Inherited from Owner

abstract public function isDisabled()

Gets whether this group is disabled.

Returns
Type	Description
`bool`	Whether the group is disabled

toArray

Inherited from Owner

abstract public function toArray()

Converts this entity to an array.

Returns
Type	Description
`array`<`string`,`mixed`>	The array version