Skip to content

UserFactory

Jump to bottom
Aydan Coskun edited this page Nov 29, 2019 · 1 revision

UserFactory

  • Class name: UserFactory
  • Namespace:
  • Parent class: Factory

Properties

$table

protected mixed $table = 'users'
  • Visibility: protected

$pk_sequence_name

protected mixed $pk_sequence_name = 'users_id_seq'
  • Visibility: protected

$user_preference_obj

protected mixed $user_preference_obj = NULL
  • Visibility: protected

$user_tax_obj

protected mixed $user_tax_obj = NULL
  • Visibility: protected

$legal_entity_obj

protected mixed $legal_entity_obj = NULL
  • Visibility: protected

$company_obj

protected mixed $company_obj = NULL
  • Visibility: protected

$title_obj

protected mixed $title_obj = NULL
  • Visibility: protected

$branch_obj

protected mixed $branch_obj = NULL
  • Visibility: protected

$department_obj

protected mixed $department_obj = NULL
  • Visibility: protected

$group_obj

protected mixed $group_obj = NULL
  • Visibility: protected

$currency_obj

protected mixed $currency_obj = NULL
  • Visibility: protected

$username_validator_regex

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

$phoneid_validator_regex

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

$phonepassword_validator_regex

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

$name_validator_regex

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

$address_validator_regex

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

$city_validator_regex

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

$data

public mixed $data = array()
  • Visibility: public

$old_data

public mixed $old_data = array()
  • Visibility: public

$tmp_data

public mixed $tmp_data = array()
  • Visibility: public

$enable_system_log_detail

protected mixed $enable_system_log_detail = TRUE
  • Visibility: protected

$progress_bar_obj

protected mixed $progress_bar_obj = NULL
  • Visibility: protected

$AMF_message_id

protected mixed $AMF_message_id = NULL
  • Visibility: protected

$Validator

public mixed $Validator = NULL
  • Visibility: public

$validate_only

public mixed $validate_only = FALSE
  • Visibility: public

$is_valid

private mixed $is_valid = FALSE
  • Visibility: private

Methods

_getFactoryOptions

boolean Factory::_getFactoryOptions(string $name, string|integer $parent)
  • Visibility: protected
  • This method is defined by Factory

Arguments

  • $name string
  • $parent string|integer

_getVariableToFunctionMap

boolean Factory::_getVariableToFunctionMap(array $data)
  • Visibility: protected
  • This method is defined by Factory

Arguments

  • $data array

getUserPreferenceObject

boolean|null|object UserFactory::getUserPreferenceObject()
  • Visibility: public

getCompanyObject

boolean UserFactory::getCompanyObject()
  • Visibility: public

getLegalEntityObject

boolean UserFactory::getLegalEntityObject()
  • Visibility: public

getTitleObject

boolean UserFactory::getTitleObject()
  • Visibility: public

getDefaultBranchObject

boolean UserFactory::getDefaultBranchObject()
  • Visibility: public

getDefaultDepartmentObject

boolean UserFactory::getDefaultDepartmentObject()
  • Visibility: public

getGroupObject

boolean UserFactory::getGroupObject()
  • Visibility: public

getCurrencyObject

boolean UserFactory::getCurrencyObject()
  • Visibility: public

getCompany

boolean|integer|string UserFactory::getCompany()
  • Visibility: public

setCompany

boolean UserFactory::setCompany(string $value)
  • Visibility: public

Arguments

  • $value string - UUID

getLegalEntity

boolean|mixed UserFactory::getLegalEntity()
  • Visibility: public

setLegalEntity

boolean UserFactory::setLegalEntity(string $value)
  • Visibility: public

Arguments

  • $value string - UUID

getStatus

boolean|integer UserFactory::getStatus()
  • Visibility: public

setStatus

boolean UserFactory::setStatus($value)
  • Visibility: public

Arguments

  • $value mixed

getGroup

boolean|mixed UserFactory::getGroup()
  • Visibility: public

setGroup

boolean UserFactory::setGroup(string $value)
  • Visibility: public

Arguments

  • $value string - UUID

getPermissionLevel

boolean|integer UserFactory::getPermissionLevel()
  • Visibility: public

getCurrentUserPermissionLevel

boolean|integer UserFactory::getCurrentUserPermissionLevel()
  • Visibility: public

getPermissionControl

