Inheritance diagram for AuthUser:

Public Member Functions
	login ($login, $password, $isPasswordEncrypted=false)

	addPolicies ($policies)

	authorize ($actionKey)

	matchRoles ($val)

	parsePolicy ($val)

	setDefaultPolicy ($val)

	getLoginTime ()

	toString ()

	getType ()

	setLogin ($login)

	getLogin ()

	setPassword ($password)

	getPassword ()

	setName ($name)

	getName ()

	setFirstname ($firstname)

	getFirstname ()

	setConfig ($config)

	getConfig ()

	addRole ($rolename)

	removeRole ($rolename)

	hasRole ($rolename)

	getRoles ()

	getClassDefinitionFiles ()

	loadFromSession ()

Public Member Functions inherited from User
	User ($oid=null, $type='User')

&	getUser ($login, $password)

	getUserId ()

	setLogin ($login)

	getLogin ()

	setPassword ($password)

	getPassword ()

	setName ($name)

	getName ()

	setFirstname ($firstname)

	getFirstname ()

	setConfig ($config)

	getConfig ()

	addRole ($rolename, $commit=false)

	removeRole ($rolename, $commit=false)

	hasRole ($rolename)

	getRoles ()

&	getRoleByName ($rolename)

	resetRoleCache ()

Public Member Functions inherited from Node
	Node ($type, $oid=null)

	getNumChildren ($memOnly=true, $type=null)

	addChild (&$child, $addtype=ADDCHILD_BACK)

	updateParent (&$parent, $recursive=true)

	deleteChild ($childOID, $reallyDelete=false)

	loadChildren ($type, $buildDepth=BUILDDEPTH_SINGLE, $forceUpdate=false)

&	getFirstChild ($type, $values, $properties, $useRegExp=true)

	getChildren ()

	getChildrenEx ($oid, $type, $values, $properties, $useRegExp=true)

	sortChildren ($criteria, $recursive=false, $changeSortkey=false, $sortFunction='')

	sort (&$nodeList, $criteria, $recursive=false, $changeSortkey=false, $sortFunction='')

	filter (&$nodeList, $oid, $type, $values, $properties, $useRegExp=true)

	getNextSibling ()

	getPreviousSibling ()

	loadParents ($type, $forceUpdate=false)

	getNumParents ($memOnly=true, $type=null)

&	getParent ()

&	getFirstParent ($type, $values, $properties, $useRegExp=true)

&	getParents ()

	getParentsEx ($oid, $type, $values, $properties, $useRegExp=true)

	getDepth ()

	getPath ()

	acceptVisitor (&$visitor)

	setState ($state, $recursive=true)

	removeDuplicateOidsWithoutRole ($oids)

	getDisplayValue ($useDisplayType=false)

	getDisplayValues ($useDisplayType=false)

	toString ($verbose=false)

Public Member Functions inherited from PersistentObject
	PersistentObject ($type, $oid=null)

	getType ()

	setType ($type)

	getBaseType ()

	getOID ()

	getBaseOID ()

	setOID ($oid)

	getDBID ()

	setDBID ($id)

&	getMapper ()

&	getDataConverter ()

	save ()

	delete ($recursive=true)

	getState ()

	setState ($state, $recursive=true)

	setImmutable ()

	getLock ()

&	duplicate ()

	copyValues (&$object, $dataTypes=array(), $copyPkValues=true)

	copyValueIntern (&$node, $valueName, $dataType, &$targetNode, $dataTypes, $valuesToIgnore)

	clearValues ($dataTypes=array())

	clearValueIntern (&$node, $valueName, $dataType, $dataTypes)

	updateOID ()

	afterCreate ()

	beforeInsert ()

	afterInsert ()

	afterLoad ()

	beforeUpdate ()

	afterUpdate ()

	beforeDelete ()

	afterDelete ()

	hasValue ($name, $type=null)

	getValue ($name, $type=null)

	removeValue ($name, $type=null)

	getUnconvertedValue ($name, $type=null)

	getConvertedValue ($name, $type=null)

	getValueTypes ($name)

	validateValues ()

	validateValueIntern (&$node, $valueName, $dataType, &$errorMsg)

	validateValue ($name, $value, $type=null)

	validateValueAgainstRestrictions ($name, $value, $type=null)

	setValue ($name, $value, $type=null, $forceSet=false)

	getValueProperties ($name, $type=null)

	setValueProperties ($name, $properties, $type=null)

	getValueProperty ($name, $property, $type=null)

	setValueProperty ($name, $property, $value, $type=null)

	getValueNames ($type=null)

	getDataTypes ()

	getProperty ($name)

	setProperty ($name, $value)

	getPropertyNames ()

	addChangeListener (&$listener)

	removeChangeListener (&$listener)

	propagateValueChange ($name, $type, $oldValue, $newValue)

	propagatePropertyChange ($name, $oldValue, $newValue)

	propagateStateChange ($oldValue, $newValue)

	getObjectDisplayName ()

	getObjectDescription ()

	getDisplayValue ()

	getValueDisplayName ($name, $type=null)

	getValueDescription ($name, $type=null)

	toString ($verbose=false)

	isIndexInSearch ()

