Documentation

User extends User
in package
implements Proxy

DO NOT EDIT THIS FILE - IT WAS CREATED BY DOCTRINE'S PROXY GENERATOR

Table of Contents

Interfaces

Proxy

Properties

$__cloner__  : Closure
$__initializer__  : Closure
$__isInitialized__  : bool
$lazyPropertiesDefaults  : array<string|int, mixed>
$localeCodes  : array<string|int, mixed>
List of locale codes ordered by translation fallback order per Cx instance
$nestingCount  : int
Counts the nesting level of __call()
$stringRepresentationBlank  : bool
Whether blank string representations are valid
$stringRepresentationFields  : array<string|int, mixed>
List of fields that should be available in the string representation
$stringRepresentationFormat  : string
Sprintf format for the string representation
$validators  : array<string|int, mixed>
Initialize this array as follows: array( 'columName' => Zend_Validate )
$virtual  : bool
Defines if an entity is virtual and therefore not persistable.
$active  : int
$authToken  : string
$authTokenTimeout  : int
$backendLangId  : int
$email  : string
$emailAccess  : string
$expiration  : int
$frontendLangId  : int
$group  : Collection
$id  : int
$isAdmin  : int
$lastActivity  : int
$lastAuth  : int
$lastAuthStatus  : int
$password  : string
$primaryGroup  : int
$profileAccess  : string
$regdate  : int
$restoreKey  : string
$restoreKeyTime  : int
$username  : string
$userProfile  : UserProfile
$validity  : int
$verified  : int

Methods

__call()  : mixed
{@inheritDoc}
__clone()  : mixed
__construct()  : mixed
__get()  : mixed
{@inheritDoc}
__getCloner()  : mixed
{@inheritDoc}
__getInitializer()  : mixed
{@inheritDoc}
__getLazyProperties()  : mixed
{@inheritDoc}
__isInitialized()  : mixed
{@inheritDoc}
__load()  : mixed
Forces initialization of the proxy
__setCloner()  : mixed
{@inheritDoc}
__setInitialized()  : mixed
{@inheritDoc}
__setInitializer()  : mixed
{@inheritDoc}
__sleep()  : array<string|int, mixed>
__toString()  : mixed
{@inheritDoc}
__wakeup()  : mixed
addGroup()  : mixed
Add group
getActive()  : int
Get active
getAuthToken()  : string
Get authToken
getAuthTokenTimeout()  : int
Get authTokenTimeout
getBackendLangId()  : int
Get backendLangId
getComponentController()  : mixed
{@inheritDoc}
getEmail()  : string
Get email
getEmailAccess()  : string
Get emailAccess
getExpiration()  : int
Get expiration
getFrontendLangId()  : int
Get frontendLangId
getGroup()  : Collection
Get group
getId()  : int
Get id
getIsAdmin()  : int
Get isAdmin
getKeyAsString()  : string
Returns this entity's key
getLastActivity()  : int
Get lastActivity
getLastAuth()  : int
Get lastAuth
getLastAuthStatus()  : int
Get lastAuthStatus
getPassword()  : string
Get password
getPrimaryGroup()  : int
Get primaryGroup
getProfileAccess()  : string
Get profileAccess
getRegdate()  : int
Get regdate
getRestoreKey()  : string
Get restoreKey
getRestoreKeyTime()  : int
Get restoreKeyTime
getTranslatedFieldValue()  : mixed
{@inheritDoc}
getUsername()  : string
Get username
getUserProfile()  : UserProfile
Get userProfile
getValidity()  : int
Get validity
getVerified()  : int
Get verified
initializeValidators()  : mixed
{@inheritDoc}
isBackendGroupUser()  : bool
Check if the user is backend group
isVirtual()  : mixed
{@inheritDoc}
removeGroup()  : mixed
Remove the group
setActive()  : mixed
Set active
setAuthToken()  : mixed
Set authToken
setAuthTokenTimeout()  : mixed
Set $authTokenTimeout
setBackendLangId()  : mixed
Set backendLangId
setEmail()  : mixed
Set email
setEmailAccess()  : mixed
Set emailAccess
setExpiration()  : mixed
Set expiration
setFrontendLangId()  : mixed
Set frontendLangId
setId()  : mixed
set id
setIsAdmin()  : mixed
Set isAdmin
setLastActivity()  : mixed
Set lastActivity
setLastAuth()  : mixed
Set lastAuth
setLastAuthStatus()  : mixed
Set lastAuthStatus
setPassword()  : mixed
Set password
setPrimaryGroup()  : mixed
Set primaryGroup
setProfileAccess()  : mixed
Set profileAccess
setRegdate()  : mixed
Set regdate
setRestoreKey()  : mixed
Set restoreKey
setRestoreKeyTime()  : mixed
Set restoreKeyTime
setUsername()  : mixed
Set username
setUserProfile()  : mixed
Set userProfile
setValidity()  : mixed
Set validity
setVerified()  : mixed
Set verified
setVirtual()  : mixed
{@inheritDoc}
validate()  : mixed
{@inheritDoc}
getFallbackLocaleCodes()  : array<string|int, mixed>
Returns a list of all locale codes ordered by fallback order
getStringRepresentationBlank()  : bool
Whether blank string representations are valid
getStringRepresentationFields()  : array<string|int, mixed>
Returns a list of fields available in the string representation
getStringRepresentationFormat()  : string
Returns the sprintf() format for the string representation

