wCMF  3.6
 All Classes Namespaces Files Functions Variables Groups Pages
UserManagerXML Class Reference
+ Inheritance diagram for UserManagerXML:

Public Member Functions

 openConnection ($lock=true)
 
 closeConnection ()
 
 validateChanges ()
 
 startTransaction ()
 
 commitTransaction ()
 
 rollbackTransaction ()
 
 initialize ($params)
 
createUserInstance ()
 
createRoleInstance ()
 
createUserImpl ($name, $firstname, $login, $password)
 
 removeUserImpl (&$user)
 
 setUserPropertyImpl (&$user, $property, $value)
 
createRoleImpl ($name)
 
 removeRoleImpl (&$role)
 
 setRolePropertyImpl (&$role, $property, $value)
 
 addUserToRoleImpl (&$role, &$user)
 
 removeUserFromRoleImpl (&$role, &$user)
 
- Public Member Functions inherited from UserManager
 UserManager ($params)
 
 encryptPassword ($password)
 
 onError ($message, $file='', $line='')
 
 startTransaction ()
 
 commitTransaction ()
 
 rollbackTransaction ()
 
createUser ($name, $firstname, $login, $password, $passwordRepeated)
 
 removeUser ($login)
 
 setUserProperty ($login, $property, $value)
 
 resetPassword ($login, $newPassword, $newPasswordRepeated)
 
 changePassword ($login, $oldPassword, $newPassword, $newPasswordRepeated)
 
createRole ($name)
 
 removeRole ($name)
 
 setRoleProperty ($name, $property, $value)
 
 addUserToRole ($rolename, $login)
 
 removeUserFromRole ($rolename, $login)
 
 listUsers ()
 
 listRoles ()
 
 listUserRoles ($login)
 
 listRoleMembers ($rolename)
 
getUser ($login)
 
getRole ($name)
 
getPrincipal ($oid)
 
 removePrincipal ($oid)
 
 getUserClassName ()
 
 getRoleClassName ()
 
 initialize ($params)
 
createUserImpl ($name, $firstname, $login, $password)
 
 removeUserImpl (&$user)
 
 setUserPropertyImpl (&$user, $property, $value)
 
createRoleImpl ($name)
 
 removeRoleImpl (&$role)
 
 setRolePropertyImpl (&$role, $property, $value)
 
 addUserToRoleImpl (&$role, &$user)
 
 removeUserFromRoleImpl (&$role, &$user)
 

Public Attributes

 $_xml = null
 
 $_old_error_handler = null
 
 $_initParams = null
 
 $_fileOpened = false
 
- Public Attributes inherited from UserManager
 $_initParams = null
 
 $_userRepository = null
 
 $_roleConfig = null
 

Detailed Description

UserManagerXML is a UserManager that stores user and role information in an XML file.

wCMF - wemove Content Management Framework Copyright (C) 2005-2014 wemove digital solutions GmbH

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

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

Id:
class.UserManagerXML.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 31 of file class.UserManagerXML.php.

Member Function Documentation

UserManagerXML::openConnection (   $lock = true)

Open the XML database.

Parameters
lockTrue/False wether a lock is required or not

Definition at line 43 of file class.UserManagerXML.php.

References WCMFException\throwEx().

Referenced by initialize(), and startTransaction().

+ Here is the call graph for this function:

UserManagerXML::closeConnection ( )

Close the XML database.

Definition at line 72 of file class.UserManagerXML.php.

Referenced by commitTransaction(), and rollbackTransaction().

UserManagerXML::validateChanges ( )

Set Modification flag if no error occured.

Definition at line 83 of file class.UserManagerXML.php.

References WCMFException\throwEx().

Referenced by addUserToRoleImpl(), createRoleImpl(), createUserImpl(), removeRoleImpl(), removeUserFromRoleImpl(), removeUserImpl(), setRolePropertyImpl(), and setUserPropertyImpl().

+ Here is the call graph for this function:

UserManagerXML::startTransaction ( )
See Also
UserManager::startTransaction()

Definition at line 98 of file class.UserManagerXML.php.

References openConnection().

+ Here is the call graph for this function:

UserManagerXML::commitTransaction ( )
See Also
UserManager::commitTransaction()

Definition at line 107 of file class.UserManagerXML.php.

