APIUser
extends APIFactory
in package
Table of Contents
- $data : mixed
- $api_message_id : mixed
- $current_company : mixed
- $current_user : mixed
- $current_user_prefs : mixed
- $main_class : mixed
- $main_class_obj : mixed
- $pager_obj : mixed
- $permission : mixed
- $progress_bar_obj : mixed
- __construct() : mixed
- APIUser constructor.
- changePassword() : array<string|int, mixed>|bool
- Allows currently logged in user to change their password.
- convertAPIReturnHandlerToValidatorObject() : bool|Validator
- Take a API ReturnHandler array and pulls out the Validation errors/warnings to be merged back into another Validator This is useful for calling one API function from another one when their are sub-classes.
- convertToMultipleRecords() : array<string|int, mixed>
- convertToSingleRecord() : mixed
- copyUser() : array<string|int, mixed>
- Copy one or more users.
- deleteImage() : array<string|int, mixed>|bool
- deleteUser() : array<string|int, mixed>|bool
- Delete one or more users.
- exportRecords() : array<string|int, mixed>|bool
- Download a result_set as a csv.
- exportUser() : array<string|int, mixed>|bool
- getAPIMessageID() : bool|null
- Returns the API messageID for each individual call.
- getCommonUserData() : array<string|int, mixed>
- Get only the fields that are common across all records in the search criteria. Used for Mass Editing of records.
- getCompanyUser() : array<string|int, mixed>
- Get user data for one or more users. This is an alias for getUser() that can be overridden by a plugin for getting data on remote servers.
- getCurrentCompanyObject() : bool|CompanyFactory
- getCurrentUserObject() : bool|UserFactory
- getCurrentUserPreferenceObject() : bool|UserPreferenceFactory
- getMainClassObject() : string
- getNextInsertID() : string
- getOptions() : array<string|int, mixed>|bool
- Bridge to main class getOptions factory.
- getOptionsBatch() : array<string|int, mixed>
- Bridge multiple batched requests to main class getOptions factory.
- getPagerData() : array<string|int, mixed>|bool
- getPagerObject() : Pager
- getPermissionChildren() : array<string|int, mixed>
- getPermissionObject() : bool|null|Permission
- getProgressBarObject() : null|ProgressBar
- getProtocolVersion() : int
- getUniqueUserProvinces() : array<string|int, mixed>
- Returns a list of unique provinces that employees are assigned to.
- getUser() : array<string|int, mixed>|bool
- Get user data for one or more users.
- getUserDefaultData() : array<string|int, mixed>
- Get default user data for creating new users.
- getUserPendingTotals() : array<string|int, mixed>
- Get the number of pending authorizations, notifications and messages for the current user.
- getVariableToFunctionMap() : array<string|int, mixed>
- Bridge to main class getVariableToFunctionMap factory.
- handlePermissionFilterColumns() : array<string|int, mixed>|null
- In cases where data can be displayed in just a list_view (dropdown boxes), ie: branch, department, job, task in In/Out punch view restrict the dropdown box to just a subset of columns, so not all data is shown.
- handleRecordValidationResults() : array<string|int, mixed>
- initializeFilterAndPager() : array<string|int, mixed>|bool
- isProgressBarStarted() : bool
- isUniqueUserName() : array<string|int, mixed>|bool
- Check if username is unique or not.
- returnHandler() : array<string|int, mixed>|bool
- Controls returning information to client in a standard format.
- sendValidationEmail() : bool
- setAPIMessageID() : bool
- setMainClassObject() : bool
- Allow storing the main class object persistently in memory, so we can build up other variables to help out things like getOptions() Mainly used for the APIReport class.
- setPagerObject() : bool
- setProgressBarObject() : bool
- setUser() : array<string|int, mixed>|bool
- Set user data for one or more users.
- setUserFeedbackRating() : array<string|int, mixed>|bool
- setUserFeedbackReview() : array<string|int, mixed>|bool
- setValidationArray() : array<string|int, mixed>|bool
- stripReturnHandler() : mixed
- UnsubscribeEmail() : bool
- validateUser() : array<string|int, mixed>
- Validate user data for one or more users.
Properties
$data
public
mixed
$data
= []
$api_message_id
protected
mixed
$api_message_id
= \null
$current_company
protected
mixed
$current_company
= \null
$current_user
protected
mixed
$current_user
= \null
$current_user_prefs
protected
mixed
$current_user_prefs
= \null
$main_class
protected
mixed
$main_class
= 'UserFactory'
$main_class_obj
protected
mixed
$main_class_obj
= \null
$pager_obj
protected
mixed
$pager_obj
= \null
$permission
protected
mixed
$permission
= \null
$progress_bar_obj
protected
mixed
$progress_bar_obj
= \null
Methods
__construct()
APIUser constructor.
public
__construct() : mixed
Return values
mixed —changePassword()
Allows currently logged in user to change their password.
public
changePassword(string $current_password, string $new_password, string $new_password2[, string $type = 'user_name' ]) : array<string|int, mixed>|bool
Parameters
- $current_password : string
- $new_password : string
- $new_password2 : string
- $type : string = 'user_name'
Return values
array<string|int, mixed>|bool —convertAPIReturnHandlerToValidatorObject()
Take a API ReturnHandler array and pulls out the Validation errors/warnings to be merged back into another Validator This is useful for calling one API function from another one when their are sub-classes.
public
convertAPIReturnHandlerToValidatorObject( $api_retarr[, bool $validator_obj = false ]) : bool|Validator
Parameters
Return values
bool|Validator —convertToMultipleRecords()
public
convertToMultipleRecords(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
Return values
array<string|int, mixed> —convertToSingleRecord()
public
convertToSingleRecord(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Return values
mixed —copyUser()
Copy one or more users.
public
copyUser(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
user data
Return values
array<string|int, mixed> —deleteImage()
public
deleteImage( $employee_id) : array<string|int, mixed>|bool
Parameters
Return values
array<string|int, mixed>|bool —deleteUser()
Delete one or more users.
public
deleteUser(array<string|int, mixed> $data) : array<string|int, mixed>|bool
Parameters
- $data : array<string|int, mixed>
-
user data
Return values
array<string|int, mixed>|bool —exportRecords()
Download a result_set as a csv.
public
exportRecords(string $format, string $file_name, array<string|int, mixed> $result, array<string|int, mixed> $filter_columns) : array<string|int, mixed>|bool
Parameters
- $format : string
- $file_name : string
- $result : array<string|int, mixed>
- $filter_columns : array<string|int, mixed>
Return values
array<string|int, mixed>|bool —exportUser()
public
exportUser([string $format = 'csv' ][, array<string|int, mixed> $data = null ][, bool $disable_paging = true ]) : array<string|int, mixed>|bool
Parameters
- $format : string = 'csv'
- $data : array<string|int, mixed> = null
- $disable_paging : bool = true
Return values
array<string|int, mixed>|bool —getAPIMessageID()
Returns the API messageID for each individual call.
public
getAPIMessageID() : bool|null
Return values
bool|null —getCommonUserData()
Get only the fields that are common across all records in the search criteria. Used for Mass Editing of records.
public
getCommonUserData(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
filter data
Return values
array<string|int, mixed> —getCompanyUser()
Get user data for one or more users. This is an alias for getUser() that can be overridden by a plugin for getting data on remote servers.
public
getCompanyUser([array<string|int, mixed> $data = null ][, bool $disable_paging = false ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed> = null
-
filter data, see reference for details.
- $disable_paging : bool = false
-
disables paging and returns all records.
Tags
Return values
array<string|int, mixed> —getCurrentCompanyObject()
public
getCurrentCompanyObject() : bool|CompanyFactory
Return values
bool|CompanyFactory —getCurrentUserObject()
public
getCurrentUserObject() : bool|UserFactory
Return values
bool|UserFactory —getCurrentUserPreferenceObject()
public
getCurrentUserPreferenceObject() : bool|UserPreferenceFactory
Return values
bool|UserPreferenceFactory —getMainClassObject()
public
getMainClassObject() : string
Return values
string —getNextInsertID()
public
getNextInsertID() : string
Return values
string —getOptions()
Bridge to main class getOptions factory.
public
getOptions([bool $name = false ][, string|int $parent = null ]) : array<string|int, mixed>|bool
Parameters
- $name : bool = false
- $parent : string|int = null
Return values
array<string|int, mixed>|bool —getOptionsBatch()
Bridge multiple batched requests to main class getOptions factory.
public
getOptionsBatch([array<string|int, mixed> $requested_options = [] ]) : array<string|int, mixed>
Parameters
- $requested_options : array<string|int, mixed> = []
Return values
array<string|int, mixed> —getPagerData()
public
getPagerData() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool —getPagerObject()
public
getPagerObject() : Pager
Return values
Pager —getPermissionChildren()
public
getPermissionChildren() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPermissionObject()
public
getPermissionObject() : bool|null|Permission
Return values
bool|null|Permission —getProgressBarObject()
public
getProgressBarObject() : null|ProgressBar
Return values
null|ProgressBar —getProtocolVersion()
public
getProtocolVersion() : int
Return values
int —getUniqueUserProvinces()
Returns a list of unique provinces that employees are assigned to.
public
getUniqueUserProvinces() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUser()
Get user data for one or more users.
public
getUser([array<string|int, mixed> $data = null ][, bool $disable_paging = false ]) : array<string|int, mixed>|bool
Parameters
- $data : array<string|int, mixed> = null
-
filter data, see reference for details.
- $disable_paging : bool = false
-
disables paging and returns all records.
Tags
Return values
array<string|int, mixed>|bool —getUserDefaultData()
Get default user data for creating new users.
public
getUserDefaultData([string $tmp_company_id = null ][, mixed $default_id = null ]) : array<string|int, mixed>
Parameters
- $tmp_company_id : string = null
-
UUID
- $default_id : mixed = null
Return values
array<string|int, mixed> —getUserPendingTotals()
Get the number of pending authorizations, notifications and messages for the current user.
public
getUserPendingTotals([array<string|int, mixed> $object_types = [] ]) : array<string|int, mixed>
Parameters
- $object_types : array<string|int, mixed> = []
Return values
array<string|int, mixed> —getVariableToFunctionMap()
Bridge to main class getVariableToFunctionMap factory.
public
getVariableToFunctionMap(string $name[, string|int $parent = null ]) : array<string|int, mixed>
Parameters
- $name : string
- $parent : string|int = null
Return values
array<string|int, mixed> —handlePermissionFilterColumns()
In cases where data can be displayed in just a list_view (dropdown boxes), ie: branch, department, job, task in In/Out punch view restrict the dropdown box to just a subset of columns, so not all data is shown.
public
handlePermissionFilterColumns(array<string|int, mixed> $filter_columns, array<string|int, mixed> $allowed_columns) : array<string|int, mixed>|null
Parameters
- $filter_columns : array<string|int, mixed>
- $allowed_columns : array<string|int, mixed>
Return values
array<string|int, mixed>|null —handleRecordValidationResults()
public
handleRecordValidationResults(object|bool $validator, array<string|int, mixed> $validator_stats, int $key, array<string|int, mixed>|bool $save_result[, bool $user_generic_status_batch_id = false ][, mixed $system_job_queue = false ]) : array<string|int, mixed>
Parameters
- $validator : object|bool
- $validator_stats : array<string|int, mixed>
- $key : int
- $save_result : array<string|int, mixed>|bool
- $user_generic_status_batch_id : bool = false
- $system_job_queue : mixed = false
Return values
array<string|int, mixed> —initializeFilterAndPager()
public
initializeFilterAndPager(array<string|int, mixed> $data[, bool $disable_paging = false ]) : array<string|int, mixed>|bool
Parameters
- $data : array<string|int, mixed>
- $disable_paging : bool = false
Return values
array<string|int, mixed>|bool —isProgressBarStarted()
public
isProgressBarStarted() : bool
Return values
bool —isUniqueUserName()
Check if username is unique or not.
public
isUniqueUserName(string $user_name) : array<string|int, mixed>|bool
Parameters
- $user_name : string
-
user name
Return values
array<string|int, mixed>|bool —returnHandler()
Controls returning information to client in a standard format.
public
returnHandler([bool $retval = true ][, bool $code = false ][, bool $description = false ][, bool $details = false ][, bool $validator_stats = false ][, bool $user_generic_status_batch_id = false ][, bool $request_data = false ][, bool $system_job_queue = false ]) : array<string|int, mixed>|bool
FIXME: Need to return the original request (with any modified values due to restrictions/validation issues) Also need to return paging data variables here too, as JSON can't make multiple calls. In order to do this we need to always return a special data structure that includes this information. static function returnHandler( $retval = TRUE, $args = array( 'code' => FALSE, 'description' => FALSE, 'details' = FALSE, 'validator_stats' => FALSE, 'user_generic_status_batch_id' => FALSE ) ) { The above will require too many changes, just add two more variables at the end, as it will only really be used by API->get*() functions. FIXME: Use a requestHandler() to handle all input requests, so we can parse out things like validate_only, ignore_warning (for user acknowledgable warnings) and handling all parameter parsing in a central place. static function returnHandler( $retval = TRUE, $code = FALSE, $description = FALSE, $details = FALSE, $validator_stats = FALSE, $user_generic_status_batch_id = FALSE, $request = FALSE, $pager = FALSE ) {
Parameters
- $retval : bool = true
- $code : bool = false
- $description : bool = false
- $details : bool = false
- $validator_stats : bool = false
- $user_generic_status_batch_id : bool = false
- $request_data : bool = false
- $system_job_queue : bool = false
Return values
array<string|int, mixed>|bool —sendValidationEmail()
public
sendValidationEmail(string $user_ids) : bool
Parameters
- $user_ids : string
-
UUID
Return values
bool —setAPIMessageID()
public
setAPIMessageID(string $id) : bool
Parameters
- $id : string
-
UUID
Return values
bool —setMainClassObject()
Allow storing the main class object persistently in memory, so we can build up other variables to help out things like getOptions() Mainly used for the APIReport class.
public
setMainClassObject(object $obj) : bool
Parameters
- $obj : object
Return values
bool —setPagerObject()
public
setPagerObject(object $lf) : bool
Parameters
- $lf : object
Return values
bool —setProgressBarObject()
public
setProgressBarObject( $progress_bar_obj) : bool
Parameters
Return values
bool —setUser()
Set user data for one or more users.
public
setUser(array<string|int, mixed> $data[, bool $validate_only = false ][, bool $ignore_warning = true ]) : array<string|int, mixed>|bool
Parameters
- $data : array<string|int, mixed>
-
user data
- $validate_only : bool = false
- $ignore_warning : bool = true
Return values
array<string|int, mixed>|bool —setUserFeedbackRating()
public
setUserFeedbackRating(int $rating[, bool $message = false ]) : array<string|int, mixed>|bool
Parameters
- $rating : int
-
Accepted values are -1, 0, 1.
- $message : bool = false
Return values
array<string|int, mixed>|bool —setUserFeedbackReview()
public
setUserFeedbackReview( $submitted_review) : array<string|int, mixed>|bool
Parameters
Return values
array<string|int, mixed>|bool —setValidationArray()
public
setValidationArray(array<string|int, Validator> $validator_obj_arr[, string $record_label = null ]) : array<string|int, mixed>|bool
Parameters
- $validator_obj_arr : array<string|int, Validator>
-
Array of Validator objects.
- $record_label : string = null
-
Prefix for record label if performing a mass function to differentiate one record from another.
Return values
array<string|int, mixed>|bool —stripReturnHandler()
public
stripReturnHandler(mixed $retarr) : mixed
Parameters
- $retarr : mixed
Return values
mixed —UnsubscribeEmail()
public
UnsubscribeEmail( $email) : bool
Parameters
Return values
bool —validateUser()
Validate user data for one or more users.
public
validateUser(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
user data