CompanyDeductionFactory - staffcheck/api GitHub Wiki

CompanyDeductionFactory

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

Properties

$table

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

$pk_sequence_name

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

$company_obj

public mixed $company_obj = NULL
  • Visibility: public

$legal_entity_obj

public mixed $legal_entity_obj = NULL
  • Visibility: public

$payroll_remittance_agency_obj

public mixed $payroll_remittance_agency_obj = NULL
  • Visibility: public

$pay_stub_entry_account_link_obj

public mixed $pay_stub_entry_account_link_obj = NULL
  • Visibility: public

$pay_stub_entry_account_obj

public mixed $pay_stub_entry_account_obj = NULL
  • Visibility: public

$users

public mixed $users = NULL
  • Visibility: public

$lookback_pay_stub_lf

public mixed $lookback_pay_stub_lf = NULL
  • Visibility: public

$country_calculation_ids

public mixed $country_calculation_ids = array('100', '200', '300')
  • Visibility: public

$province_calculation_ids

public mixed $province_calculation_ids = array('200', '300')
  • Visibility: public

$district_calculation_ids

public mixed $district_calculation_ids = array('300')
  • Visibility: public

$calculation_id_fields

public mixed $calculation_id_fields = array('10' => '10', '15' => '15', '16' => '16', '17' => '17', '18' => '18', '19' => '19', '20' => '20', '30' => '30', '52' => '52', '69' => '69', '80' => '80', '82' => '82', '83' => '83', '84' => '84', '85' => '85', '100' => '', '100-CA' => '100-CA', '100-US' => '100-US', '100-CR' => '100-CR', '200' => '', '200-CA-BC' => '200-CA', '200-CA-AB' => '200-CA', '200-CA-SK' => '200-CA', '200-CA-MB' => '200-CA', '200-CA-QC' => '200-CA', '200-CA-ON' => '200-CA', '200-CA-NL' => '200-CA', '200-CA-NB' => '200-CA', '200-CA-NS' => '200-CA', '200-CA-PE' => '200-CA', '200-CA-NT' => '200-CA', '200-CA-YT' => '200-CA', '200-CA-NU' => '200-CA', '200-US-AL' => '200-US-AL', '200-US-AK' => '', '200-US-AZ' => '200-US-AZ', '200-US-AR' => '200-US-OH', '200-US-CA' => '200-US', '200-US-CO' => '200-US-WI', '200-US-CT' => '200-US-CT', '200-US-DE' => '200-US-DE', '200-US-DC' => '200-US-DC', '200-US-FL' => '', '200-US-GA' => '200-US-GA', '200-US-HI' => '200-US-WI', '200-US-ID' => '200-US-WI', '200-US-IL' => '200-US-IL', '200-US-IN' => '200-US-IN', '200-US-IA' => '200-US-OH', '200-US-KS' => '200-US-WI', '200-US-KY' => '200-US-OH', '200-US-LA' => '200-US-LA', '200-US-ME' => '200-US-ME', '200-US-MD' => '200-US-MD', '200-US-MA' => '200-US-MA', '200-US-MI' => '200-US-OH', '200-US-MN' => '200-US-WI', '200-US-MS' => '200-US', '200-US-MO' => '200-US', '200-US-MT' => '200-US-OH', '200-US-NE' => '200-US-WI', '200-US-NV' => '', '200-US-NH' => '', '200-US-NM' => '200-US-WI', '200-US-NJ' => '200-US-NJ', '200-US-NY' => '100-US', '200-US-NC' => '200-US-NC', '200-US-ND' => '200-US-WI', '200-US-OH' => '200-US-OH', '200-US-OK' => '200-US-WI', '200-US-OR' => '200-US-WI', '200-US-PA' => '200-US-PA', '200-US-RI' => '200-US-WI', '200-US-SC' => '200-US-OH', '200-US-SD' => '', '200-US-TN' => '', '200-US-TX' => '', '200-US-UT' => '200-US-WI', '200-US-VT' => '200-US-WI', '200-US-VA' => '200-US-VA', '200-US-WA' => '', '200-US-WV' => '200-US-WV', '200-US-WI' => '200-US-WI', '200-US-WY' => '', '300-US-AL' => '300-US-PERCENT', '300-US-AK' => '300-US-PERCENT', '300-US-AZ' => '300-US-PERCENT', '300-US-AR' => '300-US-PERCENT', '300-US-CA' => '300-US-PERCENT', '300-US-CO' => '300-US-PERCENT', '300-US-CT' => '300-US-PERCENT', '300-US-DE' => '300-US-PERCENT', '300-US-DC' => '300-US-PERCENT', '300-US-FL' => '300-US-PERCENT', '300-US-GA' => '300-US-PERCENT', '300-US-HI' => '300-US-PERCENT', '300-US-ID' => '300-US-PERCENT', '300-US-IL' => '300-US-PERCENT', '300-US-IN' => '300-US-IN', '300-US-IA' => '300-US-PERCENT', '300-US-KS' => '300-US-PERCENT', '300-US-KY' => '300-US-PERCENT', '300-US-LA' => '300-US-PERCENT', '300-US-ME' => '300-US-PERCENT', '300-US-MD' => '300-US-MD', '300-US-MA' => '300-US-PERCENT', '300-US-MI' => '300-US-PERCENT', '300-US-MN' => '300-US-PERCENT', '300-US-MS' => '300-US-PERCENT', '300-US-MO' => '300-US-PERCENT', '300-US-MT' => '300-US-PERCENT', '300-US-NE' => '300-US-PERCENT', '300-US-NV' => '300-US-PERCENT', '300-US-NH' => '300-US-PERCENT', '300-US-NM' => '300-US-PERCENT', '300-US-NJ' => '300-US-PERCENT', '300-US-NY' => '300-US', '300-US-NC' => '300-US-PERCENT', '300-US-ND' => '300-US-PERCENT', '300-US-OH' => '300-US-PERCENT', '300-US-OK' => '300-US-PERCENT', '300-US-OR' => '300-US-PERCENT', '300-US-PA' => '300-US-PERCENT', '300-US-RI' => '300-US-PERCENT', '300-US-SC' => '300-US-PERCENT', '300-US-SD' => '300-US-PERCENT', '300-US-TN' => '300-US-PERCENT', '300-US-TX' => '300-US-PERCENT', '300-US-UT' => '300-US-PERCENT', '300-US-VT' => '300-US-PERCENT', '300-US-VA' => '300-US-PERCENT', '300-US-WA' => '300-US-PERCENT', '300-US-WV' => '300-US-PERCENT', '300-US-WI' => '300-US-PERCENT', '300-US-WY' => '300-US-PERCENT')
  • Visibility: public

