Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
UserXMLParser Class Reference

Public Member Functions

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

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 19 of file UserXMLParser.inc.php.

Member Function Documentation

UserXMLParser::generatePassword ( $user)

Generate a random password for a user.

Parameters
$userImportedUser the user to be modified by this function

Definition at line 369 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
$userImportedUser the user to be modified by this function

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

References DAORegistry\getDAO(), and String\regexp_replace().

Referenced by importUsers().

& UserXMLParser::getErrors ( )

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

Returns
array string

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

& UserXMLParser::getImportedUsers ( )

Return the set of users who were successfully imported.

Returns
array ImportedUsers

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

& UserXMLParser::getUsersToImport ( )

Return the set of parsed users.

Returns
array ImportedUsers

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

UserXMLParser::importUsers (   $sendNotify = false,
  $continueOnError = false 
)

Import the parsed users into the system.

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

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

References Validation\encryptCredentials(), generatePassword(), generateUsername(), and DAORegistry\getDAO().

& UserXMLParser::parseData (   $file)

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

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

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

References DAORegistry\getDAO(), AppLocale\getPrimaryLocale(), PKPRequest\getSite(), Config\getVar(), PKPLocale\isLocaleValid(), and validRole().

Referenced by UserImportExportPlugin\executeCLI().

UserXMLParser::setUsersToImport (   $users)

Specify the set of parsed users.

Parameters
$usersToImportImportedUsers

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

UserXMLParser::UserXMLParser (   $journalId)

Constructor.

Parameters
$journalIdint assumed to be a valid journal ID

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

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
$roleTypestring
Returns
boolean

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

Referenced by parseData().


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