\User\EntityUser

An example of how to implement a role aware user entity.

Summary

Methods

Properties

Constants

__construct()
getAuths()
updatedTimestamps()
getId()
setId()
getEmail()
setEmail()
getDisplayName()
setDisplayName()
getStatus()
setStatus()
getRole()
setRole()
getConfirm()
setConfirm()
getCreated()
setCreated()
getUpdated()
setUpdated()
generateConfirm()
activate()
isActive()
isUnconfirmed()
setEntityManager()
getEntityName()

No public properties found

ROLE_USER
ROLE_ADMIN
STATUS_ACTIVE
STATUS_INACTIVE
STATUS_UNCONFIRMED

No protected methods found

$id
$email
$displayName
$role
$confirm
$status
$created
$updated

N/A

No private methods found

$auths
$entityManager

N/A

File: module/User/src/User/Entity/User.php
Package: Default
Class hierarchy: \User\Entity\User
Uses traits: \Fury\Media\File

Tags

ORM\Entity	(repositoryClass="User\Repository\User")
ORM\Table	(name="users")
Annotation\Name	("user")
Annotation\Hydrator	("Zend\Stdlib\Hydrator\ObjectProperty")
ORM\HasLifecycleCallbacks
author	Oleksii Novikov

Constants

ROLE_USER

ROLE_USER

ROLE_ADMIN

ROLE_ADMIN

STATUS_ACTIVE

STATUS_ACTIVE

STATUS_INACTIVE

STATUS_INACTIVE

STATUS_UNCONFIRMED

STATUS_UNCONFIRMED

Properties

$id

$id : integer

Type

integer

Tags

Annotation\Type	("Zend\Form\Element\Text")
Annotation\Exclude
ORM\Id
ORM\Column	(type="integer", options={"unsigned"=true})
ORM\GeneratedValue	(strategy="AUTO")

$email

$email : string

Type

string

Tags

Annotation\Type	("Zend\Form\Element\Email")
Annotation\Required	(false)
Annotation\Filter	({"name":"StringTrim"})
Annotation\Attributes	({"class":"form-control"})
Annotation\Validator	({"name":"EmailAddress"}) Annotation\Validator({"name":"Db\NoRecordExists", "options":{"adapter": "Db\Adapter", "table" : "users", "fields" : "email"}})
ORM\Column	(type="string", unique=true, nullable=true, length=255)

$displayName

$displayName : string

Type

string

Tags

Annotation\Type	("Zend\Form\Element\Text")
Annotation\Required	(true)
Annotation\Filter	({"name":"StringTrim"})
Annotation\Attributes	({"class":"form-control"})
ORM\Column	(type="string", length=50, nullable=true)

$role

$role : string

Type

string

Tags

Annotation\Type	("Zend\Form\Element\Select")
Annotation\Required	(false)
Annotation\Options	({"label":"Role:", "value_options":{"member":"Member", "admin":"Admin"}})
Annotation\Attributes	({"class":"form-control"})
ORM\Column	(type="string", length=128, options={"default" = "member"})

$confirm

$confirm : string

Type

string

Tags

Annotation\Exclude
ORM\Column	(type="string", nullable=true, length=128)

$status

$status : string

Type

string

Tags

Annotation\Type	("Zend\Form\Element\Select")
Annotation\Required	(true)
Annotation\Options	({"label":"Satus:", "value_options":{"active" : "active", "inactive" : "inactive", "unconfirmed" : "unconfirmed"}})
Annotation\Attributes	({"class":"form-control"})
ORM\Column	(type="enumstatus", nullable=false, options={"default" = "unconfirmed"})

$created

$created : \User\Entity\created

Type

\User\Entity\created

Tags

Annotation\Exclude
ORM\Column	(type="datetime")

$updated

$updated : \User\Entity\updated

Type

\User\Entity\updated

Tags

Annotation\Exclude
ORM\Column	(type="datetime")

$auths

$auths :

Type

Tags

Annotation\Exclude
ORM\OneToMany	(targetEntity="Auth", mappedBy="user", cascade={"remove"})

$entityManager

$entityManager :

Type

Methods

__construct()

__construct()

Initialies the auths variable.

getAuths()

getAuths() : \Doctrine\Common\Collections\ArrayCollection

Returns

\Doctrine\Common\Collections\ArrayCollection

updatedTimestamps()

updatedTimestamps()

Now we tell doctrine that before we persist or update we call the updatedTimestamps() function.

Tags

ORM\PrePersist
ORM\PreUpdate

getId()

getId() : integer

Get id.

Returns

integer

setId()

setId(integer  $id) : void

Set id.

Parameters

integer

$id

getEmail()

getEmail() : string

Get email.

Returns

string

setEmail()

setEmail(string  $email) : void

Set email.

Parameters

string

$email

getDisplayName()

getDisplayName() : string

Get displayName.

Returns

string

setDisplayName()

setDisplayName(string  $displayName) : void

Set displayName.

Parameters

string

$displayName

getStatus()

getStatus() : string

Get status.

Returns

string

setStatus()

setStatus(string  $status) : void

Set status.

Parameters

string

$status

getRole()

getRole() : integer

Get role.

Returns

integer

setRole()

setRole(integer  $role) : void

Set role.

Parameters

integer

$role

getConfirm()

getConfirm() : string

Returns

string

setConfirm()

setConfirm(  $confirm)

Parameters

$confirm

getCreated()

getCreated() : string

Get created.

Returns

string

setCreated()

setCreated(string  $created) : void

Set created.

Parameters

string

$created

getUpdated()

getUpdated() : string

Get updated.

Returns

string

setUpdated()

setUpdated(string  $updated) : void

Set updated.

Parameters

string

$updated

generateConfirm()

generateConfirm() : string

Returns

string

activate()

activate() : $this

Returns

$this

isActive()

isActive() : boolean

Returns

boolean

isUnconfirmed()

isUnconfirmed() : boolean

Returns

boolean

setEntityManager()

setEntityManager(\Doctrine\ORM\Event\LifecycleEventArgs  $args)

Parameters

\Doctrine\ORM\Event\LifecycleEventArgs

$args

Tags

ORM\PostLoad

getEntityName()

getEntityName() : string

Returns

string