boolean UserFactory::getPermissionControl($force)
  • Visibility: public

Arguments

  • $force mixed

setPermissionControl

boolean UserFactory::setPermissionControl(string $value)
  • Visibility: public

Arguments

  • $value string - UUID

getPayPeriodSchedule

boolean UserFactory::getPayPeriodSchedule()
  • Visibility: public

setPayPeriodSchedule

boolean UserFactory::setPayPeriodSchedule(string $value)
  • Visibility: public

Arguments

  • $value string - UUID

getPolicyGroup

boolean UserFactory::getPolicyGroup()
  • Visibility: public

setPolicyGroup

boolean UserFactory::setPolicyGroup(string $value)
  • Visibility: public

Arguments

  • $value string - UUID

getHierarchyLevelDisplay

boolean|string UserFactory::getHierarchyLevelDisplay()
  • Visibility: public

getHierarchyControlDisplay

boolean|string UserFactory::getHierarchyControlDisplay()
  • Visibility: public

getHierarchyControl

boolean UserFactory::getHierarchyControl()
  • Visibility: public

setHierarchyControl

boolean UserFactory::setHierarchyControl($data)
  • Visibility: public

Arguments

  • $data mixed

getFeedbackRating

boolean UserFactory::getFeedbackRating()
  • Visibility: public

setFeedbackRating

boolean UserFactory::setFeedbackRating($value)
  • Visibility: public

Arguments

  • $value mixed

getPromptForFeedback

array|boolean UserFactory::getPromptForFeedback()

Determines if the user should be prompted for feedback.

  • Visibility: public

isUniqueUserName

boolean UserFactory::isUniqueUserName($user_name)
  • Visibility: public

Arguments

  • $user_name mixed

getUserName

boolean|mixed UserFactory::getUserName()
  • Visibility: public

setUserName

boolean UserFactory::setUserName($value)
  • Visibility: public

Arguments

  • $value mixed

checkPassword

boolean UserFactory::checkPassword($password, boolean $check_password_policy)
  • Visibility: public

Arguments

  • $password mixed
  • $check_password_policy boolean

getPassword

boolean|mixed UserFactory::getPassword()
  • Visibility: public

setPassword

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

Arguments

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

isPasswordPolicyEnabled

boolean UserFactory::isPasswordPolicyEnabled()
  • Visibility: public

isFirstLogin

boolean UserFactory::isFirstLogin()
  • Visibility: public

isCompromisedPassword

boolean UserFactory::isCompromisedPassword()
  • Visibility: public

checkPasswordAge

boolean UserFactory::checkPasswordAge()
  • Visibility: public

getPasswordUpdatedDate

boolean|mixed UserFactory::getPasswordUpdatedDate()
  • Visibility: public

setPasswordUpdatedDate

boolean UserFactory::setPasswordUpdatedDate(integer $value)
  • Visibility: public

Arguments

  • $value integer - EPOCH

isUniquePhoneId

boolean UserFactory::isUniquePhoneId(string $phone_id)
  • Visibility: public

Arguments

  • $phone_id string - UUID

getPhoneId

boolean|string UserFactory::getPhoneId()
  • Visibility: public

setPhoneId

boolean UserFactory::setPhoneId(string $value)
  • Visibility: public

Arguments

  • $value string - UUID

checkPhonePassword

boolean UserFactory::checkPhonePassword($password)
  • Visibility: public

Arguments

  • $password mixed

getPhonePassword

boolean|mixed UserFactory::getPhonePassword()
  • Visibility: public

setPhonePassword

boolean UserFactory::setPhonePassword($phone_password, boolean $force)
  • Visibility: public

Arguments

  • $phone_password mixed
  • $force boolean

getNextAvailableEmployeeNumber

integer|null UserFactory::getNextAvailableEmployeeNumber(string $company_id)
  • Visibility: public

Arguments

  • $company_id string - UUID

isUniqueEmployeeNumber

boolean UserFactory::isUniqueEmployeeNumber(string $id)
  • Visibility: public

Arguments

  • $id string - UUID

checkEmployeeNumber

boolean UserFactory::checkEmployeeNumber(string $id)
  • Visibility: public

Arguments

  • $id string - UUID

getEmployeeNumber

boolean|integer UserFactory::getEmployeeNumber()
  • Visibility: public

setEmployeeNumber

boolean UserFactory::setEmployeeNumber($value)
  • Visibility: public