$length_of_service_multiplier

protected mixed $length_of_service_multiplier = array(0 => 0, 10 => 1, 20 => 7, 30 => 30.4167, 40 => 365.25, 50 => 0.041666666666666664)
  • Visibility: protected

$account_amount_type_map

protected mixed $account_amount_type_map = array(10 => 'amount', 20 => 'units', 30 => 'ytd_amount', 40 => 'ytd_units')
  • Visibility: protected

$account_amount_type_ps_entries_map

protected mixed $account_amount_type_ps_entries_map = array(10 => 'current', 20 => 'current', 30 => 'previous+ytd_adjustment', 40 => 'previous+ytd_adjustment')
  • 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

getCompanyObject

boolean CompanyDeductionFactory::getCompanyObject()
  • Visibility: public

getPayStubEntryAccountLinkObject

boolean|null CompanyDeductionFactory::getPayStubEntryAccountLinkObject()
  • Visibility: public

getPayStubEntryAccountObject

boolean CompanyDeductionFactory::getPayStubEntryAccountObject()
  • Visibility: public

getLengthOfServiceContributingPayCodePolicyObject

boolean CompanyDeductionFactory::getLengthOfServiceContributingPayCodePolicyObject()
  • Visibility: public

getPayrollRemittanceAgencyObject

boolean CompanyDeductionFactory::getPayrollRemittanceAgencyObject()
  • Visibility: public

getLegalEntityObject

boolean CompanyDeductionFactory::getLegalEntityObject()
  • Visibility: public

getLegalEntity

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

setLegalEntity

boolean CompanyDeductionFactory::setLegalEntity($value)
  • Visibility: public

Arguments

  • $value mixed

getCompany

boolean|mixed CompanyDeductionFactory::getCompany()
  • Visibility: public

