Method |
Description |
|
__construct ( mixed $accountID ) |
Instantiates a user account. This is passed either "anonymous" or the Account ID
as the constructor parameter. User account login is done via the login method below. |
|
checkAccountExists ( $email ) : boolean |
Helper function to determine if a user account exists, as determined by their email address. |
|
copyConfiguration ( $data ) |
|
|
createAccount ( $accountInfo, boolean $isCurrentUser = false ) : integer |
Used (currently) in the installation script. Note: this function relies on the settings file having
been defined, along with an arbitrary encryption salt. |
|
deleteAccount ( $accountID ) |
|
|
deleteConfigurations ( $configurationIDs ) |
|
|
getAccount ( ) |
|
|
getAccountID ( ) |
|
|
getAccountType ( ) |
|
|
getConfigurations ( ) |
As of 3.2.1, configurations are now backed up for every time the user clicks save. This method continues
to work the same, but only returns the most recent configuration version from the history table. |
|
getCountryPlugins ( ) |
Returns the subset of Country plugins selected by this user. |
|
getDataSetHistory ( $configurationID ) |
|
|
getDataTypePlugins ( ) |
Returns the subset of Data Type plugins selected by this user. |
|
getDefaultExportType ( ) |
With 3.2.2, users can now customize the plugins they want to use, so Core::getDefaultExportType() is no longer
sufficient to figure out what tab should be selected in the UI on page load. This is now used instead. |
|
getExportTypePlugins ( ) |
Returns the subset of Export Type plugins selected by this user. |
|
getPublicDataSet ( $configurationID ) |
Loads ANY public data set. |
|
getSelectedCountries ( ) |
|
|
getSelectedDataTypes ( ) |
|
|
getSelectedExportTypes ( ) |
|
|
getUsers ( ) |
|
|
isAdmin ( ) |
|
|
isAnonymousAdmin ( ) |
|
|
login ( $email, $password ) |
Attempts to log a user in. If successful, it updates sessions and returns a success
message; otherwise, just returns the appropriate error |
|
logout ( ) |
|
|
resetPassword ( $email ) |
|
|
saveConfiguration ( $data ) |
|
|
saveDataSetVisibilityStatus ( $configurationID, $status, $time ) |
Time is currently passed but not used. It's going to be used to ensure that only NEWEST requests
actually update the record |
|
updateAccount ( $accountID, $info ) |
|
|
updateAccountByAdmin ( $info ) |
called by administrators to update a user's account |
|
updateRowsGeneratedCount ( $configurationID, $rowsGenerated ) |
|
|
updateSelectedPlugins ( $accountID, $dataTypes, $exportTypes, $countries ) |
|
|