Properties

$__cloner__

public Closure $__cloner__

the callback responsible of loading properties that need to be copied in the cloned object

Tags
see
Proxy::__setCloner

$__initializer__

public Closure $__initializer__

the callback responsible for loading properties in the proxy object. This callback is called with three parameters, being respectively the proxy object to be initialized, the method that triggered the initialization process and an array of ordered parameters that were passed to that method.

Tags
see
Proxy::__setInitializer

$__isInitialized__

public bool $__isInitialized__ = false

flag indicating if this object was already initialized

Tags
see
Proxy::__isInitialized

$lazyPropertiesDefaults

public static array<string|int, mixed> $lazyPropertiesDefaults = array()

properties to be lazy loaded, with keys being the property names and values being their default values

Tags
see
Proxy::__getLazyProperties

$localeCodes

List of locale codes ordered by translation fallback order per Cx instance

protected static array<string|int, mixed> $localeCodes = array()

Array in the form: array(<instanceId> => array(<localeCode>, ...))

Tags
see
getFallbackLocaleCodes()

$nestingCount

Counts the nesting level of __call()

protected static int $nestingCount = 0

$stringRepresentationBlank

Whether blank string representations are valid

protected bool $stringRepresentationBlank = false

Whether blank string representations are valid

Tags
see
getStringRepresentationBlank()

$stringRepresentationFields

List of fields that should be available in the string representation

protected array<string|int, mixed> $stringRepresentationFields = array()

List of field names

Tags
see
getStringRepresentationFields()

$stringRepresentationFormat

Sprintf format for the string representation

protected string $stringRepresentationFormat = ''

Sprintf format string

Tags
see
getStringRepresentationFormat()

$validators

Initialize this array as follows: array( 'columName' => Zend_Validate )

protected array<string|int, mixed> $validators = array()

$virtual

Defines if an entity is virtual and therefore not persistable.

protected bool $virtual = false

Defaults to FALSE - not virtual.

Methods

__call()

{@inheritDoc}

public __call(mixed $methodName, mixed $arguments) : mixed
Parameters
$methodName : mixed
$arguments : mixed

__construct()

public __construct([Closure $initializer = null ][, Closure $cloner = null ]) : mixed
Parameters
$initializer : Closure = null
$cloner : Closure = null

__getCloner()

{@inheritDoc}

public __getCloner() : mixed
Tags
internal

generated method: use only when explicitly handling proxy specific cloning logic

__getInitializer()

{@inheritDoc}

public __getInitializer() : mixed
Tags
internal

generated method: use only when explicitly handling proxy specific loading logic

__getLazyProperties()

{@inheritDoc}

public __getLazyProperties() : mixed
Tags
internal

generated method: use only when explicitly handling proxy specific loading logic

static

__isInitialized()

{@inheritDoc}

public __isInitialized() : mixed
Tags
internal

generated method: use only when explicitly handling proxy specific loading logic

__setCloner()

{@inheritDoc}

public __setCloner([Closure $cloner = null ]) : mixed
Parameters
$cloner : Closure = null
Tags
internal

generated method: use only when explicitly handling proxy specific loading logic

__setInitialized()

{@inheritDoc}

public __setInitialized(mixed $initialized) : mixed
Parameters
$initialized : mixed
Tags
internal

generated method: use only when explicitly handling proxy specific loading logic

__setInitializer()

{@inheritDoc}

public __setInitializer([Closure $initializer = null ]) : mixed
Parameters
$initializer : Closure = null
Tags
internal

generated method: use only when explicitly handling proxy specific loading logic

getKeyAsString()

Returns this entity's key

public final getKeyAsString([string $separator = '/' ]) : string

If this entity has a composite key, the fields are separated by $separator.

Parameters
$separator : string = '/'

(optional) Separator for composite key fields, default "/"

Return values
string —

Entity key as string

setAuthTokenTimeout()

Set $authTokenTimeout

public setAuthTokenTimeout(mixed $authTokenTimeout) : mixed
Parameters
$authTokenTimeout : mixed

getFallbackLocaleCodes()

Returns a list of all locale codes ordered by fallback order

protected getFallbackLocaleCodes() : array<string|int, mixed>
  • First entry is the current locale
  • Second entry is the default locale (if different from current, it's omitted otherwise)
  • Then all other locales follow (in no particular order)
Tags
todo

Order the array by the fallback order (same as in ContentManager)

Return values
array<string|int, mixed> —

List of locale codes

getStringRepresentationBlank()

Whether blank string representations are valid

protected getStringRepresentationBlank() : bool
Return values
bool —

Whether blank string representations are valid

getStringRepresentationFields()

Returns a list of fields available in the string representation

protected getStringRepresentationFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —

List of field names

getStringRepresentationFormat()

Returns the sprintf() format for the string representation

protected getStringRepresentationFormat() : string
Return values
string —

sprintf() format string


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results