Arguments

  • $value mixed

getTitle

boolean|mixed UserFactory::getTitle()
  • Visibility: public

setTitle

boolean UserFactory::setTitle(string $value)
  • Visibility: public

Arguments

  • $value string - UUID

getEthnicGroup

boolean UserFactory::getEthnicGroup()
  • Visibility: public

setEthnicGroup

boolean UserFactory::setEthnicGroup(string $value)
  • Visibility: public

Arguments

  • $value string - UUID

getDefaultJob

boolean|mixed UserFactory::getDefaultJob()
  • Visibility: public

setDefaultJob

boolean UserFactory::setDefaultJob(string $value)
  • Visibility: public

Arguments

  • $value string - UUID

getDefaultJobItem

boolean|mixed UserFactory::getDefaultJobItem()
  • Visibility: public

setDefaultJobItem

boolean UserFactory::setDefaultJobItem(string $value)
  • Visibility: public

Arguments

  • $value string - UUID

getDefaultBranch

boolean|mixed UserFactory::getDefaultBranch()
  • Visibility: public

setDefaultBranch

boolean UserFactory::setDefaultBranch(string $value)
  • Visibility: public

Arguments

  • $value string - UUID

getDefaultDepartment

boolean|mixed UserFactory::getDefaultDepartment()
  • Visibility: public

setDefaultDepartment

boolean UserFactory::setDefaultDepartment(string $value)
  • Visibility: public

Arguments

  • $value string - UUID

getFullName

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

Arguments

  • $reverse boolean
  • $include_middle boolean

getFirstName

boolean|mixed UserFactory::getFirstName()
  • Visibility: public

setFirstName

boolean UserFactory::setFirstName($value)
  • Visibility: public

Arguments

  • $value mixed

getFirstNameMetaphone

boolean|mixed UserFactory::getFirstNameMetaphone()
  • Visibility: public

setFirstNameMetaphone

boolean UserFactory::setFirstNameMetaphone($value)
  • Visibility: public

Arguments

  • $value mixed

getMiddleInitial

boolean UserFactory::getMiddleInitial()
  • Visibility: public

getMiddleName

boolean|mixed UserFactory::getMiddleName()
  • Visibility: public

setMiddleName

boolean UserFactory::setMiddleName($value)
  • Visibility: public

Arguments

  • $value mixed

getLastName

boolean|mixed UserFactory::getLastName()
  • Visibility: public

setLastName

boolean UserFactory::setLastName($value)
  • Visibility: public

Arguments

  • $value mixed

getLastNameMetaphone

boolean|mixed UserFactory::getLastNameMetaphone()
  • Visibility: public

setLastNameMetaphone

boolean UserFactory::setLastNameMetaphone($value)
  • Visibility: public

Arguments

  • $value mixed

getSecondLastName

boolean|mixed UserFactory::getSecondLastName()
  • Visibility: public

setSecondLastName

boolean UserFactory::setSecondLastName($value)
  • Visibility: public

Arguments

  • $value mixed

getSex

boolean|integer UserFactory::getSex()
  • Visibility: public

setSex

boolean UserFactory::setSex($value)
  • Visibility: public

Arguments

  • $value mixed

getAddress1

boolean UserFactory::getAddress1()
  • Visibility: public

setAddress1

boolean UserFactory::setAddress1($value)
  • Visibility: public

Arguments

  • $value mixed

getAddress2

boolean UserFactory::getAddress2()
  • Visibility: public

setAddress2

boolean UserFactory::setAddress2($value)
  • Visibility: public

Arguments

  • $value mixed

getCity

boolean|mixed UserFactory::getCity()
  • Visibility: public

setCity

boolean UserFactory::setCity($value)
  • Visibility: public

Arguments

  • $value mixed

getCountry

boolean|mixed UserFactory::getCountry()
  • Visibility: public

setCountry

boolean UserFactory::setCountry($value)
  • Visibility: public

Arguments

  • $value mixed

getProvince

boolean|mixed UserFactory::getProvince()
  • Visibility: public

setProvince

boolean UserFactory::setProvince($value)
  • Visibility: public

Arguments

  • $value mixed

getPostalCode

boolean|mixed UserFactory::getPostalCode()
  • Visibility: public

setPostalCode

boolean UserFactory::setPostalCode($value)
  • Visibility: public

Arguments

  • $value mixed