setCompany

boolean CompanyDeductionFactory::setCompany($value)
  • Visibility: public

Arguments

  • $value mixed

getPayrollRemittanceAgency

boolean|mixed CompanyDeductionFactory::getPayrollRemittanceAgency()
  • Visibility: public

setPayrollRemittanceAgency

boolean CompanyDeductionFactory::setPayrollRemittanceAgency($value)
  • Visibility: public

Arguments

  • $value mixed

getStatus

integer CompanyDeductionFactory::getStatus()
  • Visibility: public

setStatus

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

Arguments

  • $value mixed

getType

integer CompanyDeductionFactory::getType()
  • Visibility: public

setType

boolean CompanyDeductionFactory::setType($value)
  • Visibility: public

Arguments

  • $value mixed

isUniqueName

boolean CompanyDeductionFactory::isUniqueName($name)
  • Visibility: public

Arguments

  • $name mixed

getName

boolean|mixed CompanyDeductionFactory::getName()
  • Visibility: public

setName

boolean CompanyDeductionFactory::setName($value)
  • Visibility: public

Arguments

  • $value mixed

getDescription

boolean|mixed CompanyDeductionFactory::getDescription()
  • Visibility: public

setDescription

boolean CompanyDeductionFactory::setDescription($value)
  • Visibility: public

Arguments

  • $value mixed

getPayStubEntryDescription

boolean|mixed CompanyDeductionFactory::getPayStubEntryDescription()
  • Visibility: public

setPayStubEntryDescription

boolean CompanyDeductionFactory::setPayStubEntryDescription($value)
  • Visibility: public

Arguments

  • $value mixed

getStartDate

boolean|integer|mixed CompanyDeductionFactory::getStartDate(boolean $raw)
  • Visibility: public

Arguments

  • $raw boolean

setStartDate

boolean CompanyDeductionFactory::setStartDate($value)
  • Visibility: public

Arguments

  • $value mixed

getEndDate

boolean|integer|mixed CompanyDeductionFactory::getEndDate(boolean $raw)
  • Visibility: public

Arguments

  • $raw boolean

setEndDate

boolean CompanyDeductionFactory::setEndDate($value)
  • Visibility: public

Arguments

  • $value mixed

isActiveDate

boolean CompanyDeductionFactory::isActiveDate(object $ud_obj, integer $pp_end_date, integer $pp_transaction_date)
  • Visibility: public

Arguments

  • $ud_obj object
  • $pp_end_date integer - EPOCH
  • $pp_transaction_date integer - EPOCH

getMinimumLengthOfServiceDays

float CompanyDeductionFactory::getMinimumLengthOfServiceDays()
  • Visibility: public

setMinimumLengthOfServiceDays

boolean CompanyDeductionFactory::setMinimumLengthOfServiceDays($value)
  • Visibility: public

Arguments

  • $value mixed

getMinimumLengthOfService

float CompanyDeductionFactory::getMinimumLengthOfService()
  • Visibility: public

setMinimumLengthOfService

boolean CompanyDeductionFactory::setMinimumLengthOfService($value)
  • Visibility: public

Arguments

  • $value mixed

getMinimumLengthOfServiceUnit

integer CompanyDeductionFactory::getMinimumLengthOfServiceUnit()
  • Visibility: public

setMinimumLengthOfServiceUnit

boolean CompanyDeductionFactory::setMinimumLengthOfServiceUnit($value)
  • Visibility: public

Arguments

  • $value mixed

getMaximumLengthOfServiceDays

float CompanyDeductionFactory::getMaximumLengthOfServiceDays()
  • Visibility: public

setMaximumLengthOfServiceDays

boolean CompanyDeductionFactory::setMaximumLengthOfServiceDays($value)
  • Visibility: public

Arguments

  • $value mixed

getMaximumLengthOfService

float CompanyDeductionFactory::getMaximumLengthOfService()
  • Visibility: public

setMaximumLengthOfService

boolean CompanyDeductionFactory::setMaximumLengthOfService($value)
  • Visibility: public

Arguments

  • $value mixed

getMaximumLengthOfServiceUnit

integer CompanyDeductionFactory::getMaximumLengthOfServiceUnit()
  • Visibility: public

