• Class name: UserListFactory
• Namespace:
• Parent class: UserFactory
• This class implements: IteratorAggregate

protected mixed $table = 'users'

• Visibility: protected

protected mixed $pk_sequence_name = 'users_id_seq'

• Visibility: protected

protected mixed $user_preference_obj = NULL

• Visibility: protected

protected mixed $user_tax_obj = NULL

• Visibility: protected

protected mixed $legal_entity_obj = NULL

• Visibility: protected

protected mixed $company_obj = NULL

• Visibility: protected

protected mixed $title_obj = NULL

• Visibility: protected

protected mixed $branch_obj = NULL

• Visibility: protected

protected mixed $department_obj = NULL

• Visibility: protected

protected mixed $group_obj = NULL

• Visibility: protected

protected mixed $currency_obj = NULL

• Visibility: protected

public mixed $username_validator_regex = '/^[a-z0-9-_\.@\+]{1,250}$/i'

• Visibility: public

public mixed $phoneid_validator_regex = '/^[0-9]{1,250}$/i'

• Visibility: public

protected mixed $phonepassword_validator_regex = '/^[0-9]{1,250}$/i'

• Visibility: protected

protected mixed $name_validator_regex = '/^[a-zA-Z- \.\'()\[\]|\x{0080}-\x{FFFF}]{1,250}$/iu'

• Visibility: protected

protected mixed $address_validator_regex = '/^[a-zA-Z0-9-,_\/\.\'#\ |\x{0080}-\x{FFFF}]{1,250}$/iu'

• Visibility: protected

protected mixed $city_validator_regex = '/^[a-zA-Z0-9-,_\.\'#\ |\x{0080}-\x{FFFF}]{1,250}$/iu'

• Visibility: protected

public mixed $data = array()

• Visibility: public

public mixed $old_data = array()

• Visibility: public

public mixed $tmp_data = array()

• Visibility: public

protected mixed $enable_system_log_detail = TRUE

• Visibility: protected

protected mixed $progress_bar_obj = NULL

• Visibility: protected

protected mixed $AMF_message_id = NULL

• Visibility: protected

public mixed $Validator = NULL

• Visibility: public

public mixed $validate_only = FALSE

• Visibility: public

private mixed $is_valid = FALSE

• Visibility: private