getLongitude

boolean|float UserFactory::getLongitude()
  • Visibility: public

setLongitude

boolean UserFactory::setLongitude($value)
  • Visibility: public

Arguments

  • $value mixed

getLatitude

boolean|float UserFactory::getLatitude()
  • Visibility: public

setLatitude

boolean UserFactory::setLatitude($value)
  • Visibility: public

Arguments

  • $value mixed

getWorkPhone

boolean|mixed UserFactory::getWorkPhone()
  • Visibility: public

setWorkPhone

boolean UserFactory::setWorkPhone($value)
  • Visibility: public

Arguments

  • $value mixed

getWorkPhoneExt

boolean|mixed UserFactory::getWorkPhoneExt()
  • Visibility: public

setWorkPhoneExt

boolean UserFactory::setWorkPhoneExt($value)
  • Visibility: public

Arguments

  • $value mixed

getHomePhone

boolean|mixed UserFactory::getHomePhone()
  • Visibility: public

setHomePhone

boolean UserFactory::setHomePhone($value)
  • Visibility: public

Arguments

  • $value mixed

getMobilePhone

boolean|mixed UserFactory::getMobilePhone()
  • Visibility: public

setMobilePhone

boolean UserFactory::setMobilePhone($value)
  • Visibility: public

Arguments

  • $value mixed

getFaxPhone

boolean|mixed UserFactory::getFaxPhone()
  • Visibility: public

setFaxPhone

boolean UserFactory::setFaxPhone($value)
  • Visibility: public

Arguments

  • $value mixed

isUniqueHomeEmail

boolean UserFactory::isUniqueHomeEmail($email)
  • Visibility: public

Arguments

  • $email mixed

getHomeEmail

boolean|mixed UserFactory::getHomeEmail()
  • Visibility: public

setHomeEmail

boolean UserFactory::setHomeEmail($value)
  • Visibility: public

Arguments

  • $value mixed

getHomeEmailIsValid

boolean UserFactory::getHomeEmailIsValid()
  • Visibility: public

setHomeEmailIsValid

boolean UserFactory::setHomeEmailIsValid($value)
  • Visibility: public

Arguments

  • $value mixed

getHomeEmailIsValidKey

boolean|mixed UserFactory::getHomeEmailIsValidKey()
  • Visibility: public

setHomeEmailIsValidKey

boolean UserFactory::setHomeEmailIsValidKey($value)
  • Visibility: public

Arguments

  • $value mixed

getHomeEmailIsValidDate

mixed UserFactory::getHomeEmailIsValidDate()
  • Visibility: public

setHomeEmailIsValidDate

boolean UserFactory::setHomeEmailIsValidDate(integer $value)
  • Visibility: public

Arguments

  • $value integer - EPOCH

isUniqueWorkEmail

boolean UserFactory::isUniqueWorkEmail($email)
  • Visibility: public

Arguments

  • $email mixed

getWorkEmail

boolean|mixed UserFactory::getWorkEmail()
  • Visibility: public

setWorkEmail

boolean UserFactory::setWorkEmail($value)
  • Visibility: public

Arguments

  • $value mixed

getWorkEmailIsValid

boolean UserFactory::getWorkEmailIsValid()
  • Visibility: public

setWorkEmailIsValid

boolean UserFactory::setWorkEmailIsValid($value)
  • Visibility: public

Arguments

  • $value mixed

getWorkEmailIsValidKey

boolean|mixed UserFactory::getWorkEmailIsValidKey()
  • Visibility: public

setWorkEmailIsValidKey

boolean UserFactory::setWorkEmailIsValidKey($value)
  • Visibility: public

Arguments

  • $value mixed

getWorkEmailIsValidDate

mixed UserFactory::getWorkEmailIsValidDate()
  • Visibility: public

setWorkEmailIsValidDate

boolean UserFactory::setWorkEmailIsValidDate(integer $value)
  • Visibility: public

Arguments

  • $value integer - EPOCH

getAge

float UserFactory::getAge()
  • Visibility: public

getBirthDate

boolean|mixed UserFactory::getBirthDate($raw)
  • Visibility: public

Arguments

  • $raw mixed

setBirthDate

boolean UserFactory::setBirthDate(integer $value)
  • Visibility: public

Arguments

  • $value integer - EPOCH

isValidWageForHireDate