setMaximumLengthOfServiceUnit

boolean CompanyDeductionFactory::setMaximumLengthOfServiceUnit($value)
  • Visibility: public

Arguments

  • $value mixed

getMinimumUserAge

float CompanyDeductionFactory::getMinimumUserAge()
  • Visibility: public

setMinimumUserAge

boolean CompanyDeductionFactory::setMinimumUserAge($value)
  • Visibility: public

Arguments

  • $value mixed

getMaximumUserAge

float CompanyDeductionFactory::getMaximumUserAge()
  • Visibility: public

setMaximumUserAge

boolean CompanyDeductionFactory::setMaximumUserAge($value)
  • Visibility: public

Arguments

  • $value mixed

getLengthOfServiceContributingPayCodePolicy

boolean|mixed CompanyDeductionFactory::getLengthOfServiceContributingPayCodePolicy()
  • Visibility: public

setLengthOfServiceContributingPayCodePolicy

boolean CompanyDeductionFactory::setLengthOfServiceContributingPayCodePolicy($value)
  • Visibility: public

Arguments

  • $value mixed

getApplyFrequency

integer CompanyDeductionFactory::getApplyFrequency()
  • Visibility: public

setApplyFrequency

boolean CompanyDeductionFactory::setApplyFrequency($value)
  • Visibility: public

Arguments

  • $value mixed

getApplyFrequencyMonth

boolean|mixed CompanyDeductionFactory::getApplyFrequencyMonth()
  • Visibility: public

setApplyFrequencyMonth

boolean CompanyDeductionFactory::setApplyFrequencyMonth($value)
  • Visibility: public

Arguments

  • $value mixed

getApplyFrequencyDayOfMonth

boolean|mixed CompanyDeductionFactory::getApplyFrequencyDayOfMonth()
  • Visibility: public

setApplyFrequencyDayOfMonth

boolean CompanyDeductionFactory::setApplyFrequencyDayOfMonth($value)
  • Visibility: public

Arguments

  • $value mixed

getApplyFrequencyDayOfWeek

boolean|mixed CompanyDeductionFactory::getApplyFrequencyDayOfWeek()
  • Visibility: public

setApplyFrequencyDayOfWeek

boolean CompanyDeductionFactory::setApplyFrequencyDayOfWeek($value)
  • Visibility: public

Arguments

  • $value mixed

getApplyFrequencyQuarterMonth

boolean|mixed CompanyDeductionFactory::getApplyFrequencyQuarterMonth()
  • Visibility: public

setApplyFrequencyQuarterMonth

boolean CompanyDeductionFactory::setApplyFrequencyQuarterMonth($value)
  • Visibility: public

Arguments

  • $value mixed

getApplyPayrollRunType

integer CompanyDeductionFactory::getApplyPayrollRunType()
  • Visibility: public

setApplyPayrollRunType

boolean CompanyDeductionFactory::setApplyPayrollRunType($value)
  • Visibility: public

Arguments

  • $value mixed

inApplyFrequencyWindow

boolean CompanyDeductionFactory::inApplyFrequencyWindow(integer $pay_period_start_date, integer $pay_period_end_date, integer $hire_date, integer $termination_date, integer $birth_date)
  • Visibility: public

Arguments

  • $pay_period_start_date integer - EPOCH
  • $pay_period_end_date integer - EPOCH
  • $hire_date integer - EPOCH
  • $termination_date integer - EPOCH
  • $birth_date integer - EPOCH

inApplyPayrollRunType

boolean CompanyDeductionFactory::inApplyPayrollRunType(integer $type_id)
  • Visibility: public

Arguments

  • $type_id integer

getWorkedTimeByUserIdAndEndDate

boolean|integer CompanyDeductionFactory::getWorkedTimeByUserIdAndEndDate(string $user_id, integer $start_date, integer $end_date)
  • Visibility: public

Arguments

  • $user_id string - UUID
  • $start_date integer - EPOCH
  • $end_date integer - EPOCH

isUserLengthOfServiceEligibility

boolean CompanyDeductionFactory::isUserLengthOfServiceEligibility()

Check to see if user length of service eligibility criteria are actually specified for this Tax/Deduction record.

  • Visibility: public

isActiveLengthOfService

