package Modules\Users
inherited_from \Factory

 Methods

CommitTransaction()

CommitTransaction() 
Inherited

Delete()

Delete() 
Inherited

ExecuteSQL()

ExecuteSQL($query, $ph = NULL, $limit = NULL, $page = NULL
Inherited

Parameters

$query

$ph

$limit

$page

FailTransaction()

FailTransaction() 
Inherited

RetryExecuteSQL()

RetryExecuteSQL($query, $ph = NULL, $retry_max_attempts = 2, $sleep = 5
Inherited

Parameters

$query

$ph

$retry_max_attempts

$sleep

Save()

Save($reset_data = TRUE, $force_lookup = FALSE
Inherited

Parameters

$reset_data

$force_lookup

StartTransaction()

StartTransaction() 
Inherited

UnsubscribeEmail()

UnsubscribeEmail($email) 
Static

Parameters

$email

Validate()

Validate($ignore_warning = TRUE

Parameters

$ignore_warning

__construct()

__construct() 
Inherited

__toString()

__toString() 
Inherited

_getFactoryOptions()

_getFactoryOptions($name, $parent = NULL
inherited_from \Factory::_getFactoryOptions()

Parameters

$name

$parent

_getVariableToFunctionMap()

_getVariableToFunctionMap($data) 
inherited_from \Factory::_getVariableToFunctionMap()

Parameters

$data

addLog()

addLog($log_action) 

Parameters

$log_action

bulkDelete()

bulkDelete($ids) 
Inherited

Parameters

$ids

checkEmployeeNumber()

checkEmployeeNumber($id) 

Parameters

$id

checkPassword()

checkPassword($password, $check_password_policy = TRUE

Parameters

$password

$check_password_policy

checkPasswordAge()

checkPasswordAge() 

checkPasswordResetKey()

checkPasswordResetKey($key) 

Parameters

$key

checkPhonePassword()

checkPhonePassword($password) 

Parameters

$password

cleanStoragePath()

cleanStoragePath($company_id = NULL, $user_id = NULL

Parameters

$company_id

$user_id

clearData()

clearData() 
Inherited

clearGeoCode()

clearGeoCode($data_diff = NULL
Inherited

Parameters

$data_diff

convertFlexArray()

convertFlexArray($array) 
Inherited

Parameters

$array

encryptPassword()

encryptPassword($password, $version = 2

Parameters

$password

$version

encryptPasswordResetKey()

encryptPasswordResetKey($key) 

Parameters

$key

fromBool()

fromBool($value) 
Inherited

Parameters

$value

getAMFMessageID()

getAMFMessageID() 
Inherited

getAddress1()

getAddress1() 

getAddress2()

getAddress2() 

getAge()

getAge() 

getBirthDate()

getBirthDate() 

getCache()

getCache($cache_id, $group_id = NULL
Inherited

Parameters

$cache_id

$group_id

getCallerFunction()

getCallerFunction() 
Inherited

getCity()

getCity() 

getColumn()

getColumn($column) 
Inherited

Parameters

$column

getColumnList()

getColumnList() 
Inherited

getCompany()

getCompany() 

getCompanyGenericMapData()

getCompanyGenericMapData($company_id, $object_type_id, $id, $variable) 
Inherited

Parameters

$company_id

$object_type_id

$id

$variable

getCompanyObject()

getCompanyObject() 

getCountry()

getCountry() 

getCreatedAndUpdatedColumns()

getCreatedAndUpdatedColumns($data, $include_columns = NULL
Inherited

Parameters

$data

$include_columns

getCreatedBy()

getCreatedBy() 
Inherited

getCreatedDate()

getCreatedDate() 
Inherited

getCurrency()

getCurrency() 

getCurrencyObject()

getCurrencyObject() 

getCurrent()

getCurrent() 
Inherited

getCurrentRow()

getCurrentRow($offset = 1
Inherited

Parameters

$offset

getCurrentUserPermissionLevel()

getCurrentUserPermissionLevel() 

getDateRangeSQL()

getDateRangeSQL($str, $column, $format = 'epoch', $include_blank_dates = FALSE
Inherited

Parameters

$str

$column

$format

$include_blank_dates

getDefaultBranch()

getDefaultBranch() 

getDefaultBranchObject()

getDefaultBranchObject() 

getDefaultDepartment()

getDefaultDepartment() 

getDefaultDepartmentObject()

getDefaultDepartmentObject() 

getDefaultJob()

getDefaultJob() 

getDefaultJobItem()

getDefaultJobItem() 

getDeleted()

getDeleted() 
Inherited

getDeletedBy()

getDeletedBy() 
Inherited

getDeletedDate()

getDeletedDate() 
Inherited

getEmployeeNumber()

getEmployeeNumber() 

getEmptyRecordSet()

getEmptyRecordSet($id = NULL
Inherited

Parameters

$id

getEnableClearPasswordResetData()

getEnableClearPasswordResetData() 

getEnableSystemLogDetail()

getEnableSystemLogDetail() 
Inherited

getEthnicGroup()

getEthnicGroup() 

getFaxPhone()

getFaxPhone() 

getFeedbackRating()

getFeedbackRating() 

getFirstName()

getFirstName() 

getFirstNameMetaphone()

getFirstNameMetaphone() 

getFullName()

getFullName($reverse = FALSE, $include_middle = TRUE

Parameters

$reverse

$include_middle

getGenericObject()

getGenericObject($list_factory, $id, $variable, $list_factory_method = 'getById', $id_method = 'getID'
Inherited

Parameters

$list_factory

$id

$variable

$list_factory_method

$id_method

getGroup()

getGroup() 

getGroupObject()

getGroupObject() 

getHierarchyControl()

getHierarchyControl() 

getHierarchyControlDisplay()

getHierarchyControlDisplay() 

getHierarchyLevelDisplay()

getHierarchyLevelDisplay() 

getHireDate()

getHireDate() 

getHomeEmail()

getHomeEmail() 

getHomeEmailIsValid()

getHomeEmailIsValid() 

getHomeEmailIsValidDate()

getHomeEmailIsValidDate() 

getHomeEmailIsValidKey()

getHomeEmailIsValidKey() 

getHomePhone()

getHomePhone() 

getIDSByListFactory()

getIDSByListFactory($lf) 
Inherited

Parameters

$lf

getId()

getId() 
Inherited

getIterator()

getIterator() 
Inherited

getLabelId()

getLabelId() 
Inherited

getLastLoginDate()

getLastLoginDate() 

getLastName()

getLastName() 

getLastNameMetaphone()

getLastNameMetaphone() 

getLatitude()

getLatitude() 

getLongitude()

getLongitude() 

getMapURL()

getMapURL() 

getMiddleInitial()

getMiddleInitial() 

getMiddleName()

getMiddleName() 

getMobilePhone()

getMobilePhone() 

getNextAvailableEmployeeNumber()

getNextAvailableEmployeeNumber($company_id = NULL
Static

Parameters

$company_id

getNextInsertId()

getNextInsertId() 
Inherited

getNote()

getNote() 

getObjectAsArray()

getObjectAsArray($include_columns = NULL, $permission_children_ids = FALSE

Parameters

$include_columns

$permission_children_ids

getOptions()

getOptions($name, $parent = NULL
Inherited

Parameters

$name

$parent

getOtherID1()

getOtherID1() 

getOtherID2()

getOtherID2() 

getOtherID3()

getOtherID3() 

getOtherID4()

getOtherID4() 

getOtherID5()

getOtherID5() 

getPassword()

getPassword() 

getPasswordResetDate()

getPasswordResetDate() 

getPasswordResetKey()

getPasswordResetKey() 

getPasswordSalt()

getPasswordSalt() 

getPasswordUpdatedDate()

getPasswordUpdatedDate() 

getPasswordVersion()

getPasswordVersion($encrypted_password = FALSE

Parameters

$encrypted_password

getPayPeriodSchedule()

getPayPeriodSchedule() 

getPermissionColumns()

getPermissionColumns($data, $object_user_id, $created_by_id, $permission_children_ids = NULL, $include_columns = NULL
Inherited

Parameters

$data

$object_user_id

$created_by_id

$permission_children_ids

$include_columns

getPermissionControl()

getPermissionControl() 

getPermissionLevel()

getPermissionLevel() 

getPhoneId()

getPhoneId() 

getPhonePassword()

getPhonePassword() 

getPhotoFileName()

getPhotoFileName($company_id = NULL, $user_id = NULL, $include_default_photo = TRUE

Parameters

$company_id

$user_id

$include_default_photo

getPolicyGroup()

getPolicyGroup() 

getPostalCode()

getPostalCode() 

getProgressBarObject()

getProgressBarObject() 
Inherited

getProvince()

getProvince() 

getRecordCount()

getRecordCount() 
Inherited

getSIN()

getSIN() 

getSecondLastName()

getSecondLastName() 

getSecureSIN()

getSecureSIN($sin = NULL

Parameters

$sin

getSequenceName()

getSequenceName() 
Inherited

getSex()

getSex() 

getStatus()

getStatus() 

getStoragePath()

getStoragePath($company_id = NULL, $user_id = NULL

Parameters

$company_id

$user_id

getTable()

getTable($strip_quotes = FALSE
Inherited

Parameters

$strip_quotes

getTag()

getTag() 

getTerminationDate()

getTerminationDate() 

getTitle()

getTitle() 

getTitleObject()

getTitleObject() 

getTransactionMode()

getTransactionMode() 
Inherited

getUpdatedBy()

getUpdatedBy() 
Inherited

getUpdatedDate()

getUpdatedDate() 
Inherited

getUserName()

getUserName() 

getUserPreferenceObject()

getUserPreferenceObject() 

getValidSQLColumns()

getValidSQLColumns($array, $strict = TRUE, $additional_fields = NULL
Inherited

Parameters

$array

$strict

$additional_fields

getVariableToFunctionMap()

getVariableToFunctionMap($data = NULL
Inherited

Parameters

$data

getWorkEmail()

getWorkEmail() 

getWorkEmailIsValid()

getWorkEmailIsValid() 

getWorkEmailIsValidDate()

getWorkEmailIsValidDate() 

getWorkEmailIsValidKey()

getWorkEmailIsValidKey() 

getWorkPhone()

getWorkPhone() 

getWorkPhoneExt()

getWorkPhoneExt() 

isCompromisedPassword()

isCompromisedPassword() 

isFirstLogin()

isFirstLogin() 

isInformationComplete()

isInformationComplete() 

isNew()

isNew($force_lookup = FALSE
Inherited

Parameters

$force_lookup

isPasswordPolicyEnabled()

isPasswordPolicyEnabled() 

isPhotoExists()

isPhotoExists() 

isSave()

isSave() 
Inherited

isUniqueEmployeeNumber()

isUniqueEmployeeNumber($id) 

Parameters

$id

isUniqueHomeEmail()

isUniqueHomeEmail($email) 

Parameters

$email

isUniquePhoneId()

isUniquePhoneId($phone_id) 

Parameters

$phone_id

isUniqueUserName()

isUniqueUserName($user_name) 

Parameters

$user_name

isUniqueWorkEmail()

isUniqueWorkEmail($email) 

Parameters

$email

isValid()

isValid($ignore_warning = TRUE
Inherited

Parameters

$ignore_warning

isValidWageForHireDate()

isValidWageForHireDate($epoch) 

Parameters

$epoch

isWarning()

isWarning() 
Inherited

postSave()

postSave($data_diff = NULL

Parameters

$data_diff

preSave()

preSave() 

removeCache()

removeCache($cache_id = NULL, $group_id = NULL
Inherited

Parameters

$cache_id

$group_id

saveCache()

saveCache($data, $cache_id, $group_id = NULL
Inherited

Parameters

$data

$cache_id

$group_id

sendPasswordResetEmail()

sendPasswordResetEmail() 

sendValidateEmail()

sendValidateEmail($type = 'work'

Parameters

$type

serializeRS()

serializeRS($rs) 
Inherited

Parameters

$rs

setAMFMessageID()

setAMFMessageID($id) 
Inherited

Parameters

$id

setAddress1()

setAddress1($address1) 

Parameters

$address1

setAddress2()

setAddress2($address2) 

Parameters

$address2

setBirthDate()

setBirthDate($epoch) 

Parameters

$epoch

setCacheLifeTime()

setCacheLifeTime($secs) 
Inherited

Parameters

$secs

setCity()

setCity($city) 

Parameters

$city

setCompany()

setCompany($id) 

Parameters

$id

setCountry()

setCountry($country) 

Parameters

$country

setCreatedAndUpdatedColumns()

setCreatedAndUpdatedColumns($data, $variable_to_function_map = array()
Inherited

Parameters

$data

$variable_to_function_map

setCreatedBy()

setCreatedBy($id = NULL
Inherited

Parameters

$id

setCreatedDate()

setCreatedDate($epoch = NULL
Inherited

Parameters

$epoch

setCurrency()

setCurrency($id) 

Parameters

$id

setDefaultBranch()

setDefaultBranch($id) 

Parameters

$id

setDefaultDepartment()

setDefaultDepartment($id) 

Parameters

$id

setDefaultJob()

setDefaultJob($id) 

Parameters

$id

setDefaultJobItem()

setDefaultJobItem($id) 

Parameters

$id

setDeleted()

setDeleted($bool) 
Inherited

Parameters

$bool

setDeletedBy()

setDeletedBy($id = NULL
Inherited

Parameters

$id

setDeletedDate()

setDeletedDate($epoch = NULL
Inherited

Parameters

$epoch

setEmployeeNumber()

setEmployeeNumber($value) 

Parameters

$value

setEnableClearPasswordResetData()

setEnableClearPasswordResetData($value = TRUE

Parameters

$value

setEnableSystemLogDetail()

setEnableSystemLogDetail($bool) 
Inherited

Parameters

$bool

setEthnicGroup()

setEthnicGroup($id) 

Parameters

$id

setFaxPhone()

setFaxPhone($fax_phone) 

Parameters

$fax_phone

setFeedbackRating()

setFeedbackRating($rating) 

Parameters

$rating

setFirstName()

setFirstName($first_name) 

Parameters

$first_name

setFirstNameMetaphone()

setFirstNameMetaphone($first_name) 

Parameters

$first_name

setGenericObject()

setGenericObject($obj, $variable) 
Inherited

Parameters

$obj

$variable

setGroup()

setGroup($id) 

Parameters

$id

setHierarchyControl()

setHierarchyControl($data) 

Parameters

$data

setHireDate()

setHireDate($epoch) 

Parameters

$epoch

setHomeEmail()

setHomeEmail($home_email) 

Parameters

$home_email

setHomeEmailIsValid()

setHomeEmailIsValid($bool) 

Parameters

$bool

setHomeEmailIsValidDate()

setHomeEmailIsValidDate($epoch) 

Parameters

$epoch

setHomeEmailIsValidKey()

setHomeEmailIsValidKey($value) 

Parameters

$value

setHomePhone()

setHomePhone($home_phone) 

Parameters

$home_phone

setId()

setId($id) 
Inherited

Parameters

$id

setLastLoginDate()

setLastLoginDate($epoch) 

Parameters

$epoch

setLastName()

setLastName($last_name) 

Parameters

$last_name

setLastNameMetaphone()

setLastNameMetaphone($last_name) 

Parameters

$last_name

setLatitude()

setLatitude($value) 

Parameters

$value

setLongitude()

setLongitude($value) 

Parameters

$value

setMiddleName()

setMiddleName($middle_name) 

Parameters

$middle_name

setMobilePhone()

setMobilePhone($mobile_phone) 

Parameters

$mobile_phone

setNote()

setNote($value) 

Parameters

$value

setObjectFromArray()

setObjectFromArray($data) 

Parameters

$data

setOtherID1()

setOtherID1($value) 

Parameters

$value

setOtherID2()

setOtherID2($value) 

Parameters

$value

setOtherID3()

setOtherID3($value) 

Parameters

$value

setOtherID4()

setOtherID4($value) 

Parameters

$value

setOtherID5()

setOtherID5($value) 

Parameters

$value

setPassword()

setPassword($password, $password_confirm = NULL, $force = FALSE

Parameters

$password

$password_confirm

$force

setPasswordResetDate()

setPasswordResetDate($epoch) 

Parameters

$epoch

setPasswordResetKey()

setPasswordResetKey($value) 

Parameters

$value

setPasswordUpdatedDate()

setPasswordUpdatedDate($epoch) 

Parameters

$epoch

setPayPeriodSchedule()

setPayPeriodSchedule($id) 

Parameters

$id

setPermissionControl()

setPermissionControl($id) 

Parameters

$id

setPhoneId()

setPhoneId($phone_id) 

Parameters

$phone_id

setPhonePassword()

setPhonePassword($phone_password, $force = FALSE

Parameters

$phone_password

$force

setPolicyGroup()

setPolicyGroup($id) 

Parameters

$id

setPostalCode()

setPostalCode($postal_code) 

Parameters

$postal_code

setProgressBarObject()

setProgressBarObject($obj) 
Inherited

Parameters

$obj

setProvince()

setProvince($province) 

Parameters

$province

setQueryStatementTimeout()

setQueryStatementTimeout($milliseconds = NULL
Inherited

Parameters

$milliseconds

setSIN()

setSIN($sin) 

Parameters

$sin

setSecondLastName()

setSecondLastName($second_last_name) 

Parameters

$second_last_name

setSex()

setSex($sex) 

Parameters

$sex

setStatus()

setStatus($status) 

Parameters

$status

setTag()

setTag($tags) 

Parameters

$tags

setTerminationDate()

setTerminationDate($epoch) 

Parameters

$epoch

setTitle()

setTitle($id) 

Parameters

$id

setTransactionMode()

setTransactionMode($mode = ''
Inherited

Parameters

$mode

setUpdatedBy()

setUpdatedBy($id = NULL
Inherited

Parameters

$id

setUpdatedDate()

setUpdatedDate($epoch = NULL
Inherited

Parameters

$epoch

setUserName()

setUserName($user_name) 

Parameters

$user_name

setWorkEmail()

setWorkEmail($work_email) 

Parameters

$work_email

setWorkEmailIsValid()

setWorkEmailIsValid($bool) 

Parameters

$bool

setWorkEmailIsValidDate()

setWorkEmailIsValidDate($epoch) 

Parameters

$epoch

setWorkEmailIsValidKey()

setWorkEmailIsValidKey($value) 

Parameters

$value

setWorkPhone()

setWorkPhone($work_phone) 

Parameters

$work_phone

setWorkPhoneExt()

setWorkPhoneExt($work_phone_ext) 

Parameters

$work_phone_ext

toBool()

toBool($value) 
Inherited

Parameters

$value

unserializeRS()

unserializeRS($rs) 
Inherited

Parameters

$rs

_getFactoryOptions()

_getFactoryOptions($name, $parent = NULL
Inherited

Parameters

$name

$parent

_getVariableToFunctionMap()

_getVariableToFunctionMap($data) 
Inherited

Parameters

$data

castInteger()

castInteger($int, $type = 'int'
Inherited

Parameters

$int

$type

getColumnsFromAliases()

getColumnsFromAliases($columns, $aliases) 
Inherited

Parameters

$columns

$aliases

getDatabaseType()

getDatabaseType() 
Inherited

getGEOMAsTextFunction()

getGEOMAsTextFunction($sql) 
Inherited

Parameters

$sql

getListSQL()

getListSQL($array, $ph = NULL, $cast = FALSE
Inherited

Parameters

$array

$ph

$cast

getSQLStringAggregate()

getSQLStringAggregate($sql, $glue) 
Inherited

Parameters

$sql

$glue

getSQLToEpochFunction()

getSQLToEpochFunction($sql) 
Inherited

Parameters

$sql

getSQLToTimeFunction()

getSQLToTimeFunction($sql) 
Inherited

Parameters

$sql

getSQLToTimeStampFunction()

getSQLToTimeStampFunction() 
Inherited

getSortSQL()

getSortSQL($array, $strict = TRUE, $additional_fields = NULL
Inherited

Parameters

$array

$strict

$additional_fields

getWhereClauseSQL()

getWhereClauseSQL($columns, $args, $type, $ph, $query_stub = NULL, $and = TRUE
Inherited

Parameters

$columns

$args

$type

$ph

$query_stub

$and

getWhereSQL()

getWhereSQL($array, $append_where = FALSE
Inherited

Parameters

$array

$append_where

handleSQLSyntax()

handleSQLSyntax($arg) 
Inherited

Parameters

$arg

stripSQLSyntax()

stripSQLSyntax($arg) 
Inherited

Parameters

$arg

getInsertQuery()

getInsertQuery() 
Inherited

getRecordSetColumnList()

getRecordSetColumnList($rs) 
Inherited

Parameters

$rs

getUpdateQuery()

getUpdateQuery() 
Inherited

parseColumnName()

parseColumnName($column) 
Inherited

Parameters

$column

 Properties

 

$data

$data 

Default

array()
 

$old_data

$old_data 

Default

array()
 

$phoneid_validator_regex

$phoneid_validator_regex 

Default

'/^[0-9]{1,250}$/i'
 

$username_validator_regex

$username_validator_regex 

Default

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

$validate_only

$validate_only 

Default

FALSE
 

$AMF_message_id

$AMF_message_id 

Default

NULL
 

$address_validator_regex

$address_validator_regex 

Default

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

$branch_obj

$branch_obj 

Default

NULL
 

$city_validator_regex

$city_validator_regex 

Default

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

$company_obj

$company_obj 

Default

NULL
 

$currency_obj

$currency_obj 

Default

NULL
 

$department_obj

$department_obj 

Default

NULL
 

$enable_system_log_detail

$enable_system_log_detail 

Default

TRUE
 

$group_obj

$group_obj 

Default

NULL
 

$name_validator_regex

$name_validator_regex 

Default

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

$next_insert_id

$next_insert_id 

Default

NULL
 

$phonepassword_validator_regex

$phonepassword_validator_regex 

Default

'/^[0-9]{1,250}$/i'
 

$pk_sequence_name

$pk_sequence_name 

Default

'users_id_seq'
 

$progress_bar_obj

$progress_bar_obj 

Default

NULL
 

$table

$table 

Default

'users'
 

$title_obj

$title_obj 

Default

NULL
 

$tmp_data

$tmp_data 

Default

NULL
 

$user_preference_obj

$user_preference_obj 

Default

NULL
 

$user_tax_obj

$user_tax_obj 

Default

NULL