boolean UserFactory::isValidWageForHireDate(integer $epoch)
  • Visibility: public

Arguments

  • $epoch integer - EPOCH

getHireDate

boolean|mixed UserFactory::getHireDate($raw)
  • Visibility: public

Arguments

  • $raw mixed

setHireDate

boolean UserFactory::setHireDate($value)
  • Visibility: public

Arguments

  • $value mixed

getTerminationDate

boolean|mixed UserFactory::getTerminationDate($raw)
  • Visibility: public

Arguments

  • $raw mixed

setTerminationDate

boolean UserFactory::setTerminationDate(integer $value)
  • Visibility: public

Arguments

  • $value integer - EPOCH

getLastLoginDate

boolean|mixed UserFactory::getLastLoginDate()
  • Visibility: public

setLastLoginDate

boolean UserFactory::setLastLoginDate(integer $value)
  • Visibility: public

Arguments

  • $value integer - EPOCH

getCurrency

boolean|mixed UserFactory::getCurrency()
  • Visibility: public

setCurrency

boolean UserFactory::setCurrency(string $value)
  • Visibility: public

Arguments

  • $value string - UUID

getSecureSIN

boolean|string UserFactory::getSecureSIN(null $sin)
  • Visibility: public

Arguments

  • $sin null

getSIN

boolean|mixed UserFactory::getSIN()
  • Visibility: public

setSIN

boolean UserFactory::setSIN($value)
  • Visibility: public

Arguments

  • $value mixed

isUniqueSIN

mixed UserFactory::isUniqueSIN($sin)
  • Visibility: public

Arguments

  • $sin mixed

getOtherID1

boolean UserFactory::getOtherID1()
  • Visibility: public

setOtherID1

boolean UserFactory::setOtherID1($value)
  • Visibility: public

Arguments

  • $value mixed

getOtherID2

boolean UserFactory::getOtherID2()
  • Visibility: public

setOtherID2

boolean UserFactory::setOtherID2($value)
  • Visibility: public

Arguments

  • $value mixed

getOtherID3

boolean UserFactory::getOtherID3()
  • Visibility: public

setOtherID3

boolean UserFactory::setOtherID3($value)
  • Visibility: public

Arguments

  • $value mixed

getOtherID4

boolean UserFactory::getOtherID4()
  • Visibility: public

setOtherID4

boolean UserFactory::setOtherID4($value)
  • Visibility: public

Arguments

  • $value mixed

getOtherID5

boolean UserFactory::getOtherID5()
  • Visibility: public

setOtherID5

boolean UserFactory::setOtherID5($value)
  • Visibility: public

Arguments

  • $value mixed

getNote

boolean|mixed UserFactory::getNote()
  • Visibility: public

setNote

boolean UserFactory::setNote($value)
  • Visibility: public

Arguments

  • $value mixed

sendValidateEmail

boolean UserFactory::sendValidateEmail(string $type)
  • Visibility: public

Arguments

  • $type string

encryptPasswordResetKey

string UserFactory::encryptPasswordResetKey($key)
  • Visibility: public

Arguments

  • $key mixed

checkPasswordResetKey

boolean UserFactory::checkPasswordResetKey($key)
  • Visibility: public

Arguments

  • $key mixed

sendPasswordResetEmail

boolean UserFactory::sendPasswordResetEmail()
  • Visibility: public

getPasswordResetKey

boolean|mixed UserFactory::getPasswordResetKey()
  • Visibility: public

setPasswordResetKey

boolean UserFactory::setPasswordResetKey($value)
  • Visibility: public

Arguments

  • $value mixed

getPasswordResetDate

mixed UserFactory::getPasswordResetDate()
  • Visibility: public

setPasswordResetDate

boolean UserFactory::setPasswordResetDate(integer $value)
  • Visibility: public

Arguments

  • $value integer - EPOCH

setEnableClearPasswordResetData

boolean UserFactory::setEnableClearPasswordResetData(boolean $value)
  • Visibility: public

Arguments

  • $value boolean

getEnableClearPasswordResetData

boolean UserFactory::getEnableClearPasswordResetData()
  • Visibility: public

isPhotoExists

boolean UserFactory::isPhotoExists()
  • Visibility: public

getPhotoFileName

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

Arguments

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

cleanStoragePath

boolean UserFactory::cleanStoragePath(string $company_id, string $user_id)
  • Visibility: public

Arguments

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