Public Member Functions inherited from Storable
	getClassDefinitionFiles ()

	loadFromSession ()

	saveToSession ()

Public Attributes
	$_login_time = ""

	$_policies = array()

	$_defaulPolicy = true

	$_user = null

Public Attributes inherited from User
	$_cachedRoles = array()

	$_hasOwnRolesLoaded = false

Public Attributes inherited from Node
	$_children = array()

	$_parents = array()

	$_depth = -1

	$_path = ''

Public Attributes inherited from PersistentObject
	$_oid = null

	$_type = ''

	$_data = array()

	$_properties = array()

	$_state = STATE_CLEAN

	$_isImmutable = false

	$_changeListeners = array()

Detailed Description

AuthUser provides a storage and methods for user data used for authentication/authorization purposes. This class requires php >= 4.1.0.

Licensed under the terms of any of the following licenses at your choice:

GNU Lesser General Public License (LGPL) http://www.gnu.org/licenses/lgpl.html
Eclipse Public License (EPL) http://www.eclipse.org/org/documents/epl-v10.php

See the license.txt file distributed with this work for additional information.

Id:: class.AuthUser.php 1462 2014-02-04 23:52:27Z iherwig

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

Definition at line 34 of file class.AuthUser.php.

Member Function Documentation

AuthUser::login	(	$login,
		$password,
		$isPasswordEncrypted = `false`
	)

Log a user into the application.

Parameters

login	The login string of the user
password	The password string of the user
isPasswordEncrypted	True/False wether the password is encrypted or not [default: false]

Returns: True/False whether login succeeded.

Definition at line 48 of file class.AuthUser.php.

References $GLOBALS, addPolicies(), BUILDDEPTH_SINGLE, UserManager\encryptPassword(), getConfig(), PersistenceFacade\getInstance(), InifileParser\getInstance(), RightsManager\getInstance(), UserManager\getUserClassName(), PersistentObject\setOID(), and WCMFException\throwEx().

Here is the call graph for this function:

AuthUser::addPolicies ( $policies )

Adds one ore more policies to the policy repository of the user.

Parameters

policies An associative array with the policy information (key=action, value=policy string).

Note: A policy string looks like this "+*, -guest, +admin"

Definition at line 106 of file class.AuthUser.php.

References parsePolicy().

Referenced by login().

Here is the call graph for this function:

AuthUser::authorize ( $actionKey )

Checks, if the user is authorized for this action. Returns defaulPolicy if action key is not defined.

Parameters

actionKey An action key string

Returns: True/False whether authorization succeeded

Definition at line 124 of file class.AuthUser.php.

References $_defaulPolicy, and matchRoles().

Here is the call graph for this function:

AuthUser::matchRoles ( $val )

Matches the roles of the user and the roles for a certain key

Parameters

val	An array containing policy information as an associative array with the keys ('default', 'allow', 'deny'). Where 'allow', 'deny' are arrays itselves holding roles. 'allow' overwrites 'deny' overwrites 'default'

Returns: True/False whether the user has access right according to this policy.

Definition at line 141 of file class.AuthUser.php.

References hasRole().

Referenced by authorize().

Here is the call graph for this function:

AuthUser::parsePolicy ( $val )

Parse an policy string and returns an associative array with the keys ('default', 'allow', 'deny'). Where 'allow', 'deny' are arrays itselves holding roles. 'deny' overwrites 'allow' overwrites 'default'

Parameters