boolean CompanyDeductionFactory::isActiveLengthOfService(object $ud_obj, integer $epoch, boolean $pay_period_start_date)
  • Visibility: public

Arguments

  • $ud_obj object
  • $epoch integer - EPOCH
  • $pay_period_start_date boolean

isCPPAgeEligible

boolean CompanyDeductionFactory::isCPPAgeEligible(integer $birth_date, integer $pp_transaction_date)
  • Visibility: public

Arguments

  • $birth_date integer - EPOCH
  • $pp_transaction_date integer - EPOCH

isUserAgeEligibility

boolean CompanyDeductionFactory::isUserAgeEligibility()

Check to see if user age eligibility criteria are actually specified for this Tax/Deduction record.

  • Visibility: public

isActiveUserAge

boolean CompanyDeductionFactory::isActiveUserAge(integer $birth_date, integer $pp_end_date, integer $pp_transaction_date)
  • Visibility: public

Arguments

  • $birth_date integer - EPOCH
  • $pp_end_date integer - EPOCH
  • $pp_transaction_date integer - EPOCH

isCountryCalculationID

boolean CompanyDeductionFactory::isCountryCalculationID(string $calculation_id)
  • Visibility: public

Arguments

  • $calculation_id string - UUID

isProvinceCalculationID

boolean CompanyDeductionFactory::isProvinceCalculationID(string $calculation_id)
  • Visibility: public

Arguments

  • $calculation_id string - UUID

isDistrictCalculationID

boolean CompanyDeductionFactory::isDistrictCalculationID(string $calculation_id)
  • Visibility: public

Arguments

  • $calculation_id string - UUID

getCombinedCalculationID

boolean|mixed CompanyDeductionFactory::getCombinedCalculationID(string $calculation_id, null $country, null $province)
  • Visibility: public

Arguments

  • $calculation_id string - UUID
  • $country null
  • $province null

getCalculation

integer CompanyDeductionFactory::getCalculation()
  • Visibility: public

setCalculation

boolean CompanyDeductionFactory::setCalculation($value)
  • Visibility: public

Arguments

  • $value mixed

getCalculationOrder

boolean|mixed CompanyDeductionFactory::getCalculationOrder()
  • Visibility: public

setCalculationOrder

boolean CompanyDeductionFactory::setCalculationOrder($value)
  • Visibility: public

Arguments

  • $value mixed

getCountry

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

setCountry

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

Arguments

  • $value mixed

getProvince

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

setProvince

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

Arguments

  • $value mixed

getDistrictName

boolean|mixed|null CompanyDeductionFactory::getDistrictName()
  • Visibility: public

getDistrict

boolean|mixed CompanyDeductionFactory::getDistrict()
  • Visibility: public

setDistrict

boolean CompanyDeductionFactory::setDistrict($value)
  • Visibility: public

Arguments

  • $value mixed

getCompanyValue1

boolean|mixed CompanyDeductionFactory::getCompanyValue1()
  • Visibility: public

setCompanyValue1

boolean CompanyDeductionFactory::setCompanyValue1($value)
  • Visibility: public

Arguments

  • $value mixed

getCompanyValue1Options

boolean CompanyDeductionFactory::getCompanyValue1Options()
  • Visibility: public

getCompanyValue2

boolean|mixed CompanyDeductionFactory::getCompanyValue2()
  • Visibility: public

setCompanyValue2

boolean CompanyDeductionFactory::setCompanyValue2($value)
  • Visibility: public

Arguments

  • $value mixed

getCompanyValue3

boolean|mixed CompanyDeductionFactory::getCompanyValue3()
  • Visibility: public

setCompanyValue3

boolean CompanyDeductionFactory::setCompanyValue3($value)
  • Visibility: public

Arguments

  • $value mixed

getCompanyValue4

boolean|mixed CompanyDeductionFactory::getCompanyValue4()
  • Visibility: public

setCompanyValue4

boolean CompanyDeductionFactory::setCompanyValue4($value)
  • Visibility: public

Arguments

  • $value mixed

getCompanyValue5

boolean|mixed CompanyDeductionFactory::getCompanyValue5()
  • Visibility: public

setCompanyValue5

boolean CompanyDeductionFactory::setCompanyValue5($value)
  • Visibility: public