getStoragePath

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

Arguments

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

getTag

boolean|string UserFactory::getTag()
  • Visibility: public

setTag

boolean UserFactory::setTag($value)
  • Visibility: public

Arguments

  • $value mixed

UnsubscribeEmail

boolean UserFactory::UnsubscribeEmail($email)
  • Visibility: public
  • This method is static.

Arguments

  • $email mixed

Validate

boolean UserFactory::Validate(boolean $ignore_warning)
  • Visibility: public

Arguments

  • $ignore_warning boolean

preSave

boolean UserFactory::preSave()
  • Visibility: public

postSave

boolean UserFactory::postSave()
  • Visibility: public

getMapURL

boolean|string UserFactory::getMapURL()
  • Visibility: public

setObjectFromArray

boolean UserFactory::setObjectFromArray($data)
  • Visibility: public

Arguments

  • $data mixed

getObjectAsArray

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

Arguments

  • $include_columns null
  • $permission_children_ids boolean

addLog

boolean UserFactory::addLog($log_action)
  • Visibility: public

Arguments

  • $log_action mixed

__construct

mixed Factory::__construct()

Factory constructor.

  • Visibility: public
  • This method is defined by Factory

getAMFMessageID

boolean|null Factory::getAMFMessageID()

Used for updating progress bar for API calls.

  • Visibility: public
  • This method is defined by Factory

setAMFMessageID

boolean Factory::setAMFMessageID(string $id)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $id string - UUID

setProgressBarObject

boolean Factory::setProgressBarObject(object $obj)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $obj object

getProgressBarObject

null|\ProgressBar Factory::getProgressBarObject()
  • Visibility: public
  • This method is defined by Factory

setGenericObject

boolean Factory::setGenericObject(object $obj, string $variable)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $obj object
  • $variable string

getGenericObject

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

Arguments

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

getCompanyGenericMapData

mixed Factory::getCompanyGenericMapData(string $company_id, integer $object_type_id, string $id, string $variable)
  • Visibility: public
  • This method is defined by Factory

Arguments

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

getGenericDataValue

boolean|mixed Factory::getGenericDataValue(string $name, $cast)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $name string
  • $cast mixed

setGenericDataValue

boolean Factory::setGenericDataValue(string $name, mixed $data, $cast)
  • Visibility: public
  • This method is defined by Factory

Arguments

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

castGenericDataValue

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

Arguments

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

getGenericTempDataValue

boolean Factory::getGenericTempDataValue(string $name)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $name string

setGenericTempDataValue

boolean Factory::setGenericTempDataValue(string $name, mixed $data)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $name string
  • $data mixed

getGenericOldDataValue

boolean|mixed Factory::getGenericOldDataValue(string $name)
  • Visibility: public
  • This method is defined by Factory

Arguments

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

getCache

boolean|mixed Factory::getCache(string $cache_id, string $group_id)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $cache_id string
  • $group_id string

saveCache

boolean Factory::saveCache(mixed $data, string $cache_id, string $group_id)
  • Visibility: public
  • This method is defined by Factory

Arguments

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

removeCache

boolean Factory::removeCache(string $cache_id, string $group_id)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $cache_id string
  • $group_id string

setCacheLifeTime

boolean Factory::setCacheLifeTime(integer $secs)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $secs integer

serializeRS

string Factory::serializeRS(object $rs)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $rs object

unserializeRS

mixed Factory::unserializeRS(string $rs)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $rs string

getTable

boolean|string Factory::getTable(boolean $strip_quotes)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $strip_quotes boolean

getColumn

boolean|mixed Factory::getColumn(string $column)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $column string

__toString

boolean|string Factory::__toString()
  • Visibility: public
  • This method is defined by Factory

toBool

integer Factory::toBool(string|integer|boolean $value)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $value string|integer|boolean

fromBool

boolean Factory::fromBool(string|integer|boolean $value)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $value string|integer|boolean

isNew

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

Arguments

  • $force_lookup boolean
  • $id string - UUID

getLabelId

boolean|mixed|string Factory::getLabelId()
  • Visibility: public
  • This method is defined by Factory

getId

boolean|mixed Factory::getId()
  • Visibility: public
  • This method is defined by Factory

setId

boolean Factory::setId(string $id)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $id string - UUID

getEnableSystemLogDetail

boolean Factory::getEnableSystemLogDetail()
  • Visibility: public
  • This method is defined by Factory

