PHP Class Sulu\Bundle\SecurityBundle\Entity\BaseUser

Inheritance: extends Sulu\Bundle\CoreBundle\Entity\ApiEntity, implements Sulu\Component\Security\Authentication\UserInterface, implements Serializabl\Serializable

显示文件 Open project: sulu/sulu Class Usage Examples

Protected Properties

Property	Type	Description
$apiKey	string
$confirmationKey	string
$email	string
$enabled	boolean
$id	integer
$lastLogin	DateTime
$locale	string
$locked	boolean
$password	string
$passwordResetToken	string
$privateKey	string
$salt	string
$username	string

Public Methods

Method	Description
__construct ( )	Constructor.
eraseCredentials ( )	Removes the password of the user.
getApiKey ( ) : string	Get apiKey.
getConfirmationKey ( ) : string	Get confirmationKey.
getEmail ( ) : string	Get email.
getEnabled ( )
getFullName ( ) : string
getId ( ) : integer	Get id.
getLastLogin ( ) : DateTime	Get lastLogin.
getLocale ( ) : string	Get locale.
getLocked ( )
getPassword ( ) : string	Get password.
getPasswordResetToken ( ) : string	Get passwordResetToken.
getPasswordResetTokenEmailsSent ( ) : integer	Get passwordResetTokenEmailsSent.
getPasswordResetTokenExpiresAt ( ) : DateTime	Get passwordResetTokenExpiresAt.
getPrivateKey ( ) : string	Get privateKey.
getRoles ( ) : array	Returns just the default symfony user role, so that the user get recognized as authenticated by symfony.
getSalt ( ) : string	Get salt.
getUsername ( ) : string	Get username.
serialize ( ) : string	Serializes the user just with the id, as it is enough.
setApiKey ( string $apiKey ) : self	Set apiKey.
setConfirmationKey ( string $confirmationKey ) : self	Set confirmationKey.
setEmail ( string $email ) : BaseUser	Set email.
setEnabled ( boolean $enabled ) : self	Set enabled.
setLastLogin ( DateTime $lastLogin ) : self	Set lastLogin.
setLocale ( string $locale ) : self	Set locale.
setLocked ( boolean $locked ) : self	Set locked.
setPassword ( string $password ) : self	Set password.
setPasswordResetToken ( string $passwordResetToken ) : self	Set passwordResetToken.
setPasswordResetTokenEmailsSent ( integer $passwordResetTokenEmailsSent ) : BaseUser	Set passwordResetTokenEmailsSent.
setPasswordResetTokenExpiresAt ( DateTime $passwordResetTokenExpiresAt ) : BaseUser	Set tokenExpiresAt.
setPrivateKey ( string $privateKey ) : self	Set privateKey.
setSalt ( string $salt ) : self	Set salt.
setUsername ( string $username ) : self	Set username.
unserialize ( string $serialized )	Constructs the object.

Method Details

__construct() public method

Constructor.

public __construct ( )

eraseCredentials() public method

Removes the password of the user.

public eraseCredentials ( )

getApiKey() public method

Get apiKey.

public getApiKey ( ) : string
return	string

getConfirmationKey() public method

Get confirmationKey.

public getConfirmationKey ( ) : string
return	string

getEmail() public method

Get email.

public getEmail ( ) : string
return	string

getEnabled() public method

public getEnabled ( )

getFullName() public method

public getFullName ( ) : string
return	string

getId() public method

Get id.

public getId ( ) : integer
return	integer

getLastLogin() public method

Get lastLogin.

public getLastLogin ( ) : DateTime
return	DateTime

getLocale() public method

Get locale.

public getLocale ( ) : string
return	string

getLocked() public method

public getLocked ( )

getPassword() public method

Get password.

public getPassword ( ) : string
return	string

getPasswordResetToken() public method

Get passwordResetToken.

public getPasswordResetToken ( ) : string
return	string