Arguments

  • $value mixed

getCompanyValue6

boolean|mixed CompanyDeductionFactory::getCompanyValue6()
  • Visibility: public

setCompanyValue6

boolean CompanyDeductionFactory::setCompanyValue6($value)
  • Visibility: public

Arguments

  • $value mixed

getCompanyValue7

boolean|mixed CompanyDeductionFactory::getCompanyValue7()
  • Visibility: public

setCompanyValue7

boolean CompanyDeductionFactory::setCompanyValue7($value)
  • Visibility: public

Arguments

  • $value mixed

getCompanyValue8

boolean|mixed CompanyDeductionFactory::getCompanyValue8()
  • Visibility: public

setCompanyValue8

boolean CompanyDeductionFactory::setCompanyValue8($value)
  • Visibility: public

Arguments

  • $value mixed

getCompanyValue9

boolean|mixed CompanyDeductionFactory::getCompanyValue9()
  • Visibility: public

setCompanyValue9

boolean CompanyDeductionFactory::setCompanyValue9($value)
  • Visibility: public

Arguments

  • $value mixed

getCompanyValue10

boolean|mixed CompanyDeductionFactory::getCompanyValue10()
  • Visibility: public

setCompanyValue10

boolean CompanyDeductionFactory::setCompanyValue10($value)
  • Visibility: public

Arguments

  • $value mixed

getUserValue1

boolean|mixed CompanyDeductionFactory::getUserValue1()
  • Visibility: public

setUserValue1

boolean CompanyDeductionFactory::setUserValue1($value)
  • Visibility: public

Arguments

  • $value mixed

getUserValue2

boolean|mixed CompanyDeductionFactory::getUserValue2()
  • Visibility: public

setUserValue2

boolean CompanyDeductionFactory::setUserValue2($value)
  • Visibility: public

Arguments

  • $value mixed

getUserValue3

boolean|mixed CompanyDeductionFactory::getUserValue3()
  • Visibility: public

setUserValue3

boolean CompanyDeductionFactory::setUserValue3($value)
  • Visibility: public

Arguments

  • $value mixed

getUserValue4

boolean|mixed CompanyDeductionFactory::getUserValue4()
  • Visibility: public

setUserValue4

boolean CompanyDeductionFactory::setUserValue4($value)
  • Visibility: public

Arguments

  • $value mixed

getUserValue5

boolean|mixed CompanyDeductionFactory::getUserValue5()
  • Visibility: public

setUserValue5

boolean CompanyDeductionFactory::setUserValue5($value)
  • Visibility: public

Arguments

  • $value mixed

getUserValue6

boolean|mixed CompanyDeductionFactory::getUserValue6()
  • Visibility: public

setUserValue6

boolean CompanyDeductionFactory::setUserValue6($value)
  • Visibility: public

Arguments

  • $value mixed

getUserValue7

boolean|mixed CompanyDeductionFactory::getUserValue7()
  • Visibility: public

setUserValue7

boolean CompanyDeductionFactory::setUserValue7($value)
  • Visibility: public

Arguments

  • $value mixed

getUserValue8

boolean|mixed CompanyDeductionFactory::getUserValue8()
  • Visibility: public

setUserValue8

boolean CompanyDeductionFactory::setUserValue8($value)
  • Visibility: public

Arguments

  • $value mixed

getUserValue9

boolean|mixed CompanyDeductionFactory::getUserValue9()
  • Visibility: public

setUserValue9

boolean CompanyDeductionFactory::setUserValue9($value)
  • Visibility: public

Arguments

  • $value mixed

getUserValue10

boolean|mixed CompanyDeductionFactory::getUserValue10()
  • Visibility: public

setUserValue10

boolean CompanyDeductionFactory::setUserValue10($value)
  • Visibility: public

Arguments

  • $value mixed

getUserValue1Options

boolean CompanyDeductionFactory::getUserValue1Options()
  • Visibility: public

getPayStubEntryAccount

boolean|mixed CompanyDeductionFactory::getPayStubEntryAccount()
  • Visibility: public

setPayStubEntryAccount

boolean CompanyDeductionFactory::setPayStubEntryAccount($value)
  • Visibility: public

Arguments

  • $value mixed

getLockUserValue1

