Detailed Description

Default implementation of a user that is persistent.

Author
ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

Definition at line 25 of file AbstractUser.php.

+ Inheritance diagram for AbstractUser:

Public Member Functions

 setLogin ($login)
 
 getLogin ()
 
 setPassword ($password)
 
 getPassword ()
 
 verifyPassword ($password)
 
 setIsActive ($isActive)
 
 isActive ()
 
 setIsSuperUser ($isSuperUser)
 
 isSuperUser ()
 
 setConfig ($config)
 
 getConfig ()
 
 hasRole ($roleName)
 
 getRoles ()
 
 beforeInsert ()
 
 beforeUpdate ()
 
 beforeDelete ()
 
 setValue ($name, $value, $forceSet=false, $trackChange=true)
 
 validateValue ($name, $value)
 
- Public Member Functions inherited from Node
 __construct (ObjectId $oid=null, array $initialData=null)
 
 __clone ()
 
 getValueNames ($excludeTransient=false)
 
 getValue ($name)
 
 removeValue ($name)
 
 getIndispensableObjects ()
 
 mergeValues (PersistentObject $object)
 
 getRelationNames ()
 
 addNode (PersistentObject $other, $role=null, $forceSet=false, $trackChange=true, $updateOtherSide=true)
 
 getAddedNodes ()
 
 deleteNode (PersistentObject $other, $role=null, $updateOtherSide=true)
 
 getDeletedNodes ()
 
 setNodeOrder (array $orderedList, array $movedList=null, $role=null)
 
 getNodeOrder ()
 
 loadChildren ($role=null, $buildDepth=BuildDepth::SINGLE)
 
 getNumChildren ($memOnly=true)
 
 getFirstChild ($role=null, $type=null, $values=null, $properties=null, $useRegExp=true)
 
 getChildren ($memOnly=true)
 
 getChildrenEx (ObjectId $oid=null, $role=null, $type=null, $values=null, $properties=null, $useRegExp=true)
 
 getPossibleChildren ()
 
 loadParents ($role=null, $buildDepth=BuildDepth::SINGLE)
 
 getNumParents ($memOnly=true)
 
 getParent ()
 
 getFirstParent ($role=null, $type=null, $values=null, $properties=null, $useRegExp=true)
 
 getParents ($memOnly=true)
 
 getParentsEx (ObjectId $oid=null, $role=null, $type=null, $values=null, $properties=null, $useRegExp=true)
 
 getPossibleParents ()
 
 getNodeRelation ($object)
 
 getRelatives ($hierarchyType, $memOnly=true)
 
 getNumRelatives ($hierarchyType, $memOnly=true)
 
 acceptVisitor ($visitor)
 
 addRelation ($name)
 
 getDisplayValue ()
 
 __toString ()
 
- Public Member Functions inherited from DefaultPersistentObject
 getType ()
 
 getMapper ()
 
 getOID ()
 
 setOID (ObjectId $oid)
 
 getState ()
 
 setState ($state)
 
 delete ()
 
 copyValues (PersistentObject $object, $copyPkValues=true)
 
 clearValues ()
 
 reset ()
 
 afterCreate ()
 
 afterInsert ()
 
 afterLoad ()
 
 afterUpdate ()
 
 afterDelete ()
 
 hasValue ($name)
 
 validateValues ()
 
 getChangedValues ()
 
 getOriginalValue ($name)
 
 getProperty ($name)
 
 setProperty ($name, $value)
 
 getPropertyNames ()
 
 getValueProperty ($name, $property)
 
 setValueProperty ($name, $property, $value)
 
 getValuePropertyNames ($name)
 
 dump ()
 
 serialize ()
 
 unserialize ($serialized)
 
- Public Member Functions inherited from User
 getOID ()
 

Protected Member Functions

 ensureHashedPassword ()
 
 setRoleConfig ()
 
 getAuthUser ()
 
- Protected Member Functions inherited from Node
 loadRelations (array $roles, $buildDepth=BuildDepth::SINGLE)
 
 getRelations ($hierarchyType='all')
 
- Protected Member Functions inherited from DefaultPersistentObject
 setOIDInternal (ObjectId $oid, $triggerListeners)
 
 setValueInternal ($name, $value)
 
 validateValueAgainstValidateType ($name, $value)
 

Static Protected Member Functions

static getRoleConfigs ()
 
