UserListFactory
extends UserFactory
in package
implements
IteratorAggregate
Interfaces, Classes, Traits and Enums
- IteratorAggregate
Table of Contents
- $cache : Cache_Lite_Function|Cache_Lite_Output
- $data : mixed
- $db : mixed
- $is_new : mixed
- $old_data : mixed
- $phoneid_validator_regex : mixed
- $rs : mixed
- $tmp_data : mixed
- $username_validator_regex : mixed
- $validate_only : mixed
- $Validator : mixed
- $address_validator_regex : mixed
- $api_message_id : mixed
- $branch_obj : mixed
- $city_validator_regex : mixed
- $company_obj : mixed
- $currency_obj : mixed
- $department_obj : mixed
- $enable_system_log_detail : mixed
- $group_obj : mixed
- $json_columns : mixed
- $legal_entity_obj : mixed
- $name_validator_regex : mixed
- $permission_obj : mixed
- $phonepassword_validator_regex : mixed
- $pk_sequence_name : mixed
- $progress_bar_obj : mixed
- $table : mixed
- $title_obj : mixed
- $user_preference_obj : mixed
- $user_tax_obj : mixed
- $ignore_column_list : bool
- $is_valid : mixed
- __construct() : mixed
- Factory constructor.
- __toString() : bool|string
- Print primary columns from object.
- addLog() : bool
- bulkDelete() : bool
- castGenericDataValue() : mixed
- Generic casting function that all set/get*() functions should pass through.
- checkEmployeeNumber() : bool
- checkLoginPermissions() : bool
- checkPassword() : bool
- checkPasswordAge() : bool
- checkPasswordResetKey() : bool
- checkPhonePassword() : bool
- checkUserHasEmail() : void
- Checks if user has an email attached to account and sends a notification to users that need to be notified.
- cleanStoragePath() : bool
- clearCacheSavedInTransaction() : bool
- clearData() : bool
- clearGeoCode() : bool
- clearNonMappedData() : array<string|int, mixed>|null
- Removes array elements from $data that are not in the function map.
- clearOldData() : bool
- CommitSavePoint() : bool
- CommitTransaction() : mixed
- convertFlexArray() : array<string|int, mixed>
- decodeCustomFields() : bool
- decodeGenericJSONData() : bool
- Decode generic 'other_json' column data.
- decodeJSONColumn() : bool
- Decodes JSON columns that are not the 'other_json' column.
- Delete() : bool
- Deletes the record directly from the database.
- disableExpiredLogins() : $this
- Disables all logins past their expire date without going through UserFactory to avoid cases where we aren't able to save records due to validation failures.
- encodeCustomFields() : bool
- encodeGenericJSONData() : bool
- Encode generic 'other_json' column data. This should only be done in Save() after all validation has occurred already and we are just about to commit it to the DB.
- encodeJSONColumns() : bool
- Encode any JSON columns that are not 'other_json' column. This should only be done in Save() after all validation has occurred already and we are just about to commit it to the DB.
- encryptPasswordResetKey() : string
- ExecuteSQL() : bool
- Execute SQL queries and handle paging properly for select statements.
- FailTransaction() : mixed
- fromBool() : bool
- fromJSONBool() : bool
- getAddress1() : bool
- getAddress2() : bool
- getAffectedRows() : int|bool
- getAge() : float
- getAll() : $this
- getAPIEmailAddressDataByArrayCriteria() : $this
- getAPIMessageID() : bool|null
- Used for updating progress bar for API calls.
- getAPISearchByCompanyIdAndArrayCriteria() : bool|object
- Return user records based on advanced filter criteria.
- getArrayByListFactory() : bool
- getBirthDate() : bool|mixed
- getByCompanyId() : bool|UserListFactory
- getByCompanyIDAndEmployeeNumber() : bool|UserListFactory
- getByCompanyIDAndGroupID() : bool|UserListFactory
- getByCompanyIdAndLongitudeAndLatitude() : bool|UserListFactory
- getByCompanyIDAndPermissionLevel() : bool|UserListFactory
- getByCompanyIDAndStationIDAndStatusAndDate() : bool|UserListFactory
- getByCompanyIDAndStationIDAndStatusAndDateAndValidUserIDs() : bool|UserListFactory
- getByCompanyIDAndStationIDAndStatusAndEmployeeNumber() : bool|UserListFactory
- getByCompanyIdAndStatus() : bool|UserListFactory
- getByCompanyIDAndStatusIdAndMinimumPermissionLevelAndRecentNotification() : bool|UserListFactory
- getByCompanyIdAndTerminatedPermissionControl() : bool|UserListFactory
- getByCompanyIdArray() : bool
- getByCurrencyID() : bool|UserListFactory
- getByEmailIsValidKey() : bool|UserListFactory
- getByHomeEmailOrWorkEmail() : bool|UserListFactory
- getById() : bool|UserListFactory
- getByIdAndCompanyId() : bool|UserListFactory
- getByIdAndStatus() : bool|UserListFactory
- getByLegalEntityIdAndCompanyId() : bool|UserListFactory
- getByPasswordResetKey() : bool|UserListFactory
- getByPhoneIdAndStatus() : bool|UserListFactory
- getByStatus() : $this
- getByUserName() : bool|UserListFactory
- getByUserNameAndCompanyId() : bool|UserListFactory
- getByUserNameAndEnableLogin() : bool|UserListFactory
- getByUserNameAndStatus() : bool|UserListFactory
- getCache() : bool|mixed
- getCity() : bool|mixed
- getColumn() : bool|mixed
- Generic function get any data from the data array.
- getColumnList() : array<string|int, mixed>|bool
- getCompany() : bool|int|string
- getCompanyGenericMapData() : mixed
- Generic function to return and cache CompanyGenericMap data, this greatly improves performance of CalculatePolicy when many policies exist.
- getCompanyObject() : bool
- getCompanyValidUserIds() : bool
- Security measure, only returns user_ids that are valid for the specific company.
- getCountry() : bool|mixed
- getCreatedAndUpdatedColumns() : bool
- getCreatedBy() : bool|mixed
- getCreatedDate() : int
- getCurrency() : bool|mixed
- getCurrencyObject() : bool
- getCurrent() : mixed
- Grabs the current object
- getCurrentPassword() : bool
- getCurrentRow() : int|bool
- getCurrentUserPermissionLevel() : bool|int
- getCustomField() : void
- Get a single custom field by ID.
- getCustomFields() : mixed
- getCustomFieldsColumns() : array<string|int, mixed>
- getCustomFieldsDataForObject() : array<string|int, mixed>
- Get custom field data for this specific object, so it can be easily cached in memory without having to go to the database or unserialize it from cache for every row.
- getCustomFieldsDefaultData() : mixed
- getCustomFieldsParseHints() : array<string|int, mixed>
- getCustomFieldTableName() : string
- getDataDifferences() : array<string|int, mixed>
- Returns the differences in data from the DB vs the in-memory object, so the data will be the OLD data. Used in Validation/postSave() functions to determine if a field has changed or not.
- getDateRangeSQL() : bool|string
- This function takes plain input from the user and creates a SQL statement for filtering based on a date range.
- getDefaultBranch() : bool|mixed
- getDefaultBranchObject() : bool
- getDefaultDepartment() : bool|mixed
- getDefaultDepartmentObject() : bool
- getDefaultJob() : bool|mixed
- getDefaultJobItem() : bool|mixed
- getDefaultPunchTag() : array<string|int, mixed>
- getDeleted() : bool
- getDeletedBy() : bool|mixed
- getDeletedByCompanyIdAndDate() : bool|UserListFactory
- getDeletedDate() : bool|mixed
- getEmployeeNumber() : bool|int
- getEmptyRecordSet() : mixed
- getEnableClearPasswordResetData() : bool
- getEnableLogin() : bool
- getEnableSystemLogDetail() : bool
- getEthnicGroup() : bool
- getFaxPhone() : bool|mixed
- getFeedbackRating() : bool
- getFirstName() : bool|mixed
- getFirstNameMetaphone() : bool|mixed
- getFullName() : bool|string
- getFullNameById() : bool
- getGenericDataValue() : bool|mixed
- Generic getter/setter functions that should be used when Validation code is moved from get/set functions to Validate() function.
- getGenericJSONDataValue() : bool|mixed
- Generic getter/setter functions for handling generic JSON data in 'other_json' SQL column.
- getGenericObject() : object|bool
- Generic function to return and cache class objects ListFactory, ListFactoryMethod, Variable, ID, IDMethod
- getGenericOldDataValue() : bool|mixed
- getGenericTempDataValue() : bool
- Generic getter/setter functions that should be used when Validation code is moved from get/set functions to Validate() function.
- getGroup() : bool|mixed
- getGroupObject() : bool
- getHierarchyControl() : bool
- getHierarchyControlDisplay() : bool|string
- Display each hierarchy that the employee is assigned too.
- getHierarchyLevelDisplay() : bool|string
- Display each superior that the employee is assigned too.
- getHighestEmployeeNumberByCompanyId() : bool|UserListFactory
- getHireDate() : bool|mixed
- getHomeEmail() : bool|mixed
- getHomeEmailIsValid() : bool
- getHomeEmailIsValidDate() : mixed
- getHomeEmailIsValidKey() : bool|mixed
- getHomePhone() : bool|mixed
- getId() : bool|mixed
- getIDSByListFactory() : array<string|int, mixed>|bool
- getIsModifiedByCompanyIdAndDate() : bool
- getIsRequiredCurrentPassword() : bool
- getIterator() : FactoryListIterator
- getLabelId() : bool|mixed|string
- getLastLoginDate() : bool|mixed
- getLastName() : bool|mixed
- getLastNameMetaphone() : bool|mixed
- getLatitude() : bool|float
- getLegalEntity() : bool|mixed
- getLegalEntityObject() : bool
- getLoginExpireDate() : bool|mixed
- getLongitude() : bool|float
- getMapURL() : bool|string
- getMiddleInitial() : bool
- getMiddleName() : bool|mixed
- getMobilePhone() : bool|mixed
- getNextAvailableEmployeeNumber() : int|null
- getNextInsertId() : bool|string
- getNote() : bool|mixed
- getObjectAsArray() : array<string|int, mixed>
- getOptions() : array<string|int, mixed>|bool
- getPassword() : bool|mixed
- getPasswordResetDate() : mixed
- getPasswordResetKey() : bool|mixed
- getPasswordUpdatedDate() : bool|mixed
- getPayPeriodSchedule() : bool
- getPermissionColumns() : bool
- getPermissionControl() : bool
- getPermissionLevel() : bool|int
- getPermissionObject() : Permission|null
- getPhoneId() : bool|string
- getPhonePassword() : bool|mixed
- getPhotoFileName() : bool|string
- getPolicyGroup() : bool
- getPostalCode() : bool|mixed
- getProgressBarObject() : null|ProgressBar
- getPromptForFeedback() : array<string|int, mixed>|bool
- Determines if the user should be prompted for feedback.
- getProvince() : bool|mixed
- getRecordCount() : int|bool
- getRecurringSchedule() : array<string|int, mixed>
- getReportByCompanyIdAndUserIDList() : bool|UserListFactory
- getSecondLastName() : bool|mixed
- getSecureSIN() : bool|string
- getSequenceName() : bool
- getSex() : bool|int
- getSIN() : bool|mixed
- getStatus() : bool|int
- getStoragePath() : bool|string
- getTable() : bool|string
- getTag() : bool|string
- getTerminatedPermissionControl() : bool|mixed
- getTerminatedPermissionLevel() : bool
- getTerminationDate() : bool|mixed
- getTitle() : bool|mixed
- getTitleObject() : bool
- getTransactionMode() : string
- getUniqueCountryByCompanyId() : bool
- getUpdatedBy() : bool|mixed
- getUpdatedDate() : int
- getUserDefault() : bool
- getUserName() : bool|mixed
- getUserPreferenceObject() : bool|null|object
- getValidSQLColumns() : array<string|int, mixed>
- getVariableToFunctionMap() : array<string|int, mixed>|bool
- getWorkEmail() : bool|mixed
- getWorkEmailIsValid() : bool
- getWorkEmailIsValidDate() : mixed
- getWorkEmailIsValidKey() : bool|mixed
- getWorkPhone() : bool|mixed
- getWorkPhoneExt() : bool|mixed
- handleSaveSQLReturning() : bool
- Used to handle any "RETURNING ..." clause on a SQL INSERT/UPDATE query.
- hasDataChanged() : bool
- Determine if the record data has changed at all.
- isClientFriendly() : bool
- Check if the remote client is our main UI app controlled by us, vs. a user utilizing the API for example.
- isCompromisedPassword() : bool
- isCurrentlyLoggedInUser() : bool
- Check if the current user record is also for the currently logged in user.
- isDataDifferent() : bool
- Used to check the differences between a single key in the $old_data vs. $data arrays.
- isFirstLogin() : bool
- isNew() : bool
- Determines if the data is new data, or updated data. Basically determines if a database INSERT or UPDATE SQL statement is generated.
- isPasswordPolicyEnabled() : bool
- isPhotoExists() : bool
- isSQLExceptionRetryable() : bool
- Determines if a SQL exception is one that can be retried or not.
- isUniqueEmployeeNumber() : bool
- isUniqueHomeEmail() : bool
- isUniquePhoneId() : bool
- isUniqueSIN() : bool
- isUniqueUserName() : bool
- isUniqueWorkEmail() : bool
- isValid() : bool
- Call class specific validation function just before saving.
- isValidWageForHireDate() : bool
- isWarning() : bool
- Call class specific validation function just before saving.
- modifyInsertQuery() : mixed
- Modifies the automatically generated SQL INSERT query for adding things like " ON CONFLICT ..."
- parseCustomFieldsFromArray() : mixed
- postSave() : bool
- preValidate() : bool
- removeCache() : bool
- RetryTransaction() : mixed
- Accepts a Closure and is retried at set intervals which should be in a transaction.
- rewind() : bool
- Rewinds record set iterator to begining. The same as ADODB's MoveFirst() function.
- RollbackSavePoint() : bool
- Save() : bool|int|string
- Determines to insert or update, and does it.
- saveCache() : bool
- sendPasswordResetEmail() : bool
- sendValidateEmail() : bool
- serializeRS() : string
- Serialize ADODB recordset.
- setAddress1() : bool
- setAddress2() : bool
- setAPIMessageID() : bool
- setBirthDate() : bool
- setCacheLifeTime() : bool
- setCity() : bool
- setCompany() : bool
- setCountry() : bool
- setCreatedAndUpdatedColumns() : bool
- setCreatedBy() : bool
- setCreatedDate() : bool
- setCurrency() : bool
- setCurrentPassword() : bool
- setCustomField() : void
- Set a single custom field by ID.
- setCustomFields() : bool
- setDefaultBranch() : bool
- setDefaultDepartment() : bool
- setDefaultJob() : bool
- setDefaultJobItem() : bool
- setDefaultPunchTag() : bool
- setDeleted() : bool
- setDeletedBy() : bool|null
- setDeletedDate() : bool
- setEmployeeNumber() : bool
- setEnableClearPasswordResetData() : bool
- setEnableLogin() : bool
- setEnableSystemLogDetail() : bool
- setEthnicGroup() : bool
- setFaxPhone() : bool
- setFeedbackRating() : bool
- setFirstName() : bool
- setFirstNameMetaphone() : bool
- setGenericDataValue() : bool
- setGenericJSONDataValue() : bool
- Generic getter/setter functions for handling generic JSON data in 'other_json' SQL column.
- setGenericObject() : bool
- Allow method to pre-populate/overwrite the cache if needed.
- setGenericTempDataValue() : bool
- setGroup() : bool
- setHierarchyControl() : bool
- setHireDate() : bool
- setHomeEmail() : bool
- setHomeEmailIsValid() : bool
- setHomeEmailIsValidDate() : bool
- setHomeEmailIsValidKey() : bool
- setHomePhone() : bool
- setId() : bool
- setIsRequiredCurrentPassword() : bool
- setIsValid() : bool
- Sets the is_valid flag, mostly used to set it to FALSE to force a full re-validation.
- setLastLoginDate() : bool
- setLastName() : bool
- setLastNameMetaphone() : bool
- setLatitude() : bool
- setLegalEntity() : bool
- setLoginExpireDate() : bool
- setLongitude() : bool
- setMiddleName() : bool
- setMobilePhone() : bool
- setNote() : bool
- setObjectFromArray() : bool
- Support setting created_by, updated_by especially for importing data.
- setPassword() : bool
- setPasswordResetDate() : bool
- setPasswordResetKey() : bool
- setPasswordUpdatedDate() : bool
- setPayPeriodSchedule() : bool
- setPermissionControl() : bool
- setPhoneId() : bool
- setPhonePassword() : bool
- setPolicyGroup() : bool
- setPostalCode() : bool
- setProgressBarObject() : bool
- setProvince() : bool
- setQueryStatementTimeout() : bool
- setRecurringSchedule() : mixed
- setSecondLastName() : bool
- setSex() : bool
- setSIN() : bool
- setStatus() : bool
- setTag() : bool
- setTerminatedPermissionControl() : bool
- setTerminationDate() : bool
- setTitle() : bool
- setTransactionMode() : mixed
- setUpdatedBy() : bool|null
- setUpdatedDate() : bool|int|null|string
- setUserDefault() : mixed
- setUserName() : bool
- setWorkEmail() : bool
- setWorkEmailIsValid() : bool
- setWorkEmailIsValidDate() : bool
- setWorkEmailIsValidKey() : bool
- setWorkPhone() : bool
- setWorkPhoneExt() : bool
- StartSavePoint() : bool
- StartTransaction() : mixed
- toBool() : int
- toJSONBool() : string
- UnsubscribeEmail() : bool
- Validate() : bool
- validateCustomFields() : mixed
- _getFactoryOptions() : bool
- _getVariableToFunctionMap() : bool
- castInteger() : bool|int|string
- getColumnsFromAliases() : array<string|int, mixed>
- getCustomFieldWhereSQL() : string
- getDatabaseType() : string
- getListSQL() : bool|int|string|array<string|int, mixed>
- getSortSQL() : bool|string
- getSQLStringAggregate() : string
- getSQLToEpochFunction() : string
- getSQLToTimeFunction() : string
- getSQLToTimeStampFunction() : string
- getWhereClauseSQL() : null|string
- getWhereSQL() : bool|string
- handleSQLSyntax() : string
- SQL where clause Syntax: or % as wildcard.
- stripSQLSyntax() : mixed
- getInsertQuery() : mixed
- getRecordSetColumnList() : array<string|int, mixed>|bool
- getUpdateQuery() : bool
- parseColumnName() : bool|string
- Parses out the exact column name, without any aliases, or = signs in it.
Properties
$cache
public
Cache_Lite_Function|Cache_Lite_Output
$cache
= \null
$data
public
mixed
$data
= []
$db
public
mixed
$db
= \null
$is_new
public
mixed
$is_new
= \null
$old_data
public
mixed
$old_data
= []
$phoneid_validator_regex
public
mixed
$phoneid_validator_regex
= '/^[0-9]{1,250}$/i'
$rs
public
mixed
$rs
= \null
$tmp_data
public
mixed
$tmp_data
= []
$username_validator_regex
public
mixed
$username_validator_regex
= '/^[a-z0-9-_\\.@\\+]{1,250}$/i'
$validate_only
public
mixed
$validate_only
= \false
$Validator
public
mixed
$Validator
= \null
$address_validator_regex
protected
mixed
$address_validator_regex
= '/^[a-zA-Z0-9-,_\\/\\.\'#\\ |\\x{0080}-\\x{FFFF}]{1,250}$/iu'
$api_message_id
protected
mixed
$api_message_id
= \null
$branch_obj
protected
mixed
$branch_obj
= \null
$city_validator_regex
protected
mixed
$city_validator_regex
= '/^[a-zA-Z0-9-,_\\.\'#\\ |\\x{0080}-\\x{FFFF}]{1,250}$/iu'
$company_obj
protected
mixed
$company_obj
= \null
$currency_obj
protected
mixed
$currency_obj
= \null
$department_obj
protected
mixed
$department_obj
= \null
$enable_system_log_detail
protected
mixed
$enable_system_log_detail
= \true
$group_obj
protected
mixed
$group_obj
= \null
$json_columns
protected
mixed
$json_columns
= ['default_punch_tag_id']
$legal_entity_obj
protected
mixed
$legal_entity_obj
= \null
$name_validator_regex
protected
mixed
$name_validator_regex
= '/^[a-zA-Z- ,\\.\'()\\[\\]|\\x{0080}-\\x{FFFF}]{1,250}$/iu'
$permission_obj
protected
mixed
$permission_obj
= \null
$phonepassword_validator_regex
protected
mixed
$phonepassword_validator_regex
= '/^[0-9]{1,250}$/i'
$pk_sequence_name
protected
mixed
$pk_sequence_name
= 'users_id_seq'
$progress_bar_obj
protected
mixed
$progress_bar_obj
= \null
$table
protected
mixed
$table
= 'users'
$title_obj
protected
mixed
$title_obj
= \null
$user_preference_obj
protected
mixed
$user_preference_obj
= \null
$user_tax_obj
protected
mixed
$user_tax_obj
= \null
$ignore_column_list
private
bool
$ignore_column_list
$is_valid
private
mixed
$is_valid
= \false
Methods
__construct()
Factory constructor.
public
__construct() : mixed
Return values
mixed —__toString()
Print primary columns from object.
public
__toString() : bool|string
Return values
bool|string —addLog()
public
addLog( $log_action) : bool
Parameters
Return values
bool —bulkDelete()
public
bulkDelete(string|array<string|int, mixed> $ids) : bool
Parameters
- $ids : string|array<string|int, mixed>
-
UUID
Tags
Return values
bool —castGenericDataValue()
Generic casting function that all set/get*() functions should pass through.
public
castGenericDataValue( &$value, $cast) : mixed
However for now lets wait until we have meta data from SQL schema so we can pass those datatypes directly into this.
Parameters
Return values
mixed —checkEmployeeNumber()
public
checkEmployeeNumber(string $id) : bool
Parameters
- $id : string
-
UUID
Return values
bool —checkLoginPermissions()
public
checkLoginPermissions() : bool
Return values
bool —checkPassword()
public
checkPassword( $password[, bool $check_password_policy = true ][, bool $delay_failed_attempt = true ]) : bool
Parameters
Tags
Return values
bool —checkPasswordAge()
public
checkPasswordAge() : bool
Return values
bool —checkPasswordResetKey()
public
checkPasswordResetKey( $key) : bool
Parameters
Return values
bool —checkPhonePassword()
public
checkPhonePassword( $password) : bool
Parameters
Return values
bool —checkUserHasEmail()
Checks if user has an email attached to account and sends a notification to users that need to be notified.
public
static checkUserHasEmail() : void
Return values
void —cleanStoragePath()
public
cleanStoragePath([string $company_id = null ][, string $user_id = null ]) : bool
Parameters
- $company_id : string = null
-
UUID
- $user_id : string = null
-
UUID
Return values
bool —clearCacheSavedInTransaction()
public
clearCacheSavedInTransaction() : bool
Return values
bool —clearData()
public
clearData() : bool
Return values
bool —clearGeoCode()
public
clearGeoCode([array<string|int, mixed> $data_diff = null ]) : bool
Parameters
- $data_diff : array<string|int, mixed> = null
Return values
bool —clearNonMappedData()
Removes array elements from $data that are not in the function map.
public
clearNonMappedData([array<string|int, mixed>|null $data = null ]) : array<string|int, mixed>|null
Parameters
- $data : array<string|int, mixed>|null = null
Return values
array<string|int, mixed>|null —clearOldData()
public
clearOldData() : bool
Return values
bool —CommitSavePoint()
public
CommitSavePoint( $name) : bool
Parameters
Return values
bool —CommitTransaction()
public
CommitTransaction([bool $unnest_transactions = false ]) : mixed
Parameters
- $unnest_transactions : bool = false
Tags
Return values
mixed —convertFlexArray()
public
convertFlexArray(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
Return values
array<string|int, mixed> —decodeCustomFields()
public
decodeCustomFields() : bool
Return values
bool —decodeGenericJSONData()
Decode generic 'other_json' column data.
public
decodeGenericJSONData() : bool
Return values
bool —decodeJSONColumn()
Decodes JSON columns that are not the 'other_json' column.
public
decodeJSONColumn( $column) : bool
Parameters
Return values
bool —Delete()
Deletes the record directly from the database.
public
Delete([bool $disable_audit_log = false ]) : bool
Parameters
- $disable_audit_log : bool = false
Tags
Return values
bool —disableExpiredLogins()
Disables all logins past their expire date without going through UserFactory to avoid cases where we aren't able to save records due to validation failures.
public
disableExpiredLogins( $login_expire_date) : $this
Parameters
Tags
Return values
$this —encodeCustomFields()
public
encodeCustomFields() : bool
Return values
bool —encodeGenericJSONData()
Encode generic 'other_json' column data. This should only be done in Save() after all validation has occurred already and we are just about to commit it to the DB.
public
encodeGenericJSONData() : bool
Return values
bool —encodeJSONColumns()
Encode any JSON columns that are not 'other_json' column. This should only be done in Save() after all validation has occurred already and we are just about to commit it to the DB.
public
encodeJSONColumns() : bool
Return values
bool —encryptPasswordResetKey()
public
encryptPasswordResetKey( $key) : string
Parameters
Return values
string —ExecuteSQL()
Execute SQL queries and handle paging properly for select statements.
public
ExecuteSQL(string $query[, array<string|int, mixed> $ph = null ][, int $limit = null ][, int $page = null ]) : bool
Parameters
- $query : string
- $ph : array<string|int, mixed> = null
- $limit : int = null
-
Limit the number of records returned
- $page : int = null
-
Page number of records to return for pagination
Tags
Return values
bool —FailTransaction()
public
FailTransaction() : mixed
Return values
mixed —fromBool()
public
fromBool(string|int|bool $value) : bool
Parameters
- $value : string|int|bool
Return values
bool —fromJSONBool()
public
fromJSONBool(string|int|bool $value) : bool
Parameters
- $value : string|int|bool
Return values
bool —getAddress1()
public
getAddress1() : bool
Return values
bool —getAddress2()
public
getAddress2() : bool
Return values
bool —getAffectedRows()
public
getAffectedRows() : int|bool
Return values
int|bool —getAge()
public
getAge() : float
Return values
float —getAll()
public
getAll([int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : $this
Parameters
- $limit : int = null
-
Limit the number of records returned
- $page : int = null
-
Page number of records to return for pagination
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
$this —getAPIEmailAddressDataByArrayCriteria()
public
getAPIEmailAddressDataByArrayCriteria([null $filter_data = null ][, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : $this
Parameters
- $filter_data : null = null
- $limit : int = null
-
Limit the number of records returned
- $page : int = null
-
Page number of records to return for pagination
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
$this —getAPIMessageID()
Used for updating progress bar for API calls.
public
getAPIMessageID() : bool|null
Return values
bool|null —getAPISearchByCompanyIdAndArrayCriteria()
Return user records based on advanced filter criteria.
public
getAPISearchByCompanyIdAndArrayCriteria(int $company_id, array<string|int, mixed> $filter_data[, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ][, bool $include_last_punch_time = false ]) : bool|object
Parameters
- $company_id : int
-
Company ID
- $filter_data : array<string|int, mixed>
-
Filter criteria in array('id' => array( 'UUID1', 'UUID2'), '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, any_phone, country, province, city, address1, address2, postal_code, employee_number, user_name, sin, email, work_email, home_email, tag, employed_start_date, employed_end_date, partial_employed_start_date, partial_employed_end_date, hire_start_date, hire_end_date, termination_start_date, termination_end_date, birth_start_date, birth_end_date, password_start_date, password_end_date, last_login_start_date, last_login_date, created_by, created_date, updated_by, updated_date
- $limit : int = null
-
Optional. Restrict the number of records returned
- $page : int = null
-
Optional. Specify the page of records to return
- $where : array<string|int, mixed> = null
-
Optional. Additional WHERE clauses in array( 'column' => 'value', 'column' => 'value' ) format.
- $order : array<string|int, mixed> = null
-
Optional. Sort order in array( 'column' => ASC, 'column2' => DESC ) format.
- $include_last_punch_time : bool = false
Return values
bool|object —$this
getArrayByListFactory()
public
static getArrayByListFactory( $lf[, bool $include_blank = true ][, bool $include_disabled = true ]) : bool
Parameters
Return values
bool —getBirthDate()
public
getBirthDate([bool $raw = false ]) : bool|mixed
Parameters
- $raw : bool = false
Return values
bool|mixed —getByCompanyId()
public
getByCompanyId(string $company_id[, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $company_id : string
-
UUID
- $limit : int = null
-
Limit the number of records returned
- $page : int = null
-
Page number of records to return for pagination
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByCompanyIDAndEmployeeNumber()
public
getByCompanyIDAndEmployeeNumber(string $company_id, $employee_number[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $company_id : string
-
UUID
- $employee_number :
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByCompanyIDAndGroupID()
public
getByCompanyIDAndGroupID(string $company_id, string $id[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $company_id : string
-
UUID
- $id : string
-
UUID
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByCompanyIdAndLongitudeAndLatitude()
public
getByCompanyIdAndLongitudeAndLatitude(string $company_id, $longitude, $latitude[, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $company_id : string
-
UUID
- $longitude :
- $latitude :
- $limit : int = null
-
Limit the number of records returned
- $page : int = null
-
Page number of records to return for pagination
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByCompanyIDAndPermissionLevel()
public
getByCompanyIDAndPermissionLevel(string $company_id, $level[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $company_id : string
-
UUID
- $level :
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByCompanyIDAndStationIDAndStatusAndDate()
public
getByCompanyIDAndStationIDAndStatusAndDate(string $company_id, string $station_id, int $status_id[, int $date = null ][, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $company_id : string
-
UUID
- $station_id : string
-
UUID
- $status_id : int
- $date : int = null
-
EPOCH
- $limit : int = null
-
Limit the number of records returned
- $page : int = null
-
Page number of records to return for pagination
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByCompanyIDAndStationIDAndStatusAndDateAndValidUserIDs()
public
getByCompanyIDAndStationIDAndStatusAndDateAndValidUserIDs(string $company_id, string $station_id, int $status_id[, int $date = null ][, array<string|int, mixed> $new_user_ids = [] ][, array<string|int, mixed> $all_user_ids = [] ][, string $current_user_id = null ][, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $company_id : string
-
UUID
- $station_id : string
-
UUID
- $status_id : int
- $date : int = null
-
EPOCH
- $new_user_ids : array<string|int, mixed> = []
- $all_user_ids : array<string|int, mixed> = []
- $current_user_id : string = null
-
UUID
- $limit : int = null
-
Limit the number of records returned
- $page : int = null
-
Page number of records to return for pagination
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByCompanyIDAndStationIDAndStatusAndEmployeeNumber()
public
getByCompanyIDAndStationIDAndStatusAndEmployeeNumber(string $company_id, string $station_id, int $status_id, $employee_number[, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $company_id : string
-
UUID
- $station_id : string
-
UUID
- $status_id : int
- $employee_number :
- $limit : int = null
-
Limit the number of records returned
- $page : int = null
-
Page number of records to return for pagination
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByCompanyIdAndStatus()
public
getByCompanyIdAndStatus(string $company_id, $status[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $company_id : string
-
UUID
- $status :
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByCompanyIDAndStatusIdAndMinimumPermissionLevelAndRecentNotification()
public
getByCompanyIDAndStatusIdAndMinimumPermissionLevelAndRecentNotification(string $company_id, mixed $status_id, int $level, mixed $object_id, mixed $created_before[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $company_id : string
-
UUID
- $status_id : mixed
- $level : int
- $object_id : mixed
- $created_before : mixed
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByCompanyIdAndTerminatedPermissionControl()
public
getByCompanyIdAndTerminatedPermissionControl(string $company_id, string $terminated_permission_control_id[, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $company_id : string
-
UUID
- $terminated_permission_control_id : string
-
UUID
- $limit : int = null
-
Limit the number of records returned
- $page : int = null
-
Page number of records to return for pagination
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByCompanyIdArray()
public
static getByCompanyIdArray(string $company_id[, bool $include_blank = true ][, bool $include_disabled = true ][, bool $last_name_first = true ]) : bool
Parameters
- $company_id : string
-
UUID
- $include_blank : bool = true
- $include_disabled : bool = true
- $last_name_first : bool = true
Return values
bool —getByCurrencyID()
public
getByCurrencyID(string $id[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $id : string
-
UUID
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByEmailIsValidKey()
public
getByEmailIsValidKey( $key) : bool|UserListFactory
Parameters
Return values
bool|UserListFactory —getByHomeEmailOrWorkEmail()
public
getByHomeEmailOrWorkEmail( $email) : bool|UserListFactory
Parameters
Return values
bool|UserListFactory —getById()
public
getById(string $id) : bool|UserListFactory
Parameters
- $id : string
-
UUID
Return values
bool|UserListFactory —getByIdAndCompanyId()
public
getByIdAndCompanyId(string|array<string|int, string> $id, string $company_id[, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $id : string|array<string|int, string>
-
UUID
- $company_id : string
-
UUID
- $limit : int = null
-
Limit the number of records returned
- $page : int = null
-
Page number of records to return for pagination
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByIdAndStatus()
public
getByIdAndStatus(string $id, $status[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $id : string
-
UUID
- $status :
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByLegalEntityIdAndCompanyId()
public
getByLegalEntityIdAndCompanyId(string $id, string $company_id[, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $id : string
-
UUID
- $company_id : string
-
UUID
- $limit : int = null
-
Limit the number of records returned
- $page : int = null
-
Page number of records to return for pagination
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByPasswordResetKey()
public
getByPasswordResetKey( $key) : bool|UserListFactory
Parameters
Return values
bool|UserListFactory —getByPhoneIdAndStatus()
public
getByPhoneIdAndStatus(string $phone_id, $status[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $phone_id : string
-
UUID
- $status :
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByStatus()
public
getByStatus( $status[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : $this
Parameters
- $status :
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
$this —getByUserName()
public
getByUserName( $user_name[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $user_name :
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByUserNameAndCompanyId()
public
getByUserNameAndCompanyId( $user_name, string $company_id[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $user_name :
- $company_id : string
-
UUID
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByUserNameAndEnableLogin()
public
getByUserNameAndEnableLogin( $user_name, $enable_login[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $user_name :
- $enable_login :
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getByUserNameAndStatus()
public
getByUserNameAndStatus( $user_name, $status[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $user_name :
- $status :
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getCache()
public
getCache(string $cache_id[, string $group_id = null ]) : bool|mixed
Parameters
- $cache_id : string
- $group_id : string = null
Return values
bool|mixed —getCity()
public
getCity() : bool|mixed
Return values
bool|mixed —getColumn()
Generic function get any data from the data array.
public
getColumn(string $column) : bool|mixed
Used mainly for the reports that return grouped queries and such.
Parameters
- $column : string
Return values
bool|mixed —getColumnList()
public
getColumnList() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool —getCompany()
public
getCompany() : bool|int|string
Return values
bool|int|string —getCompanyGenericMapData()
Generic function to return and cache CompanyGenericMap data, this greatly improves performance of CalculatePolicy when many policies exist.
public
getCompanyGenericMapData(string $company_id, int $object_type_id, string $id, string $variable) : mixed
Parameters
- $company_id : string
-
UUID
- $object_type_id : int
- $id : string
-
UUID
- $variable : string
Return values
mixed —getCompanyObject()
public
getCompanyObject() : bool
Return values
bool —getCompanyValidUserIds()
Security measure, only returns user_ids that are valid for the specific company.
public
getCompanyValidUserIds(string $id, string $company_id) : bool
Parameters
- $id : string
-
UUID
- $company_id : string
-
UUID
Return values
bool —getCountry()
public
getCountry() : bool|mixed
Return values
bool|mixed —getCreatedAndUpdatedColumns()
public
getCreatedAndUpdatedColumns(array<string|int, mixed> &$data[, null $include_columns = null ]) : bool
Parameters
- $data : array<string|int, mixed>
- $include_columns : null = null
Return values
bool —getCreatedBy()
public
getCreatedBy() : bool|mixed
Return values
bool|mixed —getCreatedDate()
public
getCreatedDate() : int
Return values
int —getCurrency()
public
getCurrency() : bool|mixed
Return values
bool|mixed —getCurrencyObject()
public
getCurrencyObject() : bool
Return values
bool —getCurrent()
Grabs the current object
public
final getCurrent() : mixed
Return values
mixed —getCurrentPassword()
public
getCurrentPassword() : bool
Return values
bool —getCurrentRow()
public
getCurrentRow([int $offset = 1 ]) : int|bool
Parameters
- $offset : int = 1
Return values
int|bool —getCurrentUserPermissionLevel()
public
getCurrentUserPermissionLevel() : bool|int
Return values
bool|int —getCustomField()
Get a single custom field by ID.
public
getCustomField(string $id) : void
Parameters
- $id : string
-
UUID
Return values
void —getCustomFields()
public
getCustomFields( $company_id, $data[, $include_columns = null ]) : mixed
Parameters
Return values
mixed —getCustomFieldsColumns()
public
getCustomFieldsColumns(array<string|int, mixed> $columns, string $company_id[, bool $use_sort_prefix = true ][, string|null $table_name = null ]) : array<string|int, mixed>
Parameters
- $columns : array<string|int, mixed>
- $company_id : string
- $use_sort_prefix : bool = true
- $table_name : string|null = null
Return values
array<string|int, mixed> —getCustomFieldsDataForObject()
Get custom field data for this specific object, so it can be easily cached in memory without having to go to the database or unserialize it from cache for every row.
public
getCustomFieldsDataForObject( $company_id[, mixed $table_name = null ]) : array<string|int, mixed>
Parameters
Tags
Return values
array<string|int, mixed> —getCustomFieldsDefaultData()
public
getCustomFieldsDefaultData( $company_id, $data[, bool $get_all_fields = false ]) : mixed
Parameters
Return values
mixed —getCustomFieldsParseHints()
public
getCustomFieldsParseHints(array<string|int, mixed> $columns, string $company_id, string|null $table_name) : array<string|int, mixed>
Parameters
- $columns : array<string|int, mixed>
- $company_id : string
- $table_name : string|null
Return values
array<string|int, mixed> —getCustomFieldTableName()
public
getCustomFieldTableName() : string
Return values
string —getDataDifferences()
Returns the differences in data from the DB vs the in-memory object, so the data will be the OLD data. Used in Validation/postSave() functions to determine if a field has changed or not.
public
getDataDifferences() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDateRangeSQL()
This function takes plain input from the user and creates a SQL statement for filtering based on a date range.
public
getDateRangeSQL(string $str, string $column[, string $format = 'epoch' ][, bool $include_blank_dates = false ]) : bool|string
Supported Syntax:
=01-Jan-09 <=01-Jan-09 <01-Jan-09 01-Jan-09 01-Jan-09 & <10-Jan-09
Parameters
- $str : string
- $column : string
- $format : string = 'epoch'
- $include_blank_dates : bool = false
Return values
bool|string —getDefaultBranch()
public
getDefaultBranch() : bool|mixed
Return values
bool|mixed —getDefaultBranchObject()
public
getDefaultBranchObject() : bool
Return values
bool —getDefaultDepartment()
public
getDefaultDepartment() : bool|mixed
Return values
bool|mixed —getDefaultDepartmentObject()
public
getDefaultDepartmentObject() : bool
Return values
bool —getDefaultJob()
public
getDefaultJob() : bool|mixed
Return values
bool|mixed —getDefaultJobItem()
public
getDefaultJobItem() : bool|mixed
Return values
bool|mixed —getDefaultPunchTag()
public
getDefaultPunchTag() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDeleted()
public
getDeleted() : bool
Return values
bool —getDeletedBy()
public
getDeletedBy() : bool|mixed
Return values
bool|mixed —getDeletedByCompanyIdAndDate()
public
getDeletedByCompanyIdAndDate(string $company_id, int $date[, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $company_id : string
-
UUID
- $date : int
-
EPOCH
- $limit : int = null
-
Limit the number of records returned
- $page : int = null
-
Page number of records to return for pagination
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getDeletedDate()
public
getDeletedDate() : bool|mixed
Return values
bool|mixed —getEmployeeNumber()
public
getEmployeeNumber() : bool|int
Return values
bool|int —getEmptyRecordSet()
public
getEmptyRecordSet([string $id = null ]) : mixed
Parameters
- $id : string = null
-
UUID
Tags
Return values
mixed —getEnableClearPasswordResetData()
public
getEnableClearPasswordResetData() : bool
Return values
bool —getEnableLogin()
public
getEnableLogin() : bool
Return values
bool —getEnableSystemLogDetail()
public
getEnableSystemLogDetail() : bool
Return values
bool —getEthnicGroup()
public
getEthnicGroup() : bool
Return values
bool —getFaxPhone()
public
getFaxPhone() : bool|mixed
Return values
bool|mixed —getFeedbackRating()
public
getFeedbackRating() : bool
Return values
bool —getFirstName()
public
getFirstName() : bool|mixed
Return values
bool|mixed —getFirstNameMetaphone()
public
getFirstNameMetaphone() : bool|mixed
Return values
bool|mixed —getFullName()
public
getFullName([bool $reverse = false ][, bool $include_middle = true ]) : bool|string
Parameters
- $reverse : bool = false
- $include_middle : bool = true
Return values
bool|string —getFullNameById()
public
static getFullNameById(string $id) : bool
Parameters
- $id : string
-
UUID
Return values
bool —getGenericDataValue()
Generic getter/setter functions that should be used when Validation code is moved from get/set functions to Validate() function.
public
getGenericDataValue(string $name[, null $cast = null ]) : bool|mixed
Parameters
- $name : string
- $cast : null = null
Return values
bool|mixed —getGenericJSONDataValue()
Generic getter/setter functions for handling generic JSON data in 'other_json' SQL column.
public
getGenericJSONDataValue(string $name[, null $cast = null ]) : bool|mixed
Parameters
- $name : string
- $cast : null = null
Return values
bool|mixed —getGenericObject()
Generic function to return and cache class objects ListFactory, ListFactoryMethod, Variable, ID, IDMethod
public
getGenericObject(string $list_factory, string|int $id, string $variable[, string $list_factory_method = 'getById' ][, string $id_method = 'getID' ]) : object|bool
Parameters
- $list_factory : string
- $id : string|int
-
UUID
- $variable : string
- $list_factory_method : string = 'getById'
- $id_method : string = 'getID'
Return values
object|bool —getGenericOldDataValue()
public
getGenericOldDataValue(string $name) : bool|mixed
Parameters
- $name : string
-
Gets data value from old_data array, or the original value in the database, prior to any changes currently in memory.
Return values
bool|mixed —getGenericTempDataValue()
Generic getter/setter functions that should be used when Validation code is moved from get/set functions to Validate() function.
public
getGenericTempDataValue(string $name) : bool
Parameters
- $name : string
Return values
bool —getGroup()
public
getGroup() : bool|mixed
Return values
bool|mixed —getGroupObject()
public
getGroupObject() : bool
Return values
bool —getHierarchyControl()
public
getHierarchyControl() : bool
Return values
bool —getHierarchyControlDisplay()
Display each hierarchy that the employee is assigned too.
public
getHierarchyControlDisplay() : bool|string
Return values
bool|string —getHierarchyLevelDisplay()
Display each superior that the employee is assigned too.
public
getHierarchyLevelDisplay() : bool|string
Return values
bool|string —getHighestEmployeeNumberByCompanyId()
public
getHighestEmployeeNumberByCompanyId(string $id[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $id : string
-
UUID
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getHireDate()
public
getHireDate([bool $raw = false ]) : bool|mixed
Parameters
- $raw : bool = false
Return values
bool|mixed —getHomeEmail()
public
getHomeEmail() : bool|mixed
Return values
bool|mixed —getHomeEmailIsValid()
public
getHomeEmailIsValid() : bool
Return values
bool —getHomeEmailIsValidDate()
public
getHomeEmailIsValidDate() : mixed
Return values
mixed —getHomeEmailIsValidKey()
public
getHomeEmailIsValidKey() : bool|mixed
Return values
bool|mixed —getHomePhone()
public
getHomePhone() : bool|mixed
Return values
bool|mixed —getId()
public
getId() : bool|mixed
Return values
bool|mixed —getIDSByListFactory()
public
getIDSByListFactory(object $lf) : array<string|int, mixed>|bool
Parameters
- $lf : object
Return values
array<string|int, mixed>|bool —getIsModifiedByCompanyIdAndDate()
public
getIsModifiedByCompanyIdAndDate(string $company_id, int $date[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool
Parameters
- $company_id : string
-
UUID
- $date : int
-
EPOCH
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool —getIsRequiredCurrentPassword()
public
getIsRequiredCurrentPassword() : bool
Return values
bool —getIterator()
public
final getIterator() : FactoryListIterator
Return values
FactoryListIterator —getLabelId()
public
getLabelId() : bool|mixed|string
Return values
bool|mixed|string —getLastLoginDate()
public
getLastLoginDate() : bool|mixed
Return values
bool|mixed —getLastName()
public
getLastName() : bool|mixed
Return values
bool|mixed —getLastNameMetaphone()
public
getLastNameMetaphone() : bool|mixed
Return values
bool|mixed —getLatitude()
public
getLatitude() : bool|float
Return values
bool|float —getLegalEntity()
public
getLegalEntity() : bool|mixed
Return values
bool|mixed —getLegalEntityObject()
public
getLegalEntityObject() : bool
Return values
bool —getLoginExpireDate()
public
getLoginExpireDate([bool $raw = false ]) : bool|mixed
Parameters
- $raw : bool = false
Return values
bool|mixed —getLongitude()
public
getLongitude() : bool|float
Return values
bool|float —getMapURL()
public
getMapURL() : bool|string
Return values
bool|string —getMiddleInitial()
public
getMiddleInitial() : bool
Return values
bool —getMiddleName()
public
getMiddleName() : bool|mixed
Return values
bool|mixed —getMobilePhone()
public
getMobilePhone() : bool|mixed
Return values
bool|mixed —getNextAvailableEmployeeNumber()
public
getNextAvailableEmployeeNumber([string $company_id = null ]) : int|null
Parameters
- $company_id : string = null
-
UUID
Return values
int|null —getNextInsertId()
public
getNextInsertId() : bool|string
Return values
bool|string —getNote()
public
getNote() : bool|mixed
Return values
bool|mixed —getObjectAsArray()
public
getObjectAsArray([null $include_columns = null ][, bool $permission_children_ids = false ]) : array<string|int, mixed>
Parameters
- $include_columns : null = null
- $permission_children_ids : bool = false
Return values
array<string|int, mixed> —getOptions()
public
getOptions(string $name[, string|int $parent = null ]) : array<string|int, mixed>|bool
Parameters
- $name : string
- $parent : string|int = null
Return values
array<string|int, mixed>|bool —getPassword()
public
getPassword() : bool|mixed
Return values
bool|mixed —getPasswordResetDate()
public
getPasswordResetDate() : mixed
Return values
mixed —getPasswordResetKey()
public
getPasswordResetKey() : bool|mixed
Return values
bool|mixed —getPasswordUpdatedDate()
public
getPasswordUpdatedDate() : bool|mixed
Return values
bool|mixed —getPayPeriodSchedule()
public
getPayPeriodSchedule() : bool
Return values
bool —getPermissionColumns()
public
getPermissionColumns(array<string|int, mixed> &$data, string $object_user_id, string $created_by_id[, string $permission_children_ids = null ][, array<string|int, mixed> $include_columns = null ]) : bool
Parameters
- $data : array<string|int, mixed>
- $object_user_id : string
-
UUID
- $created_by_id : string
-
UUID
- $permission_children_ids : string = null
-
UUID
- $include_columns : array<string|int, mixed> = null
Return values
bool —getPermissionControl()
public
getPermissionControl([bool $force = false ]) : bool
Parameters
- $force : bool = false
Return values
bool —getPermissionLevel()
public
getPermissionLevel() : bool|int
Return values
bool|int —getPermissionObject()
public
getPermissionObject() : Permission|null
Return values
Permission|null —getPhoneId()
public
getPhoneId() : bool|string
Return values
bool|string —getPhonePassword()
public
getPhonePassword() : bool|mixed
Return values
bool|mixed —getPhotoFileName()
public
getPhotoFileName([string $company_id = null ][, string $user_id = null ][, bool $include_default_photo = true ]) : bool|string
Parameters
- $company_id : string = null
-
UUID
- $user_id : string = null
-
UUID
- $include_default_photo : bool = true
Return values
bool|string —getPolicyGroup()
public
getPolicyGroup() : bool
Return values
bool —getPostalCode()
public
getPostalCode() : bool|mixed
Return values
bool|mixed —getProgressBarObject()
public
getProgressBarObject() : null|ProgressBar
Return values
null|ProgressBar —getPromptForFeedback()
Determines if the user should be prompted for feedback.
public
getPromptForFeedback() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool —getProvince()
public
getProvince() : bool|mixed
Return values
bool|mixed —getRecordCount()
public
getRecordCount() : int|bool
Return values
int|bool —getRecurringSchedule()
public
getRecurringSchedule() : array<string|int, mixed>
Return values
array<string|int, mixed> —getReportByCompanyIdAndUserIDList()
public
getReportByCompanyIdAndUserIDList(string $company_id, string $user_ids[, array<string|int, mixed> $order = null ]) : bool|UserListFactory
Parameters
- $company_id : string
-
UUID
- $user_ids : string
-
UUID
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool|UserListFactory —getSecondLastName()
public
getSecondLastName() : bool|mixed
Return values
bool|mixed —getSecureSIN()
public
getSecureSIN([null $sin = null ][, bool $force_secure = false ]) : bool|string
Parameters
- $sin : null = null
- $force_secure : bool = false
-
Force the SIN to always be secure regardless of permissions.
Return values
bool|string —getSequenceName()
public
getSequenceName() : bool
Return values
bool —getSex()
public
getSex() : bool|int
Return values
bool|int —getSIN()
public
getSIN() : bool|mixed
Return values
bool|mixed —getStatus()
public
getStatus() : bool|int
Return values
bool|int —getStoragePath()
public
getStoragePath([string $company_id = null ][, string $user_id = null ]) : bool|string
Parameters
- $company_id : string = null
-
UUID
- $user_id : string = null
-
UUID
Return values
bool|string —getTable()
public
getTable([bool $strip_quotes = false ]) : bool|string
Parameters
- $strip_quotes : bool = false
Return values
bool|string —getTag()
public
getTag() : bool|string
Return values
bool|string —getTerminatedPermissionControl()
public
getTerminatedPermissionControl() : bool|mixed
Return values
bool|mixed —getTerminatedPermissionLevel()
public
getTerminatedPermissionLevel() : bool
Return values
bool —getTerminationDate()
public
getTerminationDate([bool $raw = false ]) : bool|mixed
Parameters
- $raw : bool = false
Return values
bool|mixed —getTitle()
public
getTitle() : bool|mixed
Return values
bool|mixed —getTitleObject()
public
getTitleObject() : bool
Return values
bool —getTransactionMode()
public
getTransactionMode([bool $force = false ]) : string
Parameters
- $force : bool = false
Return values
string —getUniqueCountryByCompanyId()
public
getUniqueCountryByCompanyId(string $id[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool
Parameters
- $id : string
-
UUID
- $where : array<string|int, mixed> = null
-
Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
- $order : array<string|int, mixed> = null
-
Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
Return values
bool —getUpdatedBy()
public
getUpdatedBy() : bool|mixed
Return values
bool|mixed —getUpdatedDate()
public
getUpdatedDate() : int
Return values
int —getUserDefault()
public
getUserDefault() : bool
Return values
bool —getUserName()
public
getUserName() : bool|mixed
Return values
bool|mixed —getUserPreferenceObject()
public
getUserPreferenceObject() : bool|null|object
Return values
bool|null|object —getValidSQLColumns()
public
getValidSQLColumns(array<string|int, mixed> $array[, bool $strict = true ][, array<string|int, mixed> $additional_fields = null ]) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
- $strict : bool = true
- $additional_fields : array<string|int, mixed> = null
Tags
Return values
array<string|int, mixed> —getVariableToFunctionMap()
public
getVariableToFunctionMap([array<string|int, mixed> $data = null ]) : array<string|int, mixed>|bool
Parameters
- $data : array<string|int, mixed> = null
Return values
array<string|int, mixed>|bool —getWorkEmail()
public
getWorkEmail() : bool|mixed
Return values
bool|mixed —getWorkEmailIsValid()
public
getWorkEmailIsValid() : bool
Return values
bool —getWorkEmailIsValidDate()
public
getWorkEmailIsValidDate() : mixed
Return values
mixed —getWorkEmailIsValidKey()
public
getWorkEmailIsValidKey() : bool|mixed
Return values
bool|mixed —getWorkPhone()
public
getWorkPhone() : bool|mixed
Return values
bool|mixed —getWorkPhoneExt()
public
getWorkPhoneExt() : bool|mixed
Return values
bool|mixed —handleSaveSQLReturning()
Used to handle any "RETURNING ..." clause on a SQL INSERT/UPDATE query.
public
handleSaveSQLReturning( $rs) : bool
Parameters
Return values
bool —hasDataChanged()
Determine if the record data has changed at all.
public
hasDataChanged() : bool
Return values
bool —isClientFriendly()
Check if the remote client is our main UI app controlled by us, vs. a user utilizing the API for example.
public
isClientFriendly() : bool
This is mostly used to determine if we can return columns that are resource intensive to compute when obtaining a list. (ie: Users, Jobs)
Return values
bool —isCompromisedPassword()
public
isCompromisedPassword() : bool
Return values
bool —isCurrentlyLoggedInUser()
Check if the current user record is also for the currently logged in user.
public
isCurrentlyLoggedInUser() : bool
Return values
bool —isDataDifferent()
Used to check the differences between a single key in the $old_data vs. $data arrays.
public
isDataDifferent( $key, $data_diff[, null $type_id = null ][, null $new_data = null ]) : bool
This is especially important to use when trying to see if a date or timestamp field in the DB has changed, as they need to be handled in special ways.
Parameters
Return values
bool —isFirstLogin()
public
isFirstLogin() : bool
Return values
bool —isNew()
Determines if the data is new data, or updated data. Basically determines if a database INSERT or UPDATE SQL statement is generated.
public
isNew([bool $force_lookup = false ][, string $id = null ]) : bool
Parameters
- $force_lookup : bool = false
- $id : string = null
-
UUID
Return values
bool —isPasswordPolicyEnabled()
public
isPasswordPolicyEnabled() : bool
Return values
bool —isPhotoExists()
public
isPhotoExists() : bool
Return values
bool —isSQLExceptionRetryable()
Determines if a SQL exception is one that can be retried or not.
public
isSQLExceptionRetryable( $e) : bool
Parameters
Return values
bool —isUniqueEmployeeNumber()
public
isUniqueEmployeeNumber(string $id) : bool
Parameters
- $id : string
-
UUID
Return values
bool —isUniqueHomeEmail()
public
isUniqueHomeEmail( $email) : bool
Parameters
Return values
bool —isUniquePhoneId()
public
isUniquePhoneId(string $phone_id) : bool
Parameters
- $phone_id : string
-
UUID
Return values
bool —isUniqueSIN()
public
isUniqueSIN( $sin) : bool
Parameters
Return values
bool —isUniqueUserName()
public
isUniqueUserName( $user_name) : bool
Parameters
Return values
bool —isUniqueWorkEmail()
public
isUniqueWorkEmail( $email) : bool
Parameters
Return values
bool —isValid()
Call class specific validation function just before saving.
public
isValid([bool $ignore_warning = true ]) : bool
Parameters
- $ignore_warning : bool = true
Return values
bool —isValidWageForHireDate()
public
isValidWageForHireDate(int $epoch) : bool
Parameters
- $epoch : int
-
EPOCH
Return values
bool —isWarning()
Call class specific validation function just before saving.
public
isWarning() : bool
Return values
bool —modifyInsertQuery()
Modifies the automatically generated SQL INSERT query for adding things like " ON CONFLICT ..."
public
modifyInsertQuery( $query) : mixed
Parameters
Return values
mixed —parseCustomFieldsFromArray()
public
parseCustomFieldsFromArray( $data) : mixed
Parameters
Return values
mixed —postSave()
public
postSave() : bool
Return values
bool —preValidate()
public
preValidate() : bool
Return values
bool —removeCache()
public
removeCache([string $cache_id = null ][, string $group_id = null ]) : bool
Parameters
- $cache_id : string = null
- $group_id : string = null
Return values
bool —RetryTransaction()
Accepts a Closure and is retried at set intervals which should be in a transaction.
public
RetryTransaction( $transaction_function[, int $retry_max_attempts = 4 ][, int $retry_sleep = 1 ]) : mixed
Parameters
Tags
Return values
mixed —rewind()
Rewinds record set iterator to begining. The same as ADODB's MoveFirst() function.
public
final rewind() : bool
Return values
bool —RollbackSavePoint()
public
RollbackSavePoint( $name) : bool
Parameters
Return values
bool —Save()
Determines to insert or update, and does it.
public
Save([bool $reset_data = true ][, bool $force_lookup = false ]) : bool|int|string
Have this handle created, createdby, updated, updatedby.
Parameters
- $reset_data : bool = true
- $force_lookup : bool = false
Tags
Return values
bool|int|string —saveCache()
public
saveCache(mixed $data, string $cache_id[, string $group_id = null ]) : bool
Parameters
- $data : mixed
- $cache_id : string
- $group_id : string = null
Return values
bool —sendPasswordResetEmail()
public
sendPasswordResetEmail() : bool
Return values
bool —sendValidateEmail()
public
sendValidateEmail([string $type = 'work' ]) : bool
Parameters
- $type : string = 'work'
Return values
bool —serializeRS()
Serialize ADODB recordset.
public
serializeRS(object $rs) : string
Parameters
- $rs : object
Tags
Return values
string —setAddress1()
public
setAddress1( $value) : bool
Parameters
Return values
bool —setAddress2()
public
setAddress2( $value) : bool
Parameters
Return values
bool —setAPIMessageID()
public
setAPIMessageID(string $id) : bool
Parameters
- $id : string
-
UUID
Return values
bool —setBirthDate()
public
setBirthDate(int $value) : bool
Parameters
- $value : int
-
EPOCH
Return values
bool —setCacheLifeTime()
public
setCacheLifeTime(int $secs) : bool
Parameters
- $secs : int
Return values
bool —setCity()
public
setCity( $value) : bool
Parameters
Return values
bool —setCompany()
public
setCompany(string $value) : bool
Parameters
- $value : string
-
UUID
Return values
bool —setCountry()
public
setCountry( $value) : bool
Parameters
Return values
bool —setCreatedAndUpdatedColumns()
public
setCreatedAndUpdatedColumns(array<string|int, mixed> $data[, array<string|int, mixed> $variable_to_function_map = [] ]) : bool
Parameters
- $data : array<string|int, mixed>
- $variable_to_function_map : array<string|int, mixed> = []
Return values
bool —setCreatedBy()
public
setCreatedBy([string $id = null ]) : bool
Parameters
- $id : string = null
-
UUID
Return values
bool —setCreatedDate()
public
setCreatedDate([int $epoch = null ]) : bool
Parameters
- $epoch : int = null
-
EPOCH
Return values
bool —setCurrency()
public
setCurrency(string $value) : bool
Parameters
- $value : string
-
UUID
Return values
bool —setCurrentPassword()
public
setCurrentPassword(string $value) : bool
Parameters
- $value : string
Return values
bool —setCustomField()
Set a single custom field by ID.
public
setCustomField(mixed $value, string $id) : void
Parameters
- $value : mixed
- $id : string
-
UUID
Return values
void —setCustomFields()
public
setCustomFields( $data) : bool
Parameters
Return values
bool —setDefaultBranch()
public
setDefaultBranch(string $value) : bool
Parameters
- $value : string
-
UUID
Return values
bool —setDefaultDepartment()
public
setDefaultDepartment(string $value) : bool
Parameters
- $value : string
-
UUID
Return values
bool —setDefaultJob()
public
setDefaultJob(string $value) : bool
Parameters
- $value : string
-
UUID
Return values
bool —setDefaultJobItem()
public
setDefaultJobItem(string $value) : bool
Parameters
- $value : string
-
UUID
Return values
bool —setDefaultPunchTag()
public
setDefaultPunchTag(array<string|int, mixed> $value) : bool
Parameters
- $value : array<string|int, mixed>
-
UUID
Return values
bool —setDeleted()
public
setDeleted(bool $bool) : bool
Parameters
- $bool : bool
Return values
bool —setDeletedBy()
public
setDeletedBy([string $id = null ]) : bool|null
Parameters
- $id : string = null
-
UUID
Return values
bool|null —setDeletedDate()
public
setDeletedDate([int $epoch = null ]) : bool
Parameters
- $epoch : int = null
-
EPOCH
Return values
bool —setEmployeeNumber()
public
setEmployeeNumber( $value) : bool
Parameters
Return values
bool —setEnableClearPasswordResetData()
public
setEnableClearPasswordResetData([bool $value = true ]) : bool
Parameters
- $value : bool = true
Return values
bool —setEnableLogin()
public
setEnableLogin([bool $value = true ]) : bool
Parameters
- $value : bool = true
Return values
bool —setEnableSystemLogDetail()
public
setEnableSystemLogDetail( $bool) : bool
Parameters
Return values
bool —setEthnicGroup()
public
setEthnicGroup(string $value) : bool
Parameters
- $value : string
-
UUID
Return values
bool —setFaxPhone()
public
setFaxPhone( $value) : bool
Parameters
Return values
bool —setFeedbackRating()
public
setFeedbackRating( $value) : bool
Parameters
Return values
bool —setFirstName()
public
setFirstName( $value) : bool
Parameters
Return values
bool —setFirstNameMetaphone()
public
setFirstNameMetaphone( $value) : bool
Parameters
Return values
bool —setGenericDataValue()
public
setGenericDataValue(string $name, mixed $data[, null $cast = null ]) : bool
Parameters
- $name : string
- $data : mixed
- $cast : null = null
Return values
bool —setGenericJSONDataValue()
Generic getter/setter functions for handling generic JSON data in 'other_json' SQL column.
public
setGenericJSONDataValue(string $name, mixed $data[, null $cast = null ]) : bool
Parameters
- $name : string
- $data : mixed
- $cast : null = null
Return values
bool —setGenericObject()
Allow method to pre-populate/overwrite the cache if needed.
public
setGenericObject(object $obj, string $variable) : bool
Parameters
- $obj : object
- $variable : string
Return values
bool —setGenericTempDataValue()
public
setGenericTempDataValue(string $name, mixed $data) : bool
Parameters
- $name : string
- $data : mixed
Return values
bool —setGroup()
public
setGroup(string $value) : bool
Parameters
- $value : string
-
UUID
Return values
bool —setHierarchyControl()
public
setHierarchyControl( $data) : bool
Parameters
Return values
bool —setHireDate()
public
setHireDate( $value) : bool
Parameters
Return values
bool —setHomeEmail()
public
setHomeEmail( $value) : bool
Parameters
Return values
bool —setHomeEmailIsValid()
public
setHomeEmailIsValid( $value) : bool
Parameters
Return values
bool —setHomeEmailIsValidDate()
public
setHomeEmailIsValidDate(int $value) : bool
Parameters
- $value : int
-
EPOCH
Return values
bool —setHomeEmailIsValidKey()
public
setHomeEmailIsValidKey( $value) : bool
Parameters
Return values
bool —setHomePhone()
public
setHomePhone( $value) : bool
Parameters
Return values
bool —setId()
public
setId(string $id) : bool
Parameters
- $id : string
-
UUID
Return values
bool —setIsRequiredCurrentPassword()
public
setIsRequiredCurrentPassword(bool $value) : bool
Parameters
- $value : bool
Return values
bool —setIsValid()
Sets the is_valid flag, mostly used to set it to FALSE to force a full re-validation.
public
setIsValid([bool $is_valid = false ]) : bool
Required because $this->is_valid is a private variable and should stay that way.
Parameters
- $is_valid : bool = false
Return values
bool —setLastLoginDate()
public
setLastLoginDate(int $value) : bool
Parameters
- $value : int
-
EPOCH
Return values
bool —setLastName()
public
setLastName( $value) : bool
Parameters
Return values
bool —setLastNameMetaphone()
public
setLastNameMetaphone( $value) : bool
Parameters
Return values
bool —setLatitude()
public
setLatitude( $value) : bool
Parameters
Return values
bool —setLegalEntity()
public
setLegalEntity(string $value) : bool
Parameters
- $value : string
-
UUID
Return values
bool —setLoginExpireDate()
public
setLoginExpireDate( $value) : bool
Parameters
Return values
bool —setLongitude()
public
setLongitude( $value) : bool
Parameters
Return values
bool —setMiddleName()
public
setMiddleName( $value) : bool
Parameters
Return values
bool —setMobilePhone()
public
setMobilePhone( $value) : bool
Parameters
Return values
bool —setNote()
public
setNote( $value) : bool
Parameters
Return values
bool —setObjectFromArray()
Support setting created_by, updated_by especially for importing data.
public
setObjectFromArray( $data) : bool
Make sure data is set based on the getVariableToFunctionMap order.
Parameters
Return values
bool —setPassword()
public
setPassword( $password[, null $password_confirm = null ][, bool $force = false ]) : bool
Parameters
Return values
bool —setPasswordResetDate()
public
setPasswordResetDate(int $value) : bool
Parameters
- $value : int
-
EPOCH
Return values
bool —setPasswordResetKey()
public
setPasswordResetKey( $value) : bool
Parameters
Return values
bool —setPasswordUpdatedDate()
public
setPasswordUpdatedDate(int $value) : bool
Parameters
- $value : int
-
EPOCH
Return values
bool —setPayPeriodSchedule()
public
setPayPeriodSchedule(string $value) : bool
Parameters
- $value : string
-
UUID
Return values
bool —setPermissionControl()
public
setPermissionControl(string $value) : bool
Parameters
- $value : string
-
UUID
Return values
bool —setPhoneId()
public
setPhoneId(string $value) : bool
Parameters
- $value : string
-
UUID
Return values
bool —setPhonePassword()
public
setPhonePassword( $phone_password) : bool
Parameters
Return values
bool —setPolicyGroup()
public
setPolicyGroup(string $value) : bool
Parameters
- $value : string
-
UUID
Return values
bool —setPostalCode()
public
setPostalCode( $value) : bool
Parameters
Return values
bool —setProgressBarObject()
public
setProgressBarObject(object $obj) : bool
Parameters
- $obj : object
Return values
bool —setProvince()
public
setProvince( $value) : bool
Parameters
Return values
bool —setQueryStatementTimeout()
public
setQueryStatementTimeout([null $milliseconds = null ]) : bool
Parameters
- $milliseconds : null = null
Return values
bool —setRecurringSchedule()
public
setRecurringSchedule(array<string|int, mixed> $value) : mixed
Parameters
- $value : array<string|int, mixed>
Return values
mixed —setSecondLastName()
public
setSecondLastName( $value) : bool
Parameters
Return values
bool —setSex()
public
setSex( $value) : bool
Parameters
Return values
bool —setSIN()
public
setSIN( $value) : bool
Parameters
Return values
bool —setStatus()
public
setStatus( $value) : bool
Parameters
Return values
bool —setTag()
public
setTag( $value) : bool
Parameters
Return values
bool —setTerminatedPermissionControl()
public
setTerminatedPermissionControl(string $value) : bool
Parameters
- $value : string
-
UUID
Return values
bool —setTerminationDate()
public
setTerminationDate(int $value) : bool
Parameters
- $value : int
-
EPOCH
Return values
bool —setTitle()
public
setTitle(string $value) : bool
Parameters
- $value : string
-
UUID
Return values
bool —setTransactionMode()
public
setTransactionMode([string $mode = '' ]) : mixed
Parameters
- $mode : string = ''
Return values
mixed —setUpdatedBy()
public
setUpdatedBy([string $id = null ]) : bool|null
Parameters
- $id : string = null
-
UUID
Return values
bool|null —setUpdatedDate()
public
setUpdatedDate([int $epoch = null ]) : bool|int|null|string
Parameters
- $epoch : int = null
-
EPOCH
Return values
bool|int|null|string —setUserDefault()
public
setUserDefault(string $value) : mixed
Parameters
- $value : string
Return values
mixed —setUserName()
public
setUserName( $value) : bool
Parameters
Return values
bool —setWorkEmail()
public
setWorkEmail( $value) : bool
Parameters
Return values
bool —setWorkEmailIsValid()
public
setWorkEmailIsValid( $value) : bool
Parameters
Return values
bool —setWorkEmailIsValidDate()
public
setWorkEmailIsValidDate(int $value) : bool
Parameters
- $value : int
-
EPOCH
Return values
bool —setWorkEmailIsValidKey()
public
setWorkEmailIsValidKey( $value) : bool
Parameters
Return values
bool —setWorkPhone()
public
setWorkPhone( $value) : bool
Parameters
Return values
bool —setWorkPhoneExt()
public
setWorkPhoneExt( $value) : bool
Parameters
Return values
bool —StartSavePoint()
public
StartSavePoint( $name) : bool
Parameters
Return values
bool —StartTransaction()
public
StartTransaction() : mixed
Return values
mixed —toBool()
public
toBool(string|int|bool $value) : int
Parameters
- $value : string|int|bool
Return values
int —toJSONBool()
public
toJSONBool(string|int|bool $value) : string
Parameters
- $value : string|int|bool
Return values
string —UnsubscribeEmail()
public
static UnsubscribeEmail( $email) : bool
Parameters
Return values
bool —Validate()
public
Validate([bool $ignore_warning = true ]) : bool
Parameters
- $ignore_warning : bool = true
Return values
bool —validateCustomFields()
public
validateCustomFields(mixed $company_id[, mixed $enable_required_field_check = true ]) : mixed
Parameters
- $company_id : mixed
- $enable_required_field_check : mixed = true
Return values
mixed —_getFactoryOptions()
protected
_getFactoryOptions(string $name[, string|int $parent = null ]) : bool
Parameters
- $name : string
- $parent : string|int = null
Return values
bool —_getVariableToFunctionMap()
protected
_getVariableToFunctionMap(array<string|int, mixed> $data) : bool
Parameters
- $data : array<string|int, mixed>
Return values
bool —castInteger()
protected
castInteger(int|string $int[, string $type = 'int' ]) : bool|int|string
Parameters
- $int : int|string
- $type : string = 'int'
Return values
bool|int|string —getColumnsFromAliases()
protected
getColumnsFromAliases(array<string|int, mixed> $columns, array<string|int, mixed> $aliases) : array<string|int, mixed>
Parameters
- $columns : array<string|int, mixed>
- $aliases : array<string|int, mixed>
Return values
array<string|int, mixed> —getCustomFieldWhereSQL()
protected
getCustomFieldWhereSQL(mixed $company_id, mixed $column, array<string|int, mixed> $filter_data, array<string|int, mixed> &$ph) : string
Parameters
- $company_id : mixed
- $column : mixed
- $filter_data : array<string|int, mixed>
- $ph : array<string|int, mixed>
Return values
string —getDatabaseType()
protected
getDatabaseType() : string
Return values
string —getListSQL()
protected
getListSQL(array<string|int, mixed>|string|int $array[, array<string|int, mixed> &$ph = null ][, string|bool $cast = false ]) : bool|int|string|array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>|string|int
- $ph : array<string|int, mixed> = null
- $cast : string|bool = false
Return values
bool|int|string|array<string|int, mixed> —getSortSQL()
protected
getSortSQL(array<string|int, mixed> $array[, bool $strict = true ][, array<string|int, mixed> $additional_fields = null ]) : bool|string
Parameters
- $array : array<string|int, mixed>
- $strict : bool = true
- $additional_fields : array<string|int, mixed> = null
Return values
bool|string —getSQLStringAggregate()
protected
getSQLStringAggregate(string $sql, string $glue) : string
Parameters
- $sql : string
- $glue : string
Return values
string —getSQLToEpochFunction()
protected
getSQLToEpochFunction(string $sql) : string
Parameters
- $sql : string
Return values
string —getSQLToTimeFunction()
protected
getSQLToTimeFunction(string $sql) : string
Parameters
- $sql : string
Return values
string —getSQLToTimeStampFunction()
protected
getSQLToTimeStampFunction() : string
Return values
string —getWhereClauseSQL()
protected
getWhereClauseSQL(array<string|int, mixed>|string $columns, array<string|int, mixed>|string $args, string $type, array<string|int, mixed> &$ph[, string $query_stub = null ][, bool $and = true ]) : null|string
Parameters
- $columns : array<string|int, mixed>|string
- $args : array<string|int, mixed>|string
- $type : string
- $ph : array<string|int, mixed>
- $query_stub : string = null
- $and : bool = true
Tags
Return values
null|string —getWhereSQL()
protected
getWhereSQL(array<string|int, mixed> $array[, bool $append_where = false ]) : bool|string
Parameters
- $array : array<string|int, mixed>
- $append_where : bool = false
Return values
bool|string —handleSQLSyntax()
SQL where clause Syntax: or % as wildcard.
protected
handleSQLSyntax(string $arg) : string
"
Handles '*' and '%' as wildcards, defaults to wildcard on the end always. If no wildcard is to be added, the last character should be |
Parameters
- $arg : string
Return values
string —stripSQLSyntax()
protected
stripSQLSyntax(string $arg) : mixed
Parameters
- $arg : string
Return values
mixed —getInsertQuery()
private
getInsertQuery() : mixed
Return values
mixed —getRecordSetColumnList()
private
getRecordSetColumnList(object $rs) : array<string|int, mixed>|bool
Parameters
- $rs : object
Return values
array<string|int, mixed>|bool —getUpdateQuery()
private
getUpdateQuery() : bool
Tags
Return values
bool —parseColumnName()
Parses out the exact column name, without any aliases, or = signs in it.
private
parseColumnName(string $column) : bool|string
Parameters
- $column : string