\UserListFactory UserListFactory::getAll(integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

\UserListFactory UserListFactory::getByStatus($status, array $where, array $order)

• Visibility: public

• $status mixed
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean UserListFactory::getUniqueCountryByCompanyId(string $id, array $where, array $order)

• Visibility: public

• $id string - UUID
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

\UserListFactory UserListFactory::getByCompanyIdAndStatus(string $company_id, $status, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $status mixed
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean UserListFactory::getFullNameById(string $id)

• Visibility: public
• This method is static.

• $id string - UUID

boolean|\UserListFactory UserListFactory::getById(string $id)

• Visibility: public

• $id string - UUID

boolean|\UserListFactory UserListFactory::getByIdAndCompanyId(string $id, string $company_id, integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $id string - UUID
• $company_id string - UUID
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\UserListFactory UserListFactory::getByLegalEntityIdAndCompanyId(string $id, string $company_id, integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $id string - UUID
• $company_id string - UUID
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean UserListFactory::getCompanyValidUserIds(string $id, string $company_id)

• Visibility: public

• $id string - UUID
• $company_id string - UUID

boolean|\UserListFactory UserListFactory::getByUserName($user_name, array $where, array $order)

• Visibility: public

• $user_name mixed
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\UserListFactory UserListFactory::getByHomeEmailOrWorkEmail($email)

• Visibility: public

• $email mixed

boolean|\UserListFactory UserListFactory::getByEmailIsValidKey($key)

• Visibility: public

• $key mixed

boolean|\UserListFactory UserListFactory::getByPasswordResetKey($key)

• Visibility: public

• $key mixed

boolean|\UserListFactory UserListFactory::getByUserNameAndCompanyId($user_name, string $company_id, array $where, array $order)

• Visibility: public

• $user_name mixed
• $company_id string - UUID
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\UserListFactory UserListFactory::getByUserNameAndStatus($user_name, $status, array $where, array $order)

• Visibility: public

• $user_name mixed
• $status mixed
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\UserListFactory UserListFactory::getByPhoneIdAndStatus(string $phone_id, $status, array $where, array $order)

• Visibility: public

• $phone_id string - UUID
• $status mixed
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\UserListFactory UserListFactory::getByIdAndStatus(string $id, $status, array $where, array $order)

• Visibility: public

• $id string - UUID
• $status mixed
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\UserListFactory UserListFactory::getByCurrencyID(string $id, array $where, array $order)

• Visibility: public

• $id string - UUID
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\UserListFactory UserListFactory::getByCompanyIDAndPermissionLevel(string $company_id, $level, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $level mixed
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\UserListFactory UserListFactory::getByCompanyIDAndGroupID(string $company_id, string $id, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $id string - UUID
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\UserListFactory UserListFactory::getByCompanyIDAndEmployeeNumber(string $company_id, $employee_number, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $employee_number mixed
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\UserListFactory UserListFactory::getByCompanyIDAndStationIDAndStatusAndDate(string $company_id, string $station_id, integer $status_id, integer $date, integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $station_id string - UUID
• $status_id integer
• $date integer - EPOCH
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\UserListFactory UserListFactory::getByCompanyIDAndStationIDAndStatusAndDateAndValidUserIDs(string $company_id, string $station_id, integer $status_id, integer $date, array $valid_user_ids, integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $station_id string - UUID
• $status_id integer
• $date integer - EPOCH
• $valid_user_ids array
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\UserListFactory UserListFactory::getByCompanyIDAndStationIDAndStatusAndEmployeeNumber(string $company_id, string $station_id, integer $status_id, $employee_number, integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $station_id string - UUID
• $status_id integer
• $employee_number mixed
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\UserListFactory UserListFactory::getByCompanyId(string $company_id, integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\UserListFactory UserListFactory::getByCompanyIdAndLongitudeAndLatitude(string $company_id, $longitude, $latitude, integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $longitude mixed
• $latitude mixed
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean UserListFactory::getByCompanyIdArray(string $company_id, boolean $include_blank, boolean $include_disabled, boolean $last_name_first)

• Visibility: public
• This method is static.

• $company_id string - UUID
• $include_blank boolean
• $include_disabled boolean
• $last_name_first boolean

boolean UserListFactory::getArrayByListFactory($lf, boolean $include_blank, boolean $include_disabled)

• Visibility: public
• This method is static.

• $lf mixed
• $include_blank boolean
• $include_disabled boolean

boolean|\UserListFactory UserListFactory::getDeletedByCompanyIdAndDate(string $company_id, integer $date, integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $date integer - EPOCH
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean UserListFactory::getIsModifiedByCompanyIdAndDate(string $company_id, integer $date, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $date integer - EPOCH
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\UserListFactory UserListFactory::getHighestEmployeeNumberByCompanyId(string $id, array $where, array $order)

• Visibility: public

• $id string - UUID
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\UserListFactory UserListFactory::getReportByCompanyIdAndUserIDList(string $company_id, string $user_ids, array $order)

• Visibility: public

• $company_id string - UUID
• $user_ids string - UUID
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

\UserListFactory UserListFactory::getAPIEmailAddressDataByArrayCriteria(null $filter_data, integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $filter_data null
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|object UserListFactory::getAPISearchByCompanyIdAndArrayCriteria(integer $company_id, array $filter_data, integer $limit, integer $page, array $where, array $order, boolean $include_last_punch_time)

Return user records based on advanced filter criteria.

• Visibility: public

• $company_id integer - Company ID
• $filter_data array - Filter 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
• $limit integer - Optional. Restrict the number of records returned
• $page integer - Optional. Specify the page of records to return
• $where array - Optional. Additional WHERE clauses in array( 'column' => 'value', 'column' => 'value' ) format.
• $order array - Optional. Sort order in array( 'column' => ASC, 'column2' => DESC ) format.
• $include_last_punch_time boolean

boolean Factory::_getFactoryOptions(string $name, string|integer $parent)

• Visibility: protected
• This method is defined by Factory

• $name string
• $parent string|integer

boolean Factory::_getVariableToFunctionMap(array $data)

• Visibility: protected
• This method is defined by Factory

• $data array

boolean|null|object UserFactory::getUserPreferenceObject()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::getCompanyObject()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::getLegalEntityObject()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::getTitleObject()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::getDefaultBranchObject()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::getDefaultDepartmentObject()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::getGroupObject()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::getCurrencyObject()

• Visibility: public
• This method is defined by UserFactory

boolean|integer|string UserFactory::getCompany()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setCompany(string $value)

• Visibility: public
• This method is defined by UserFactory

• $value string - UUID

boolean|mixed UserFactory::getLegalEntity()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setLegalEntity(string $value)

• Visibility: public
• This method is defined by UserFactory

• $value string - UUID

boolean|integer UserFactory::getStatus()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setStatus($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getGroup()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setGroup(string $value)

• Visibility: public
• This method is defined by UserFactory

• $value string - UUID

boolean|integer UserFactory::getPermissionLevel()

• Visibility: public
• This method is defined by UserFactory

boolean|integer UserFactory::getCurrentUserPermissionLevel()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::getPermissionControl($force)

• Visibility: public
• This method is defined by UserFactory

• $force mixed

boolean UserFactory::setPermissionControl(string $value)

• Visibility: public
• This method is defined by UserFactory

• $value string - UUID

boolean UserFactory::getPayPeriodSchedule()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setPayPeriodSchedule(string $value)

• Visibility: public
• This method is defined by UserFactory

• $value string - UUID

boolean UserFactory::getPolicyGroup()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setPolicyGroup(string $value)

• Visibility: public
• This method is defined by UserFactory

• $value string - UUID

boolean|string UserFactory::getHierarchyLevelDisplay()

• Visibility: public
• This method is defined by UserFactory

boolean|string UserFactory::getHierarchyControlDisplay()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::getHierarchyControl()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setHierarchyControl($data)

• Visibility: public
• This method is defined by UserFactory

• $data mixed

boolean UserFactory::getFeedbackRating()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setFeedbackRating($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

array|boolean UserFactory::getPromptForFeedback()

Determines if the user should be prompted for feedback.

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::isUniqueUserName($user_name)

• Visibility: public
• This method is defined by UserFactory

• $user_name mixed

boolean|mixed UserFactory::getUserName()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setUserName($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean UserFactory::checkPassword($password, boolean $check_password_policy)

• Visibility: public
• This method is defined by UserFactory

• $password mixed
• $check_password_policy boolean

boolean|mixed UserFactory::getPassword()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setPassword($password, null $password_confirm, boolean $force)

• Visibility: public
• This method is defined by UserFactory

• $password mixed
• $password_confirm null
• $force boolean

boolean UserFactory::isPasswordPolicyEnabled()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::isFirstLogin()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::isCompromisedPassword()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::checkPasswordAge()

• Visibility: public
• This method is defined by UserFactory

boolean|mixed UserFactory::getPasswordUpdatedDate()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setPasswordUpdatedDate(integer $value)

• Visibility: public
• This method is defined by UserFactory

• $value integer - EPOCH

boolean UserFactory::isUniquePhoneId(string $phone_id)

• Visibility: public
• This method is defined by UserFactory

• $phone_id string - UUID

boolean|string UserFactory::getPhoneId()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setPhoneId(string $value)

• Visibility: public
• This method is defined by UserFactory

• $value string - UUID

boolean UserFactory::checkPhonePassword($password)

• Visibility: public
• This method is defined by UserFactory

• $password mixed

boolean|mixed UserFactory::getPhonePassword()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setPhonePassword($phone_password, boolean $force)

• Visibility: public
• This method is defined by UserFactory

• $phone_password mixed
• $force boolean

integer|null UserFactory::getNextAvailableEmployeeNumber(string $company_id)

• Visibility: public
• This method is defined by UserFactory

• $company_id string - UUID

boolean UserFactory::isUniqueEmployeeNumber(string $id)

• Visibility: public
• This method is defined by UserFactory

• $id string - UUID

boolean UserFactory::checkEmployeeNumber(string $id)

• Visibility: public
• This method is defined by UserFactory

• $id string - UUID

boolean|integer UserFactory::getEmployeeNumber()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setEmployeeNumber($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getTitle()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setTitle(string $value)

• Visibility: public
• This method is defined by UserFactory

• $value string - UUID

boolean UserFactory::getEthnicGroup()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setEthnicGroup(string $value)

• Visibility: public
• This method is defined by UserFactory

• $value string - UUID

boolean|mixed UserFactory::getDefaultJob()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setDefaultJob(string $value)

• Visibility: public
• This method is defined by UserFactory

• $value string - UUID

boolean|mixed UserFactory::getDefaultJobItem()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setDefaultJobItem(string $value)

• Visibility: public
• This method is defined by UserFactory

• $value string - UUID

boolean|mixed UserFactory::getDefaultBranch()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setDefaultBranch(string $value)

• Visibility: public
• This method is defined by UserFactory

• $value string - UUID

boolean|mixed UserFactory::getDefaultDepartment()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setDefaultDepartment(string $value)

• Visibility: public
• This method is defined by UserFactory

• $value string - UUID

boolean|string UserFactory::getFullName(boolean $reverse, boolean $include_middle)

• Visibility: public
• This method is defined by UserFactory

• $reverse boolean
• $include_middle boolean

boolean|mixed UserFactory::getFirstName()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setFirstName($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getFirstNameMetaphone()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setFirstNameMetaphone($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean UserFactory::getMiddleInitial()

• Visibility: public
• This method is defined by UserFactory

boolean|mixed UserFactory::getMiddleName()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setMiddleName($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getLastName()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setLastName($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getLastNameMetaphone()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setLastNameMetaphone($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getSecondLastName()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setSecondLastName($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|integer UserFactory::getSex()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setSex($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean UserFactory::getAddress1()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setAddress1($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean UserFactory::getAddress2()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setAddress2($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getCity()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setCity($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getCountry()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setCountry($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getProvince()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setProvince($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getPostalCode()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setPostalCode($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|float UserFactory::getLongitude()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setLongitude($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|float UserFactory::getLatitude()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setLatitude($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getWorkPhone()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setWorkPhone($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getWorkPhoneExt()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setWorkPhoneExt($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getHomePhone()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setHomePhone($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getMobilePhone()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setMobilePhone($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getFaxPhone()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setFaxPhone($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean UserFactory::isUniqueHomeEmail($email)

• Visibility: public
• This method is defined by UserFactory

• $email mixed

boolean|mixed UserFactory::getHomeEmail()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setHomeEmail($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean UserFactory::getHomeEmailIsValid()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setHomeEmailIsValid($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getHomeEmailIsValidKey()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setHomeEmailIsValidKey($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

mixed UserFactory::getHomeEmailIsValidDate()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setHomeEmailIsValidDate(integer $value)

• Visibility: public
• This method is defined by UserFactory

• $value integer - EPOCH

boolean UserFactory::isUniqueWorkEmail($email)

• Visibility: public
• This method is defined by UserFactory

• $email mixed

boolean|mixed UserFactory::getWorkEmail()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setWorkEmail($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean UserFactory::getWorkEmailIsValid()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setWorkEmailIsValid($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getWorkEmailIsValidKey()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setWorkEmailIsValidKey($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

mixed UserFactory::getWorkEmailIsValidDate()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setWorkEmailIsValidDate(integer $value)

• Visibility: public
• This method is defined by UserFactory

• $value integer - EPOCH

float UserFactory::getAge()

• Visibility: public
• This method is defined by UserFactory

boolean|mixed UserFactory::getBirthDate($raw)

• Visibility: public
• This method is defined by UserFactory

• $raw mixed

boolean UserFactory::setBirthDate(integer $value)

• Visibility: public
• This method is defined by UserFactory

• $value integer - EPOCH

boolean UserFactory::isValidWageForHireDate(integer $epoch)

• Visibility: public
• This method is defined by UserFactory

• $epoch integer - EPOCH

boolean|mixed UserFactory::getHireDate($raw)

• Visibility: public
• This method is defined by UserFactory

• $raw mixed

boolean UserFactory::setHireDate($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getTerminationDate($raw)

• Visibility: public
• This method is defined by UserFactory

• $raw mixed

boolean UserFactory::setTerminationDate(integer $value)

• Visibility: public
• This method is defined by UserFactory

• $value integer - EPOCH

boolean|mixed UserFactory::getLastLoginDate()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setLastLoginDate(integer $value)

• Visibility: public
• This method is defined by UserFactory

• $value integer - EPOCH

boolean|mixed UserFactory::getCurrency()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setCurrency(string $value)

• Visibility: public
• This method is defined by UserFactory

• $value string - UUID

boolean|string UserFactory::getSecureSIN(null $sin)

• Visibility: public
• This method is defined by UserFactory

• $sin null

boolean|mixed UserFactory::getSIN()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setSIN($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

mixed UserFactory::isUniqueSIN($sin)

• Visibility: public
• This method is defined by UserFactory

• $sin mixed

boolean UserFactory::getOtherID1()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setOtherID1($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean UserFactory::getOtherID2()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setOtherID2($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean UserFactory::getOtherID3()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setOtherID3($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean UserFactory::getOtherID4()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setOtherID4($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean UserFactory::getOtherID5()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setOtherID5($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean|mixed UserFactory::getNote()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setNote($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean UserFactory::sendValidateEmail(string $type)

• Visibility: public
• This method is defined by UserFactory

• $type string

string UserFactory::encryptPasswordResetKey($key)

• Visibility: public
• This method is defined by UserFactory

• $key mixed

boolean UserFactory::checkPasswordResetKey($key)

• Visibility: public
• This method is defined by UserFactory

• $key mixed

boolean UserFactory::sendPasswordResetEmail()

• Visibility: public
• This method is defined by UserFactory

boolean|mixed UserFactory::getPasswordResetKey()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setPasswordResetKey($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

mixed UserFactory::getPasswordResetDate()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setPasswordResetDate(integer $value)

• Visibility: public
• This method is defined by UserFactory

• $value integer - EPOCH

boolean UserFactory::setEnableClearPasswordResetData(boolean $value)

• Visibility: public
• This method is defined by UserFactory

• $value boolean

boolean UserFactory::getEnableClearPasswordResetData()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::isPhotoExists()

• Visibility: public
• This method is defined by UserFactory

boolean|string UserFactory::getPhotoFileName(string $company_id, string $user_id, boolean $include_default_photo)

• Visibility: public
• This method is defined by UserFactory

• $company_id string - UUID
• $user_id string - UUID
• $include_default_photo boolean

boolean UserFactory::cleanStoragePath(string $company_id, string $user_id)

• Visibility: public
• This method is defined by UserFactory

• $company_id string - UUID
• $user_id string - UUID

boolean|string UserFactory::getStoragePath(string $company_id, string $user_id)

• Visibility: public
• This method is defined by UserFactory

• $company_id string - UUID
• $user_id string - UUID

boolean|string UserFactory::getTag()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setTag($value)

• Visibility: public
• This method is defined by UserFactory

• $value mixed

boolean UserFactory::UnsubscribeEmail($email)

• Visibility: public
• This method is static.
• This method is defined by UserFactory

• $email mixed

boolean UserFactory::Validate(boolean $ignore_warning)

• Visibility: public
• This method is defined by UserFactory

• $ignore_warning boolean

boolean UserFactory::preSave()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::postSave()

• Visibility: public
• This method is defined by UserFactory

boolean|string UserFactory::getMapURL()

• Visibility: public
• This method is defined by UserFactory

boolean UserFactory::setObjectFromArray($data)

• Visibility: public
• This method is defined by UserFactory

• $data mixed

array UserFactory::getObjectAsArray(null $include_columns, boolean $permission_children_ids)

• Visibility: public
• This method is defined by UserFactory

• $include_columns null
• $permission_children_ids boolean

boolean UserFactory::addLog($log_action)

• Visibility: public
• This method is defined by UserFactory

• $log_action mixed

mixed Factory::__construct()

Factory constructor.

• Visibility: public
• This method is defined by Factory

boolean|null Factory::getAMFMessageID()

Used for updating progress bar for API calls.

• Visibility: public
• This method is defined by Factory

boolean Factory::setAMFMessageID(string $id)

• Visibility: public
• This method is defined by Factory

• $id string - UUID

boolean Factory::setProgressBarObject(object $obj)

• Visibility: public
• This method is defined by Factory

• $obj object

null|\ProgressBar Factory::getProgressBarObject()

• Visibility: public
• This method is defined by Factory

boolean Factory::setGenericObject(object $obj, string $variable)

• Visibility: public
• This method is defined by Factory

• $obj object
• $variable string

boolean Factory::getGenericObject(string $list_factory, string|integer $id, string $variable, string $list_factory_method, string $id_method)

Generic function to return and cache class objects ListFactory, ListFactoryMethod, Variable, ID, IDMethod

• Visibility: public
• This method is defined by Factory

• $list_factory string
• $id string|integer - UUID
• $variable string
• $list_factory_method string
• $id_method string

mixed Factory::getCompanyGenericMapData(string $company_id, integer $object_type_id, string $id, string $variable)

• Visibility: public
• This method is defined by Factory

• $company_id string - UUID
• $object_type_id integer
• $id string - UUID
• $variable string

boolean|mixed Factory::getGenericDataValue(string $name, $cast)

• Visibility: public
• This method is defined by Factory

• $name string
• $cast mixed

boolean Factory::setGenericDataValue(string $name, mixed $data, $cast)

• Visibility: public
• This method is defined by Factory

• $name string
• $data mixed
• $cast mixed

mixed Factory::castGenericDataValue($value, $cast)

Generic casting function that all set/get*() functions should pass through.

However for now lets wait until we have meta data from SQL schema so we can pass those datatypes directly into this.

• Visibility: public
• This method is defined by Factory

• $value mixed - mixed
• $cast mixed - string

boolean Factory::getGenericTempDataValue(string $name)

• Visibility: public
• This method is defined by Factory

• $name string

boolean Factory::setGenericTempDataValue(string $name, mixed $data)

• Visibility: public
• This method is defined by Factory

• $name string
• $data mixed

boolean|mixed Factory::getGenericOldDataValue(string $name)

• Visibility: public
• This method is defined by Factory

• $name string - Gets data value from old_data array, or the original value in the database, prior to any changes currently in memory.

boolean|mixed Factory::getCache(string $cache_id, string $group_id)

• Visibility: public
• This method is defined by Factory

• $cache_id string
• $group_id string

boolean Factory::saveCache(mixed $data, string $cache_id, string $group_id)

• Visibility: public
• This method is defined by Factory

• $data mixed
• $cache_id string
• $group_id string

boolean Factory::removeCache(string $cache_id, string $group_id)

• Visibility: public
• This method is defined by Factory

• $cache_id string
• $group_id string

boolean Factory::setCacheLifeTime(integer $secs)

• Visibility: public
• This method is defined by Factory

• $secs integer

string Factory::serializeRS(object $rs)

• Visibility: public
• This method is defined by Factory

• $rs object

mixed Factory::unserializeRS(string $rs)

• Visibility: public
• This method is defined by Factory

• $rs string

boolean|string Factory::getTable(boolean $strip_quotes)

• Visibility: public
• This method is defined by Factory

• $strip_quotes boolean

boolean|mixed Factory::getColumn(string $column)

• Visibility: public
• This method is defined by Factory

• $column string

boolean|string Factory::__toString()

• Visibility: public
• This method is defined by Factory

integer Factory::toBool(string|integer|boolean $value)

• Visibility: public
• This method is defined by Factory

• $value string|integer|boolean

boolean Factory::fromBool(string|integer|boolean $value)

• Visibility: public
• This method is defined by Factory

• $value string|integer|boolean

boolean Factory::isNew(boolean $force_lookup, string $id)

Determines if the data is new data, or updated data. Basically determines if a database INSERT or UPDATE SQL statement is generated.

• Visibility: public
• This method is defined by Factory

• $force_lookup boolean
• $id string - UUID

boolean|mixed|string Factory::getLabelId()

• Visibility: public
• This method is defined by Factory

boolean|mixed Factory::getId()

• Visibility: public
• This method is defined by Factory

boolean Factory::setId(string $id)

• Visibility: public
• This method is defined by Factory

• $id string - UUID

boolean Factory::getEnableSystemLogDetail()

• Visibility: public
• This method is defined by Factory

boolean Factory::setEnableSystemLogDetail($bool)

• Visibility: public
• This method is defined by Factory

• $bool mixed

boolean Factory::getDeleted()

• Visibility: public
• This method is defined by Factory

boolean Factory::setDeleted(boolean $bool)

• Visibility: public
• This method is defined by Factory

• $bool boolean

integer Factory::getCreatedDate()

• Visibility: public
• This method is defined by Factory

boolean Factory::setCreatedDate(integer $epoch)

• Visibility: public
• This method is defined by Factory

• $epoch integer - EPOCH

boolean|mixed Factory::getCreatedBy()

• Visibility: public
• This method is defined by Factory

boolean Factory::setCreatedBy(string $id)

• Visibility: public
• This method is defined by Factory

• $id string - UUID

integer Factory::getUpdatedDate()

• Visibility: public
• This method is defined by Factory

boolean|integer|null|string Factory::setUpdatedDate(integer $epoch)

• Visibility: public
• This method is defined by Factory

• $epoch integer - EPOCH

boolean|mixed Factory::getUpdatedBy()

• Visibility: public
• This method is defined by Factory

boolean|null Factory::setUpdatedBy(string $id)

• Visibility: public
• This method is defined by Factory

• $id string - UUID

boolean|mixed Factory::getDeletedDate()

• Visibility: public
• This method is defined by Factory

boolean Factory::setDeletedDate(integer $epoch)

• Visibility: public
• This method is defined by Factory

• $epoch integer - EPOCH

boolean|mixed Factory::getDeletedBy()

• Visibility: public
• This method is defined by Factory

boolean|null Factory::setDeletedBy(string $id)

• Visibility: public
• This method is defined by Factory

• $id string - UUID

boolean Factory::setIsValid(boolean $is_valid)

Sets the is_valid flag, mostly used to set it to FALSE to force a full re-validation.

Required because $this->is_valid is a private variable and should stay that way.

• Visibility: public
• This method is defined by Factory

• $is_valid boolean

boolean Factory::setCreatedAndUpdatedColumns(array $data, array $variable_to_function_map)

• Visibility: public
• This method is defined by Factory

• $data array
• $variable_to_function_map array

boolean Factory::getCreatedAndUpdatedColumns(array $data, null $include_columns)

• Visibility: public
• This method is defined by Factory

• $data array
• $include_columns null

boolean Factory::getPermissionColumns(array $data, string $object_user_id, string $created_by_id, string $permission_children_ids, array $include_columns)

• Visibility: public
• This method is defined by Factory

• $data array
• $object_user_id string - UUID
• $created_by_id string - UUID
• $permission_children_ids string - UUID
• $include_columns array

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

• Visibility: public
• This method is defined by Factory

• $name string
• $parent string|integer

array|boolean Factory::getVariableToFunctionMap(array $data)

• Visibility: public
• This method is defined by Factory

• $data array

integer|boolean Factory::getRecordCount()

• Visibility: public
• This method is defined by Factory

integer|boolean Factory::getCurrentRow(integer $offset)

• Visibility: public
• This method is defined by Factory

• $offset integer

boolean Factory::setQueryStatementTimeout(null $milliseconds)

• Visibility: public
• This method is defined by Factory

• $milliseconds null

array|boolean Factory::getRecordSetColumnList(object $rs)

• Visibility: private
• This method is defined by Factory

• $rs object

boolean|integer|string Factory::castInteger(integer|string $int, string $type)

• Visibility: protected
• This method is defined by Factory

• $int integer|string
• $type string

boolean|integer|string|array Factory::getListSQL(array|string|integer $array, array $ph, string|boolean $cast)

• Visibility: protected
• This method is defined by Factory

• $array array|string|integer
• $ph array
• $cast string|boolean

boolean|string Factory::getDateRangeSQL(string $str, string $column, string $format, boolean $include_blank_dates)

• Visibility: public
• This method is defined by Factory

• $str string
• $column string
• $format string
• $include_blank_dates boolean

string Factory::handleSQLSyntax(string $arg)

SQL where clause Syntax: or % as wildcard.

"" as exact match, no default wildcard and no metaphone

Handles '*' and '%' as wildcards, defaults to wildcard on the end always. If no wildcard is to be added, the last character should be |

• Visibility: protected
• This method is defined by Factory

• $arg string

mixed Factory::stripSQLSyntax(string $arg)

• Visibility: protected
• This method is defined by Factory

• $arg string

string Factory::getSQLToTimeStampFunction()

• Visibility: protected
• This method is defined by Factory

string Factory::getDatabaseType()

• Visibility: protected
• This method is defined by Factory

string Factory::getGEOMAsTextFunction(string $sql)

• Visibility: protected
• This method is defined by Factory

• $sql string

string Factory::getSQLToEpochFunction(string $sql)

• Visibility: protected
• This method is defined by Factory

• $sql string

string Factory::getSQLToTimeFunction(string $sql)

• Visibility: protected
• This method is defined by Factory

• $sql string

string Factory::getSQLStringAggregate(string $sql, string $glue)

• Visibility: protected
• This method is defined by Factory

• $sql string
• $glue string

null|string Factory::getWhereClauseSQL(array|string $columns, array|string $args, string $type, array $ph, string $query_stub, boolean $and)

• Visibility: protected
• This method is defined by Factory

• $columns array|string
• $args array|string
• $type string
• $ph array
• $query_stub string
• $and boolean

boolean|string Factory::parseColumnName(string $column)

• Visibility: private
• This method is defined by Factory

• $column string

boolean|string Factory::getWhereSQL(array $array, boolean $append_where)

• Visibility: protected
• This method is defined by Factory

• $array array
• $append_where boolean

array Factory::getColumnsFromAliases(array $columns, array $aliases)

• Visibility: protected
• This method is defined by Factory

• $columns array
• $aliases array

array Factory::convertFlexArray(array $array)

• Visibility: public
• This method is defined by Factory

• $array array

array Factory::getValidSQLColumns(array $array, boolean $strict, array $additional_fields)

• Visibility: public
• This method is defined by Factory

• $array array
• $strict boolean
• $additional_fields array

boolean|string Factory::getSortSQL(array $array, boolean $strict, array $additional_fields)

• Visibility: protected
• This method is defined by Factory

• $array array
• $strict boolean
• $additional_fields array

array|boolean Factory::getColumnList()

• Visibility: public
• This method is defined by Factory

mixed Factory::getEmptyRecordSet(string $id)

• Visibility: public
• This method is defined by Factory

• $id string - UUID

boolean Factory::getUpdateQuery()

• Visibility: private
• This method is defined by Factory

mixed Factory::getInsertQuery()

• Visibility: private
• This method is defined by Factory

mixed Factory::StartTransaction()

• Visibility: public
• This method is defined by Factory

mixed Factory::FailTransaction()

• Visibility: public
• This method is defined by Factory

mixed Factory::CommitTransaction()

• Visibility: public
• This method is defined by Factory

mixed Factory::setTransactionMode(string $mode)

• Visibility: public
• This method is defined by Factory

• $mode string

string Factory::getTransactionMode()

• Visibility: public
• This method is defined by Factory

boolean Factory::isValid(boolean $ignore_warning)

• Visibility: public
• This method is defined by Factory

• $ignore_warning boolean

boolean Factory::isWarning()

• Visibility: public
• This method is defined by Factory

boolean Factory::getSequenceName()

• Visibility: public
• This method is defined by Factory

boolean|string Factory::getNextInsertId()

• Visibility: public
• This method is defined by Factory

boolean Factory::ExecuteSQL(string $query, array $ph, integer $limit, integer $page)

• Visibility: public
• This method is defined by Factory

• $query string
• $ph array
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination

boolean Factory::RetryExecuteSQL(string $query, array $ph, integer $retry_max_attempts, integer $sleep)

• Visibility: public
• This method is defined by Factory

• $query string
• $ph array
• $retry_max_attempts integer
• $sleep integer

array Factory::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.

• Visibility: public
• This method is defined by Factory

boolean Factory::isDataDifferent($key, $data_diff, null $type_id, null $new_data)

Used to check the differences between a single key in the $old_data vs. $data arrays.

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.

• Visibility: public
• This method is defined by Factory

• $key mixed - string
• $data_diff mixed - array
• $type_id null - string
• $new_data null - mixed

boolean|integer|string Factory::Save(boolean $reset_data, boolean $force_lookup)

• Visibility: public
• This method is defined by Factory

• $reset_data boolean
• $force_lookup boolean

boolean Factory::Delete()

• Visibility: public
• This method is defined by Factory

array|boolean Factory::getIDSByListFactory(object $lf)

• Visibility: public
• This method is defined by Factory

• $lf object

boolean Factory::bulkDelete(string|array $ids)

• Visibility: public
• This method is defined by Factory

• $ids string|array - UUID

boolean Factory::clearGeoCode(array $data_diff)

• Visibility: public
• This method is defined by Factory

• $data_diff array

array|null Factory::clearNonMappedData(array|null $data)

Removes array elements from $data that are not in the function map.

• Visibility: public
• This method is defined by Factory

• $data array|null

boolean Factory::clearData()

• Visibility: public
• This method is defined by Factory

boolean Factory::clearOldData()

• Visibility: public
• This method is defined by Factory

\FactoryListIterator Factory::getIterator()

• Visibility: public
• This method is defined by Factory

mixed Factory::getCurrent()

• Visibility: public
• This method is defined by Factory