UserXMLParser Class Reference
[Plugins_importexport_users]

Class to import and export user data from an XML format. See dbscripts/xml/dtd/users.dtd for the XML schema used. More...

List of all members.

Public Member Functions

 generatePassword (&$user)
 generateUsername (&$user)
getErrors ()
getImportedUsers ()
getUsersToImport ()
 importUsers ($sendNotify=false, $continueOnError=false)
parseData ($file)
 setUsersToImport ($users)
 UserXMLParser ($conferenceId, $schedConfId)
 validRole ($roleType)

Public Attributes

 $conferenceId
 $errors
 $importedUsers
 $parser
 $schedConfId
 $usersToImport


Detailed Description

Class to import and export user data from an XML format. See dbscripts/xml/dtd/users.dtd for the XML schema used.

Definition at line 20 of file UserXMLParser.inc.php.


Member Function Documentation

UserXMLParser.generatePassword ( &$  user  ) 

Generate a random password for a user.

Parameters:
$user ImportedUser the user to be modified by this function

Definition at line 365 of file UserXMLParser.inc.php.

References Validation.encryptCredentials(), and Validation.generatePassword().

Referenced by importUsers().

UserXMLParser.generateUsername ( &$  user  ) 

Generate a unique username for a user based on the user's name.

Parameters:
$user ImportedUser the user to be modified by this function

Definition at line 344 of file UserXMLParser.inc.php.

Referenced by importUsers().

& UserXMLParser.getErrors (  ) 

Return an array of error messages that occurred during the import.

Returns:
array string

Definition at line 326 of file UserXMLParser.inc.php.

& UserXMLParser.getImportedUsers (  ) 

Return the set of users who were successfully imported.

Returns:
array ImportedUsers

Definition at line 318 of file UserXMLParser.inc.php.

& UserXMLParser.getUsersToImport (  ) 

Return the set of parsed users.

Returns:
array ImportedUsers

Definition at line 302 of file UserXMLParser.inc.php.

UserXMLParser.importUsers ( sendNotify = false,
continueOnError = false 
)

Import the parsed users into the system.

Parameters:
$sendNotify boolean send an email notification to each imported user containing their username and password
$continueOnError boolean continue to import remaining users if a failure occurs
Returns:
boolean success

Definition at line 186 of file UserXMLParser.inc.php.

References Validation.encryptCredentials(), generatePassword(), and generateUsername().

& UserXMLParser.parseData ( file  ) 

Parse an XML users file into a set of users to import.

Parameters:
$file string path to the XML file to parse
Returns:
array ImportedUsers the collection of users read from the file

Definition at line 55 of file UserXMLParser.inc.php.

References AppLocale.getPrimaryLocale(), and validRole().

UserXMLParser.setUsersToImport ( users  ) 

Specify the set of parsed users.

Parameters:
$usersToImport ImportedUsers

Definition at line 310 of file UserXMLParser.inc.php.

UserXMLParser.UserXMLParser ( conferenceId,
schedConfId 
)

Constructor.

Parameters:
$schedConfId int assumed to be a valid sched conf ID

Definition at line 44 of file UserXMLParser.inc.php.

References $conferenceId, and $schedConfId.

UserXMLParser.validRole ( roleType  ) 

Check if a role type value identifies a valid role that can be imported. Note we do not allow users to be imported into the "admin" role.

Parameters:
$roleType string
Returns:
boolean

Definition at line 336 of file UserXMLParser.inc.php.

Referenced by parseData().


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7