| package | Modules\Users |
|---|---|
| inherited_from | \UserFactory |
CommitTransaction()
Delete()
ExecuteSQL($query, $ph= NULL, $limit= NULL, $page= NULL)
FailTransaction()
RetryExecuteSQL($query, $ph= NULL, $retry_max_attempts= 2, $sleep= 5)
Save($reset_data= TRUE, $force_lookup= FALSE)
StartTransaction()
UnsubscribeEmail($email)
Validate($ignore_warning = TRUE)
__construct()
__toString()
addLog($log_action)
bulkDelete($ids)
checkEmployeeNumber($id)
checkPassword($password, $check_password_policy = TRUE)
checkPasswordAge()
checkPasswordResetKey($key)
checkPhonePassword($password)
cleanStoragePath($company_id= NULL, $user_id= NULL)
clearData()
clearGeoCode($data_diff = NULL)
convertFlexArray($array)
encryptPassword($password, $version = 2)
encryptPasswordResetKey($key)
fromBool($value)
getAMFMessageID()
getAPIEmailAddressDataByArrayCriteria($filter_data= NULL, $limit= NULL, $page= NULL, $where= NULL, $order= NULL)
getAPISearchByCompanyIdAndArrayCriteria(integer $company_id, array $filter_data, integer $limit= NULL, integer $page= NULL, array $where= NULL, array $order= NULL, $include_last_punch_time= FALSE) : object
integerCompany ID
arrayFilter criteria in array('id' => array(1, 2), 'last_name' => 'smith' ) format, with possible top level array keys as follows: id, exclude_id, status_id, user_group_id, default_branch_id, default_department_id, title_id, currency_id, permission_control_id, pay_period_schedule_id, policy_group_id, sex_id, first_name, last_name, home_phone, work_phone, country, province, city, address1, address2, postal_code, employee_number, user_name, sin, work_email, home_email, tag, last_login_date, created_by, created_date, updated_by, updated_date
integerOptional. Restrict the number of records returned
integerOptional. Specify the page of records to return
arrayOptional. Additional WHERE clauses in array( 'column' => 'value', 'column' => 'value' ) format.
arrayOptional. Sort order in array( 'column' => ASC, 'column2' => DESC ) format.
object$thisgetAddress1()
getAddress2()
getAge()
getAll($limit= NULL, $page= NULL, $where= NULL, $order= NULL)
getArrayByListFactory($lf, $include_blank= TRUE, $include_disabled= TRUE)
getBirthDate()
getByCompanyIDAndEmployeeNumber($company_id, $employee_number, $where= NULL, $order= NULL)
getByCompanyIDAndGroupID($company_id, $id, $where= NULL, $order= NULL)
getByCompanyIDAndPermissionLevel($company_id, $level, $where= NULL, $order= NULL)
getByCompanyIDAndStationIDAndStatusAndDate($company_id, $station_id, $status_id, $date= NULL, $limit= NULL, $page= NULL, $where= NULL, $order= NULL)
getByCompanyIDAndStationIDAndStatusAndDateAndValidUserIDs($company_id, $station_id, $status_id, $date= NULL, $valid_user_ids= array(), $limit= NULL, $page= NULL, $where= NULL, $order= NULL)
getByCompanyIDAndStationIDAndStatusAndEmployeeNumber($company_id, $station_id, $status_id, $employee_number, $limit= NULL, $page= NULL, $where= NULL, $order= NULL)
getByCompanyId($company_id, $limit= NULL, $page= NULL, $where= NULL, $order= NULL)
getByCompanyIdAndLongitudeAndLatitude($company_id, $longitude, $latitude, $limit= NULL, $page= NULL, $where= NULL, $order= NULL)
getByCompanyIdAndStatus($company_id, $status, $where= NULL, $order= NULL)
getByCompanyIdArray($company_id, $include_blank= TRUE, $include_disabled= TRUE, $last_name_first= TRUE)
getByCurrencyID($id, $where= NULL, $order= NULL)
getByEmailIsValidKey($key)
getByHomeEmailOrWorkEmail($email)
getById($id)
getByIdAndCompanyId($id, $company_id, $limit= NULL, $page= NULL, $where= NULL, $order= NULL)
getByIdAndStatus($id, $status, $where= NULL, $order= NULL)
getByPasswordResetKey($key)
getByPhoneIdAndStatus($phone_id, $status, $where= NULL, $order= NULL)
getByStatus($status, $where= NULL, $order= NULL)
getByUserName($user_name, $where= NULL, $order= NULL)
getByUserNameAndCompanyId($user_name, $company_id, $where= NULL, $order= NULL)
getByUserNameAndStatus($user_name, $status, $where= NULL, $order= NULL)
getCache($cache_id, $group_id = NULL)
getCallerFunction()
getCity()
getColumn($column)
getColumnList()
getCompany()
getCompanyGenericMapData($company_id, $object_type_id, $id, $variable)
getCompanyObject()
getCompanyValidUserIds($id, $company_id)
getCountry()
getCreatedAndUpdatedColumns($data, $include_columns = NULL)
getCreatedBy()
getCreatedDate()
getCurrency()
getCurrencyObject()
getCurrent()
getCurrentRow($offset = 1)
getCurrentUserPermissionLevel()
getDateRangeSQL($str, $column, $format= 'epoch', $include_blank_dates= FALSE)
getDefaultBranch()
getDefaultBranchObject()
getDefaultDepartment()
getDefaultDepartmentObject()
getDefaultJob()
getDefaultJobItem()
getDeleted()
getDeletedBy()
getDeletedByCompanyIdAndDate($company_id, $date, $limit= NULL, $page= NULL, $where= NULL, $order= NULL)
getDeletedDate()
getEmployeeNumber()
getEmptyRecordSet($id = NULL)
getEnableClearPasswordResetData()
getEnableSystemLogDetail()
getEthnicGroup()
getFaxPhone()
getFeedbackRating()
getFirstName()
getFirstNameMetaphone()
getFullName($reverse= FALSE, $include_middle= TRUE)
getFullNameById($id)
getGenericObject($list_factory, $id, $variable, $list_factory_method= 'getById', $id_method= 'getID')
getGroup()
getGroupObject()
getHierarchyControl()
getHierarchyControlDisplay()
getHierarchyLevelDisplay()
getHighestEmployeeNumberByCompanyId($id, $where= NULL, $order= NULL)
getHireDate()
getHomeEmail()
getHomeEmailIsValid()
getHomeEmailIsValidDate()
getHomeEmailIsValidKey()
getHomePhone()
getIDSByListFactory($lf)
getId()
getIsModifiedByCompanyIdAndDate($company_id, $date, $where= NULL, $order= NULL)
getIterator()
getLabelId()
getLastLoginDate()
getLastName()
getLastNameMetaphone()
getLatitude()
getLongitude()
getMapURL()
getMaxUserId()
getMiddleInitial()
getMiddleName()
getMobilePhone()
getNextAvailableEmployeeNumber($company_id = NULL)
getNextInsertId()
getNote()
getObjectAsArray($include_columns= NULL, $permission_children_ids= FALSE)
getOptions($name, $parent = NULL)
getOtherID1()
getOtherID2()
getOtherID3()
getOtherID4()
getOtherID5()
getPassword()
getPasswordResetDate()
getPasswordResetKey()
getPasswordSalt()
getPasswordUpdatedDate()
getPasswordVersion($encrypted_password = FALSE)
getPayPeriodSchedule()
getPermissionColumns($data, $object_user_id, $created_by_id, $permission_children_ids= NULL, $include_columns= NULL)
getPermissionControl()
getPermissionLevel()
getPhoneId()
getPhonePassword()
getPhotoFileName($company_id= NULL, $user_id= NULL, $include_default_photo= TRUE)
getPolicyGroup()
getPostalCode()
getProgressBarObject()
getProvince()
getRecordCount()
getReportByCompanyIdAndUserIDList($company_id, $user_ids, $order = NULL)
getSIN()
getSearchByArrayCriteria($filter_data, $limit= NULL, $page= NULL, $where= NULL, $order= NULL)
getSearchByCompanyIdAndArrayCriteria($company_id, $filter_data, $limit= NULL, $page= NULL, $where= NULL, $order= NULL)
getSearchByCompanyIdAndBranchIdAndDepartmentIdAndStatusId($company_id, $branch_id, $department_id, $status_id= NULL, $order= NULL)
getSearchByCompanyIdAndGroupIdAndSubGroupsAndBranchIdAndDepartmentIdAndStatusId($company_id, $group_id, $include_sub_groups, $branch_id, $department_id, $status_id= NULL, $order= NULL)
getSearchByCompanyIdAndStatusIdAndBranchIdAndDepartmentIdAndUserTitleIdAndIncludeIdAndExcludeId($company_id, $status_id, $branch_id, $department_id, $user_title_id= NULL, $include_user_id= NULL, $exclude_user_id= NULL, $order= NULL)
getSearchByCompanyIdAndUserIDAndGroupIdAndSubGroupsAndBranchIdAndDepartmentIdAndStatusId($company_id, $user_id, $group_id, $include_sub_groups, $branch_id, $department_id, $status_id= NULL, $order= NULL)
getSecondLastName()
getSecureSIN($sin = NULL)
getSequenceName()
getSex()
getStatus()
getStoragePath($company_id= NULL, $user_id= NULL)
getTable($strip_quotes = FALSE)
getTag()
getTerminationDate()
getTitle()
getTitleObject()
getTransactionMode()
getUniqueCountryByCompanyId($id, $where= NULL, $order= NULL)
getUpdatedBy()
getUpdatedDate()
getUserName()
getUserPreferenceObject()
getValidSQLColumns($array, $strict= TRUE, $additional_fields= NULL)
getVariableToFunctionMap($data = NULL)
getWorkEmail()
getWorkEmailIsValid()
getWorkEmailIsValidDate()
getWorkEmailIsValidKey()
getWorkPhone()
getWorkPhoneExt()
isCompromisedPassword()
isFirstLogin()
isInformationComplete()
isNew($force_lookup = FALSE)
isPasswordPolicyEnabled()
isPhotoExists()
isSave()
isUniqueEmployeeNumber($id)
isUniqueHomeEmail($email)
isUniquePhoneId($phone_id)
isUniqueUserName($user_name)
isUniqueWorkEmail($email)
isValid($ignore_warning = TRUE)
isValidWageForHireDate($epoch)
isWarning()
postSave($data_diff = NULL)
preSave()
removeCache($cache_id= NULL, $group_id= NULL)
saveCache($data, $cache_id, $group_id = NULL)
sendPasswordResetEmail()
sendValidateEmail($type = 'work')
serializeRS($rs)
setAMFMessageID($id)
setAddress1($address1)
setAddress2($address2)
setBirthDate($epoch)
setCacheLifeTime($secs)
setCity($city)
setCompany($id)
setCountry($country)
setCreatedAndUpdatedColumns($data, $variable_to_function_map = array())
setCreatedBy($id = NULL)
setCreatedDate($epoch = NULL)
setCurrency($id)
setDefaultBranch($id)
setDefaultDepartment($id)
setDefaultJob($id)
setDefaultJobItem($id)
setDeleted($bool)
setDeletedBy($id = NULL)
setDeletedDate($epoch = NULL)
setEmployeeNumber($value)
setEnableClearPasswordResetData($value = TRUE)
setEnableSystemLogDetail($bool)
setEthnicGroup($id)
setFaxPhone($fax_phone)
setFeedbackRating($rating)
setFirstName($first_name)
setFirstNameMetaphone($first_name)
setGenericObject($obj, $variable)
setGroup($id)
setHierarchyControl($data)
setHireDate($epoch)
setHomeEmail($home_email)
setHomeEmailIsValid($bool)
setHomeEmailIsValidDate($epoch)
setHomeEmailIsValidKey($value)
setHomePhone($home_phone)
setId($id)
setLastLoginDate($epoch)
setLastName($last_name)
setLastNameMetaphone($last_name)
setLatitude($value)
setLongitude($value)
setMiddleName($middle_name)
setMobilePhone($mobile_phone)
setNote($value)
setObjectFromArray($data)
setOtherID1($value)
setOtherID2($value)
setOtherID3($value)
setOtherID4($value)
setOtherID5($value)
setPassword($password, $password_confirm= NULL, $force= FALSE)
setPasswordResetDate($epoch)
setPasswordResetKey($value)
setPasswordUpdatedDate($epoch)
setPayPeriodSchedule($id)
setPermissionControl($id)
setPhoneId($phone_id)
setPhonePassword($phone_password, $force = FALSE)
setPolicyGroup($id)
setPostalCode($postal_code)
setProgressBarObject($obj)
setProvince($province)
setQueryStatementTimeout($milliseconds = NULL)
setSIN($sin)
setSecondLastName($second_last_name)
setSex($sex)
setStatus($status)
setTag($tags)
setTerminationDate($epoch)
setTitle($id)
setTransactionMode($mode = '')
setUpdatedBy($id = NULL)
setUpdatedDate($epoch = NULL)
setUserName($user_name)
setWorkEmail($work_email)
setWorkEmailIsValid($bool)
setWorkEmailIsValidDate($epoch)
setWorkEmailIsValidKey($value)
setWorkPhone($work_phone)
setWorkPhoneExt($work_phone_ext)
toBool($value)
unserializeRS($rs)
_getFactoryOptions($name, $parent = NULL)
_getVariableToFunctionMap($data)
castInteger($int, $type = 'int')
getColumnsFromAliases($columns, $aliases)
getDatabaseType()
getGEOMAsTextFunction($sql)
getListSQL($array, $ph= NULL, $cast= FALSE)
getSQLStringAggregate($sql, $glue)
getSQLToEpochFunction($sql)
getSQLToTimeFunction($sql)
getSQLToTimeStampFunction()
getSortSQL($array, $strict= TRUE, $additional_fields= NULL)
getWhereClauseSQL($columns, $args, $type, $ph, $query_stub= NULL, $and= TRUE)
getWhereSQL($array, $append_where = FALSE)
handleSQLSyntax($arg)
stripSQLSyntax($arg)
getInsertQuery()
getRecordSetColumnList($rs)
getUpdateQuery()
parseColumnName($column)
$data
array()$old_data
array()$phoneid_validator_regex
'/^[0-9]{1,250}$/i'$username_validator_regex
'/^[a-z0-9-_\.@\+]{1,250}$/i'$validate_only
FALSE$address_validator_regex
'/^[a-zA-Z0-9-,_\/\.\'#\ |\x{0080}-\x{FFFF}]{1,250}$/iu'$branch_obj
NULL$city_validator_regex
'/^[a-zA-Z0-9-,_\.\'#\ |\x{0080}-\x{FFFF}]{1,250}$/iu'$company_obj
NULL$currency_obj
NULL$department_obj
NULL$enable_system_log_detail
TRUE$group_obj
NULL$name_validator_regex
'/^[a-zA-Z- \.\'()\[\]|\x{0080}-\x{FFFF}]{1,250}$/iu'$next_insert_id
NULL$phonepassword_validator_regex
'/^[0-9]{1,250}$/i'$pk_sequence_name
'users_id_seq'$table
'users'$title_obj
NULL$tmp_data
NULL$user_preference_obj
NULL$user_tax_obj
NULL