setEnableSystemLogDetail

boolean Factory::setEnableSystemLogDetail($bool)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $bool mixed

getDeleted

boolean Factory::getDeleted()
  • Visibility: public
  • This method is defined by Factory

setDeleted

boolean Factory::setDeleted(boolean $bool)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $bool boolean

getCreatedDate

integer Factory::getCreatedDate()
  • Visibility: public
  • This method is defined by Factory

setCreatedDate

boolean Factory::setCreatedDate(integer $epoch)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $epoch integer - EPOCH

getCreatedBy

boolean|mixed Factory::getCreatedBy()
  • Visibility: public
  • This method is defined by Factory

setCreatedBy

boolean Factory::setCreatedBy(string $id)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $id string - UUID

getUpdatedDate

integer Factory::getUpdatedDate()
  • Visibility: public
  • This method is defined by Factory

setUpdatedDate

boolean|integer|null|string Factory::setUpdatedDate(integer $epoch)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $epoch integer - EPOCH

getUpdatedBy

boolean|mixed Factory::getUpdatedBy()
  • Visibility: public
  • This method is defined by Factory

setUpdatedBy

boolean|null Factory::setUpdatedBy(string $id)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $id string - UUID

getDeletedDate

boolean|mixed Factory::getDeletedDate()
  • Visibility: public
  • This method is defined by Factory

setDeletedDate

boolean Factory::setDeletedDate(integer $epoch)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $epoch integer - EPOCH

getDeletedBy

boolean|mixed Factory::getDeletedBy()
  • Visibility: public
  • This method is defined by Factory

setDeletedBy

boolean|null Factory::setDeletedBy(string $id)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $id string - UUID

setIsValid

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

Arguments

  • $is_valid boolean

setCreatedAndUpdatedColumns

boolean Factory::setCreatedAndUpdatedColumns(array $data, array $variable_to_function_map)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $data array
  • $variable_to_function_map array

getCreatedAndUpdatedColumns

boolean Factory::getCreatedAndUpdatedColumns(array $data, null $include_columns)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $data array
  • $include_columns null

getPermissionColumns

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

Arguments

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

getOptions

array|boolean Factory::getOptions(string $name, string|integer $parent)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $name string
  • $parent string|integer

getVariableToFunctionMap

array|boolean Factory::getVariableToFunctionMap(array $data)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $data array

getRecordCount

integer|boolean Factory::getRecordCount()
  • Visibility: public
  • This method is defined by Factory

getCurrentRow

integer|boolean Factory::getCurrentRow(integer $offset)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $offset integer

setQueryStatementTimeout

boolean Factory::setQueryStatementTimeout(null $milliseconds)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $milliseconds null

getRecordSetColumnList

array|boolean Factory::getRecordSetColumnList(object $rs)
  • Visibility: private
  • This method is defined by Factory

Arguments

  • $rs object

castInteger

boolean|integer|string Factory::castInteger(integer|string $int, string $type)
  • Visibility: protected
  • This method is defined by Factory

Arguments

  • $int integer|string
  • $type string

getListSQL

boolean|integer|string|array Factory::getListSQL(array|string|integer $array, array $ph, string|boolean $cast)
  • Visibility: protected
  • This method is defined by Factory

Arguments

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

getDateRangeSQL

boolean|string Factory::getDateRangeSQL(string $str, string $column, string $format, boolean $include_blank_dates)
  • Visibility: public
  • This method is defined by Factory

Arguments

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

handleSQLSyntax

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

Arguments

  • $arg string

stripSQLSyntax

mixed Factory::stripSQLSyntax(string $arg)
  • Visibility: protected
  • This method is defined by Factory

Arguments

  • $arg string

getSQLToTimeStampFunction

string Factory::getSQLToTimeStampFunction()
  • Visibility: protected
  • This method is defined by Factory

getDatabaseType

string Factory::getDatabaseType()
  • Visibility: protected
  • This method is defined by Factory

getGEOMAsTextFunction

string Factory::getGEOMAsTextFunction(string $sql)
  • Visibility: protected
  • This method is defined by Factory

Arguments

  • $sql string

getSQLToEpochFunction

string Factory::getSQLToEpochFunction(string $sql)
  • Visibility: protected
  • This method is defined by Factory

Arguments

  • $sql string

getSQLToTimeFunction