- Static Protected Member Functions inherited from Node
static mergeObjectLists ($list1, $list2)
 

Additional Inherited Members

- Static Public Member Functions inherited from Node
static filter (array $nodeList, ObjectId $oid=null, $type=null, $values=null, $properties=null, $useRegExp=true)
 
- Public Attributes inherited from Node
const RELATION_STATE_UNINITIALIZED = -1
 
const RELATION_STATE_INITIALIZING = -2
 
const RELATION_STATE_INITIALIZED = -3
 
const RELATION_STATE_LOADED = -4
 
- Public Attributes inherited from PersistentObject
const STATE_CLEAN = 0
 
const STATE_DIRTY = 1
 
const STATE_NEW = 2
 
const STATE_DELETED = 3
 

Member Function Documentation

◆ setLogin()

setLogin (   $login)
See also
User::setLogin()

Implements User.

Definition at line 34 of file AbstractUser.php.

◆ getLogin()

getLogin ( )
See also
User::getLogin()

Implements User.

Definition at line 41 of file AbstractUser.php.

◆ setPassword()

setPassword (   $password)
See also
User::setPassword()

Implements User.

Definition at line 48 of file AbstractUser.php.

◆ getPassword()

getPassword ( )
See also
User::getPassword()

Implements User.

Definition at line 55 of file AbstractUser.php.

◆ verifyPassword()

verifyPassword (   $password)
See also
User::verifyPassword()

Implements User.

Definition at line 62 of file AbstractUser.php.

◆ setIsActive()

setIsActive (   $isActive)
See also
User::setIsActive()

Implements User.

Definition at line 69 of file AbstractUser.php.

◆ isActive()

isActive ( )
See also
User::isActive()

Implements User.

Definition at line 76 of file AbstractUser.php.

◆ setIsSuperUser()

setIsSuperUser (   $isSuperUser)
See also
User::setIsSuperUser()

Implements User.

Definition at line 83 of file AbstractUser.php.

◆ isSuperUser()

isSuperUser ( )
See also
User::isSuperUser()

Implements User.

Definition at line 90 of file AbstractUser.php.

◆ setConfig()

setConfig (   $config)
See also
User::setConfig()

Implements User.

Definition at line 97 of file AbstractUser.php.

◆ getConfig()

getConfig ( )
See also
User::getConfig()

Implements User.

Definition at line 104 of file AbstractUser.php.

◆ hasRole()

hasRole (   $roleName)
See also
User::hasRole()

Implements User.

Definition at line 111 of file AbstractUser.php.

◆ getRoles()

getRoles ( )
See also
User::getRoles()

Implements User.

Definition at line 124 of file AbstractUser.php.

◆ beforeInsert()

beforeInsert ( )
See also
PersistentObject::beforeInsert()

Reimplemented from DefaultPersistentObject.

Definition at line 135 of file AbstractUser.php.

◆ beforeUpdate()

beforeUpdate ( )
See also
PersistentObject::beforeUpdate()

Reimplemented from DefaultPersistentObject.

Definition at line 142 of file AbstractUser.php.

◆ beforeDelete()

beforeDelete ( )
See also
PersistentObject::beforeDelete()

Reimplemented from DefaultPersistentObject.

Definition at line 150 of file AbstractUser.php.

◆ ensureHashedPassword()

ensureHashedPassword ( )
protected

Hash password property if not done already.

Definition at line 160 of file AbstractUser.php.

◆ setRoleConfig()

setRoleConfig ( )
protected

Set the configuration of the currently associated role, if no configuration is set already.

Definition at line 172 of file AbstractUser.php.

◆ setValue()

setValue (   $name,
  $value,
  $forceSet = false,
  $trackChange = true 
)
See also
PersistentObject::setValue()

Reimplemented from Node.

Definition at line 193 of file AbstractUser.php.

◆ validateValue()

validateValue (   $name,
  $value 
)
See also
PersistentObject::validateValue()

Reimplemented from DefaultPersistentObject.

Definition at line 204 of file AbstractUser.php.

◆ getRoleConfigs()

static getRoleConfigs ( )
staticprotected

Get the role configurations from the application configuration.

Returns
Array with role names as keys and config file names as values

Definition at line 236 of file AbstractUser.php.

◆ getAuthUser()

getAuthUser ( )
protected

Get the currently authenticated user.

Returns
User

Definition at line 251 of file AbstractUser.php.