getPasswordResetTokenEmailsSent() public method

Get passwordResetTokenEmailsSent.

public getPasswordResetTokenEmailsSent ( ) : integer
return	integer

getPasswordResetTokenExpiresAt() public method

Get passwordResetTokenExpiresAt.

public getPasswordResetTokenExpiresAt ( ) : DateTime
return	DateTime

getPrivateKey() public method

Get privateKey.

public getPrivateKey ( ) : string
return	string

getRoles() public method

Returns just the default symfony user role, so that the user get recognized as authenticated by symfony.

public getRoles ( ) : array
return	array	The user roles

getSalt() public method

Get salt.

public getSalt ( ) : string
return	string

getUsername() public method

Get username.

public getUsername ( ) : string
return	string

serialize() public method

Serializes the user just with the id, as it is enough.

See link: http://php.net/manual/en/serializable.serialize.php

public serialize ( ) : string
return	string	The string representation of the object or null

setApiKey() public method

Set apiKey.

public setApiKey ( string $apiKey ) : self
$apiKey	string
return	self

setConfirmationKey() public method

Set confirmationKey.

public setConfirmationKey ( string $confirmationKey ) : self
$confirmationKey	string
return	self

setEmail() public method

Set email.

public setEmail ( string $email ) : BaseUser
$email	string
return	BaseUser

setEnabled() public method

Set enabled.

public setEnabled ( boolean $enabled ) : self
$enabled	boolean
return	self

setLastLogin() public method

Set lastLogin.

public setLastLogin ( DateTime $lastLogin ) : self
$lastLogin	DateTime
return	self

setLocale() public method

Set locale.

public setLocale ( string $locale ) : self
$locale	string
return	self

setLocked() public method

Set locked.

public setLocked ( boolean $locked ) : self
$locked	boolean
return	self

setPassword() public method

Set password.

public setPassword ( string $password ) : self
$password	string
return	self

setPasswordResetToken() public method

Set passwordResetToken.

public setPasswordResetToken ( string $passwordResetToken ) : self
$passwordResetToken	string
return	self

setPasswordResetTokenEmailsSent() public method

Set passwordResetTokenEmailsSent.

public setPasswordResetTokenEmailsSent ( integer $passwordResetTokenEmailsSent ) : BaseUser
$passwordResetTokenEmailsSent	integer
return	BaseUser

setPasswordResetTokenExpiresAt() public method

Set tokenExpiresAt.

public setPasswordResetTokenExpiresAt ( DateTime $passwordResetTokenExpiresAt ) : BaseUser
$passwordResetTokenExpiresAt	DateTime
return	BaseUser

setPrivateKey() public method

Set privateKey.

public setPrivateKey ( string $privateKey ) : self
$privateKey	string
return	self

setSalt() public method

Set salt.

public setSalt ( string $salt ) : self
$salt	string
return	self

setUsername() public method

Set username.

public setUsername ( string $username ) : self
$username	string
return	self

unserialize() public method

Constructs the object.

See link: http://php.net/manual/en/serializable.unserialize.php

public unserialize ( string $serialized )
$serialized	string	The string representation of the object

Property Details

$apiKey protected_oe property

protected string $apiKey
return	string

$confirmationKey protected_oe property

protected string $confirmationKey
return	string

$email protected_oe property

protected string $email
return	string

$enabled protected_oe property

protected bool $enabled
return	boolean

$id protected_oe property

protected int $id
return	integer

$lastLogin protected_oe property

protected DateTime $lastLogin
return	DateTime

$locale protected_oe property

protected string $locale
return	string

$locked protected_oe property

protected bool $locked
return	boolean

$password protected_oe property

protected string $password
return	string

$passwordResetToken protected_oe property

protected string $passwordResetToken
return	string

$privateKey protected_oe property

protected string $privateKey
return	string

$salt protected_oe property

protected string $salt
return	string

$username protected_oe property

protected string $username
return	string