string Factory::getSQLToTimeFunction(string $sql)
  • Visibility: protected
  • This method is defined by Factory

Arguments

  • $sql string

getSQLStringAggregate

string Factory::getSQLStringAggregate(string $sql, string $glue)
  • Visibility: protected
  • This method is defined by Factory

Arguments

  • $sql string
  • $glue string

getWhereClauseSQL

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

Arguments

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

parseColumnName

boolean|string Factory::parseColumnName(string $column)
  • Visibility: private
  • This method is defined by Factory

Arguments

  • $column string

getWhereSQL

boolean|string Factory::getWhereSQL(array $array, boolean $append_where)
  • Visibility: protected
  • This method is defined by Factory

Arguments

  • $array array
  • $append_where boolean

getColumnsFromAliases

array Factory::getColumnsFromAliases(array $columns, array $aliases)
  • Visibility: protected
  • This method is defined by Factory

Arguments

  • $columns array
  • $aliases array

convertFlexArray

array Factory::convertFlexArray(array $array)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $array array

getValidSQLColumns

array Factory::getValidSQLColumns(array $array, boolean $strict, array $additional_fields)
  • Visibility: public
  • This method is defined by Factory

Arguments

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

getSortSQL

boolean|string Factory::getSortSQL(array $array, boolean $strict, array $additional_fields)
  • Visibility: protected
  • This method is defined by Factory

Arguments

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

getColumnList

array|boolean Factory::getColumnList()
  • Visibility: public
  • This method is defined by Factory

getEmptyRecordSet

mixed Factory::getEmptyRecordSet(string $id)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $id string - UUID

getUpdateQuery

boolean Factory::getUpdateQuery()
  • Visibility: private
  • This method is defined by Factory

getInsertQuery

mixed Factory::getInsertQuery()
  • Visibility: private
  • This method is defined by Factory

StartTransaction

mixed Factory::StartTransaction()
  • Visibility: public
  • This method is defined by Factory

FailTransaction

mixed Factory::FailTransaction()
  • Visibility: public
  • This method is defined by Factory

CommitTransaction

mixed Factory::CommitTransaction()
  • Visibility: public
  • This method is defined by Factory

setTransactionMode

mixed Factory::setTransactionMode(string $mode)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $mode string

getTransactionMode

string Factory::getTransactionMode()
  • Visibility: public
  • This method is defined by Factory

isValid

boolean Factory::isValid(boolean $ignore_warning)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $ignore_warning boolean

isWarning

boolean Factory::isWarning()
  • Visibility: public
  • This method is defined by Factory

getSequenceName

boolean Factory::getSequenceName()
  • Visibility: public
  • This method is defined by Factory

getNextInsertId

boolean|string Factory::getNextInsertId()
  • Visibility: public
  • This method is defined by Factory

ExecuteSQL

boolean Factory::ExecuteSQL(string $query, array $ph, integer $limit, integer $page)
  • Visibility: public
  • This method is defined by Factory

Arguments

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

RetryExecuteSQL

boolean Factory::RetryExecuteSQL(string $query, array $ph, integer $retry_max_attempts, integer $sleep)
  • Visibility: public
  • This method is defined by Factory

Arguments

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

getDataDifferences

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

isDataDifferent

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

Arguments

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

Save

boolean|integer|string Factory::Save(boolean $reset_data, boolean $force_lookup)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $reset_data boolean
  • $force_lookup boolean

Delete

boolean Factory::Delete()
  • Visibility: public
  • This method is defined by Factory

getIDSByListFactory

array|boolean Factory::getIDSByListFactory(object $lf)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $lf object

bulkDelete

boolean Factory::bulkDelete(string|array $ids)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $ids string|array - UUID

clearGeoCode

boolean Factory::clearGeoCode(array $data_diff)
  • Visibility: public
  • This method is defined by Factory

Arguments

  • $data_diff array

clearNonMappedData

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

Arguments

  • $data array|null

clearData

boolean Factory::clearData()
  • Visibility: public
  • This method is defined by Factory

clearOldData

boolean Factory::clearOldData()
  • Visibility: public
  • This method is defined by Factory

getIterator

\FactoryListIterator Factory::getIterator()
  • Visibility: public
  • This method is defined by Factory

getCurrent

mixed Factory::getCurrent()
  • Visibility: public
  • This method is defined by Factory

Clone this wiki locally