boolean CompanyDeductionFactory::getLockUserValue1()
  • Visibility: public

setLockUserValue1

boolean CompanyDeductionFactory::setLockUserValue1($value)
  • Visibility: public

Arguments

  • $value mixed

getLockUserValue2

boolean CompanyDeductionFactory::getLockUserValue2()
  • Visibility: public

setLockUserValue2

boolean CompanyDeductionFactory::setLockUserValue2($value)
  • Visibility: public

Arguments

  • $value mixed

getLockUserValue3

boolean CompanyDeductionFactory::getLockUserValue3()
  • Visibility: public

setLockUserValue3

boolean CompanyDeductionFactory::setLockUserValue3($value)
  • Visibility: public

Arguments

  • $value mixed

getLockUserValue4

boolean CompanyDeductionFactory::getLockUserValue4()
  • Visibility: public

setLockUserValue4

boolean CompanyDeductionFactory::setLockUserValue4($value)
  • Visibility: public

Arguments

  • $value mixed

getLockUserValue5

boolean CompanyDeductionFactory::getLockUserValue5()
  • Visibility: public

setLockUserValue5

boolean CompanyDeductionFactory::setLockUserValue5($value)
  • Visibility: public

Arguments

  • $value mixed

getLockUserValue6

boolean CompanyDeductionFactory::getLockUserValue6()
  • Visibility: public

setLockUserValue6

boolean CompanyDeductionFactory::setLockUserValue6($value)
  • Visibility: public

Arguments

  • $value mixed

getLockUserValue7

boolean CompanyDeductionFactory::getLockUserValue7()
  • Visibility: public

setLockUserValue7

boolean CompanyDeductionFactory::setLockUserValue7($value)
  • Visibility: public

Arguments

  • $value mixed

getLockUserValue8

boolean CompanyDeductionFactory::getLockUserValue8()
  • Visibility: public

setLockUserValue8

boolean CompanyDeductionFactory::setLockUserValue8($value)
  • Visibility: public

Arguments

  • $value mixed

getLockUserValue9

boolean CompanyDeductionFactory::getLockUserValue9()
  • Visibility: public

setLockUserValue9

boolean CompanyDeductionFactory::setLockUserValue9($value)
  • Visibility: public

Arguments

  • $value mixed

getLockUserValue10

boolean CompanyDeductionFactory::getLockUserValue10()
  • Visibility: public

setLockUserValue10

boolean CompanyDeductionFactory::setLockUserValue10($value)
  • Visibility: public

Arguments

  • $value mixed

getAccountAmountTypeMap

mixed|string CompanyDeductionFactory::getAccountAmountTypeMap(string $id)
  • Visibility: public

Arguments

  • $id string - UUID

getAccountAmountTypePSEntriesMap

mixed|string CompanyDeductionFactory::getAccountAmountTypePSEntriesMap(string $id)
  • Visibility: public

Arguments

  • $id string - UUID

getIncludeAccountAmountType

boolean|mixed CompanyDeductionFactory::getIncludeAccountAmountType()
  • Visibility: public

setIncludeAccountAmountType

boolean CompanyDeductionFactory::setIncludeAccountAmountType($value)
  • Visibility: public

Arguments

  • $value mixed

getIncludePayStubEntryAccount

array|boolean|mixed|null CompanyDeductionFactory::getIncludePayStubEntryAccount()
  • Visibility: public

setIncludePayStubEntryAccount

boolean CompanyDeductionFactory::setIncludePayStubEntryAccount(string $ids)
  • Visibility: public

Arguments

  • $ids string - UUID

getExcludeAccountAmountType

boolean|mixed CompanyDeductionFactory::getExcludeAccountAmountType()
  • Visibility: public

setExcludeAccountAmountType

boolean CompanyDeductionFactory::setExcludeAccountAmountType($value)
  • Visibility: public

Arguments

  • $value mixed

getExcludePayStubEntryAccount

array|boolean|mixed|null CompanyDeductionFactory::getExcludePayStubEntryAccount()
  • Visibility: public

setExcludePayStubEntryAccount

boolean CompanyDeductionFactory::setExcludePayStubEntryAccount(string $ids)
  • Visibility: public

Arguments

  • $ids string - UUID

getUser