References closeConnection().

+ Here is the call graph for this function:

UserManagerXML::rollbackTransaction ( )
See Also
UserManager::rollbackTransaction()

Definition at line 116 of file class.UserManagerXML.php.

References closeConnection().

+ Here is the call graph for this function:

UserManagerXML::initialize (   $params)
See Also
UserManager::initialize()
Note
This class relies on the following dtd
<!ELEMENT XmlDatabase (#PCDATA | nextID | users | roles)*>

<!ELEMENT nextID (#PCDATA)>

<!ELEMENT users (#PCDATA | user)*>
<!ELEMENT user (#PCDATA | name | firstname | login | password | config | userroles)*>
<!ATTLIST user id CDATA #IMPLIED>
<!ELEMENT firstname (#PCDATA)>
<!ELEMENT login (#PCDATA)>
<!ELEMENT password (#PCDATA)>
<!ELEMENT config (#PCDATA)>
<!ELEMENT userroles (#PCDATA | roleid)*>
<!ELEMENT roleid (#PCDATA)>

<!ELEMENT roles (#PCDATA | role)*>
<!ELEMENT role (#PCDATA | name)*>
<!ATTLIST role id CDATA #IMPLIED>

<!ELEMENT name (#PCDATA)>
Initialization data given in the constructor require the following keys: filename

Definition at line 154 of file class.UserManagerXML.php.

References createRoleInstance(), createUserInstance(), and openConnection().

+ Here is the call graph for this function:

& UserManagerXML::createUserInstance ( )

Create a user instance

Definition at line 208 of file class.UserManagerXML.php.

References UserManager\getUserClassName().

Referenced by initialize().

+ Here is the call graph for this function:

& UserManagerXML::createRoleInstance ( )

Create a role instance

Definition at line 217 of file class.UserManagerXML.php.

References UserManager\getRoleClassName().

Referenced by initialize().

+ Here is the call graph for this function:

& UserManagerXML::createUserImpl (   $name,
  $firstname,
  $login,
  $password 
)
See Also
UserManager::createUserImpl()

Definition at line 226 of file class.UserManagerXML.php.

References UserManager\getUserClassName(), and validateChanges().

+ Here is the call graph for this function:

UserManagerXML::removeUserImpl ( $user)
See Also
UserManager::removeUserImpl()

Definition at line 269 of file class.UserManagerXML.php.

References validateChanges().

+ Here is the call graph for this function:

UserManagerXML::setUserPropertyImpl ( $user,
  $property,
  $value 
)
See Also
UserManager::setUserPropertyImpl()

Definition at line 285 of file class.UserManagerXML.php.

References validateChanges().

+ Here is the call graph for this function:

& UserManagerXML::createRoleImpl (   $name)
See Also
UserManager::createRoleImpl()

Definition at line 300 of file class.UserManagerXML.php.

References validateChanges().

+ Here is the call graph for this function:

UserManagerXML::removeRoleImpl ( $role)
See Also
UserManager::removeRoleImpl()

Definition at line 322 of file class.UserManagerXML.php.

References validateChanges().

+ Here is the call graph for this function:

UserManagerXML::setRolePropertyImpl ( $role,
  $property,
  $value 
)
See Also
UserManager::setRolePropertyImpl()

Definition at line 345 of file class.UserManagerXML.php.

References validateChanges().

+ Here is the call graph for this function:

UserManagerXML::addUserToRoleImpl ( $role,
$user 
)
See Also
UserManager::addUserToRoleImpl()

Definition at line 360 of file class.UserManagerXML.php.

References validateChanges().

+ Here is the call graph for this function:

UserManagerXML::removeUserFromRoleImpl ( $role,
$user 
)
See Also
UserManager::removeUserFromRoleImpl()

Definition at line 377 of file class.UserManagerXML.php.

References validateChanges().

+ Here is the call graph for this function:

Member Data Documentation

UserManagerXML::$_xml = null

Definition at line 33 of file class.UserManagerXML.php.

UserManagerXML::$_old_error_handler = null

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

UserManagerXML::$_initParams = null

Definition at line 36 of file class.UserManagerXML.php.

UserManagerXML::$_fileOpened = false

Definition at line 37 of file class.UserManagerXML.php.


The documentation for this class was generated from the following file: