• Class name: APIUser
• Namespace:
• Parent class: APIFactory

protected mixed $main_class = 'UserFactory'

• Visibility: protected

public mixed $data = array()

• Visibility: public

protected mixed $main_class_obj = NULL

• Visibility: protected

protected mixed $AMF_message_id = NULL

• Visibility: protected

protected mixed $pager_obj = NULL

• Visibility: protected

protected mixed $current_company = NULL

• Visibility: protected

protected mixed $current_user = NULL

• Visibility: protected

protected mixed $current_user_prefs = NULL

• Visibility: protected

protected mixed $permission = NULL

• Visibility: protected

protected mixed $progress_bar_obj = NULL

• Visibility: protected

mixed APIFactory::__construct()

APIFactory constructor.

• Visibility: public
• This method is defined by APIFactory

array APIUser::getUserDefaultData(string $tmp_company_id)

Get default user data for creating new users.

• Visibility: public

• $tmp_company_id string - UUID

array|boolean APIUser::exportUser(string $format, array $data, boolean $disable_paging)

• Visibility: public

• $format string
• $data array
• $disable_paging boolean

array|boolean APIUser::getUser(array $data, boolean $disable_paging)

Get user data for one or more users.

• Visibility: public

• $data array - filter data, see reference for details.
• $disable_paging boolean - disables paging and returns all records.

array APIUser::getCommonUserData(array $data)

Get only the fields that are common across all records in the search criteria. Used for Mass Editing of records.

• Visibility: public

• $data array - filter data

array APIUser::validateUser(array $data)

Validate user data for one or more users.

• Visibility: public

• $data array - user data

array|boolean APIUser::setUser(array $data, boolean $validate_only, boolean $ignore_warning)

Set user data for one or more users.

• Visibility: public

• $data array - user data
• $validate_only boolean
• $ignore_warning boolean

array|boolean APIUser::deleteUser(array $data)

Delete one or more users.

• Visibility: public

• $data array - user data

array APIUser::copyUser(array $data)

Copy one or more users.

• Visibility: public

• $data array - user data

array|boolean APIUser::isUniqueUserName(string $user_name)

Check if username is unique or not.

• Visibility: public

• $user_name string - user name

array|boolean APIUser::changePassword(string $current_password, string $new_password, string $new_password2, string $type)

Allows currently logged in user to change their password.

• Visibility: public

• $current_password string
• $new_password string
• $new_password2 string
• $type string

array APIUser::getUniqueUserProvinces()

Returns a list of unique provinces that employees are assigned to.

• Visibility: public

boolean APIUser::UnsubscribeEmail($email)

• Visibility: public

• $email mixed

boolean APIUser::sendValidationEmail(string $user_ids)

• Visibility: public

• $user_ids string - UUID

array APIUser::getCompanyUser(array $data, boolean $disable_paging)

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.

• Visibility: public

• $data array - filter data, see reference for details.
• $disable_paging boolean - disables paging and returns all records.

array|boolean APIUser::setUserFeedbackRating($rating, boolean $message)

• Visibility: public

• $rating mixed
• $message boolean

mixed APIUser::deleteImage($employee_id)

• Visibility: public

• $employee_id mixed

integer APIFactory::getProtocolVersion()

• Visibility: public
• This method is defined by APIFactory

boolean|null APIFactory::getAMFMessageID()

• Visibility: public
• This method is defined by APIFactory

boolean APIFactory::setAMFMessageID(string $id)

• Visibility: public
• This method is defined by APIFactory

• $id string - UUID

boolean|\CompanyFactory APIFactory::getCurrentCompanyObject()

• Visibility: public
• This method is defined by APIFactory

boolean|\UserFactory APIFactory::getCurrentUserObject()

• Visibility: public
• This method is defined by APIFactory

boolean|\UserPreferenceFactory APIFactory::getCurrentUserPreferenceObject()

• Visibility: public
• This method is defined by APIFactory

boolean|null|\Permission APIFactory::getPermissionObject()

• Visibility: public
• This method is defined by APIFactory

null|\ProgressBar APIFactory::getProgressBarObject()

• Visibility: public
• This method is defined by APIFactory

boolean APIFactory::setPagerObject(object $lf)

• Visibility: public
• This method is defined by APIFactory

• $lf object

array|boolean APIFactory::getPagerData()

• Visibility: public
• This method is defined by APIFactory

boolean APIFactory::setMainClassObject(object $obj)

• Visibility: public
• This method is defined by APIFactory

• $obj object

string APIFactory::getMainClassObject()

• Visibility: public
• This method is defined by APIFactory

array|boolean APIFactory::initializeFilterAndPager(array $data, boolean $disable_paging)

• Visibility: public
• This method is defined by APIFactory

• $data array
• $disable_paging boolean

array|null APIFactory::handlePermissionFilterColumns(array $filter_columns, array $allowed_columns)

• Visibility: public
• This method is defined by APIFactory

• $filter_columns array
• $allowed_columns array

mixed APIFactory::convertToSingleRecord(array $data)

• Visibility: public
• This method is defined by APIFactory

• $data array

array APIFactory::convertToMultipleRecords(array $data)

• Visibility: public
• This method is defined by APIFactory

• $data array

array|boolean APIFactory::exportRecords(string $format, string $file_name, array $result, array $filter_columns)

downloaded a result_set as a csv.

• Visibility: public
• This method is defined by APIFactory

• $format string
• $file_name string
• $result array
• $filter_columns array

string APIFactory::getNextInsertID()

• Visibility: public
• This method is defined by APIFactory

array APIFactory::getPermissionChildren()

• Visibility: public
• This method is defined by APIFactory

array|boolean APIFactory::returnHandler(boolean $retval, boolean $code, boolean $description, boolean $details, boolean $validator_stats, boolean $user_generic_status_batch_id, boolean $request_data)

• Visibility: public
• This method is defined by APIFactory

• $retval boolean
• $code boolean
• $description boolean
• $details boolean
• $validator_stats boolean
• $user_generic_status_batch_id boolean
• $request_data boolean

mixed APIFactory::stripReturnHandler(mixed $retarr)

• Visibility: public
• This method is defined by APIFactory

• $retarr mixed

array|boolean APIFactory::getOptions(boolean $name, string|integer $parent)

• Visibility: public
• This method is defined by APIFactory

• $name boolean
• $parent string|integer

array APIFactory::getVariableToFunctionMap(string $name, string|integer $parent)

• Visibility: public
• This method is defined by APIFactory

• $name string
• $parent string|integer

boolean|\Validator APIFactory::convertAPIReturnHandlerToValidatorObject($api_retarr, boolean $validator_obj)

• Visibility: public
• This method is defined by APIFactory

• $api_retarr mixed
• $validator_obj boolean

array|boolean APIFactory::setValidationArray(string $primary_validator, string $secondary_validator, boolean $tertiary_validator)

• Visibility: public
• This method is defined by APIFactory

• $primary_validator string - UUID
• $secondary_validator string - UUID
• $tertiary_validator boolean

array APIFactory::handleRecordValidationResults(object|boolean $validator, array $validator_stats, integer $key, array|boolean $save_result)

• Visibility: public
• This method is defined by APIFactory

• $validator object|boolean
• $validator_stats array
• $key integer
• $save_result array|boolean