array|boolean CompanyDeductionFactory::getUser()
  • Visibility: public

setUser

boolean CompanyDeductionFactory::setUser(string $ids)
  • Visibility: public

Arguments

  • $ids string - UUID

getTotalUsers

mixed CompanyDeductionFactory::getTotalUsers()
  • Visibility: public

getExpandedPayStubEntryAccountIDs

array CompanyDeductionFactory::getExpandedPayStubEntryAccountIDs(string $ids, boolean $include_net_pay)

Expands Total PS accounts (ie: Total Gross, Total Deduction, Total Employer Contributions, Net Pay) into their individual PS accounts.

  • Visibility: public

Arguments

  • $ids string - UUID
  • $include_net_pay boolean - Check to see if Net Pay PS account is in $ids, and expand all earnings and deductions.

getPayStubEntryAmountSum

boolean|string CompanyDeductionFactory::getPayStubEntryAmountSum(object $pay_stub_obj, string|array $ids, string $ps_entries, string $return_value)
  • Visibility: public

Arguments

  • $pay_stub_obj object
  • $ids string|array - UUID
  • $ps_entries string
  • $return_value string

getCalculationPayStubAmount

boolean|string CompanyDeductionFactory::getCalculationPayStubAmount(object $pay_stub_obj, integer $include_account_amount_type_id, integer $exclude_account_amount_type_id)
  • Visibility: public

Arguments

  • $pay_stub_obj object
  • $include_account_amount_type_id integer - ID
  • $exclude_account_amount_type_id integer - ID

isLookbackCalculation

boolean CompanyDeductionFactory::isLookbackCalculation()
  • Visibility: public

getLookbackCalculationPayStubAmount

integer|string CompanyDeductionFactory::getLookbackCalculationPayStubAmount(integer $include_account_amount_type_id, integer $exclude_account_amount_type_id)
  • Visibility: public

Arguments

  • $include_account_amount_type_id integer - ID
  • $exclude_account_amount_type_id integer - ID

getLookbackStartAndEndDates

array CompanyDeductionFactory::getLookbackStartAndEndDates(object $pay_period_obj)
  • Visibility: public

Arguments

  • $pay_period_obj object

getLookbackPayStubs

array CompanyDeductionFactory::getLookbackPayStubs(string $user_id, object $pay_period_obj)
  • Visibility: public

Arguments

  • $user_id string - UUID
  • $pay_period_obj object

getCalculationYTDAmount

boolean|integer|string CompanyDeductionFactory::getCalculationYTDAmount(object $pay_stub_obj)
  • Visibility: public

Arguments

  • $pay_stub_obj object

getPayStubEntryAccountYTDAmount

boolean|integer|string CompanyDeductionFactory::getPayStubEntryAccountYTDAmount(object $pay_stub_obj)
  • Visibility: public

Arguments

  • $pay_stub_obj object

getJavaScriptArrays

string CompanyDeductionFactory::getJavaScriptArrays()
  • Visibility: public

getPayStubEntryAccountByCompanyIDAndTypeAndFuzzyName

boolean CompanyDeductionFactory::getPayStubEntryAccountByCompanyIDAndTypeAndFuzzyName(string $company_id, integer $type_id, $name)
  • Visibility: public
  • This method is static.

Arguments

  • $company_id string - UUID
  • $type_id integer
  • $name mixed

Validate

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

Arguments

  • $ignore_warning boolean

getPayrollRemittanceAgencyIdByNameOrCalculation

boolean|mixed|string CompanyDeductionFactory::getPayrollRemittanceAgencyIdByNameOrCalculation()
  • Visibility: public

updateCompanyDeductionForTaxYear

boolean CompanyDeductionFactory::updateCompanyDeductionForTaxYear(integer $date)
  • Visibility: public

Arguments

  • $date integer - EPOCH

preSave

boolean CompanyDeductionFactory::preSave()
  • Visibility: public

postSave

boolean CompanyDeductionFactory::postSave()
  • Visibility: public

setObjectFromArray

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

Arguments

  • $data mixed

getObjectAsArray

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

Arguments

  • $include_columns null
  • $permission_children_ids boolean
  • $include_user_id boolean

addLog

boolean CompanyDeductionFactory::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
⚠️ **GitHub.com Fallback** ⚠️