CompanyDeductionFactory - staffcheck/api GitHub Wiki
- Class name: CompanyDeductionFactory
- Namespace:
- Parent class: Factory
protected mixed $table = 'company_deduction'
- Visibility: protected
protected mixed $pk_sequence_name = 'company_deduction_id_seq'
- Visibility: protected
public mixed $company_obj = NULL
- Visibility: public
public mixed $legal_entity_obj = NULL
- Visibility: public
public mixed $payroll_remittance_agency_obj = NULL
- Visibility: public
public mixed $pay_stub_entry_account_link_obj = NULL
- Visibility: public
public mixed $pay_stub_entry_account_obj = NULL
- Visibility: public
public mixed $users = NULL
- Visibility: public
public mixed $lookback_pay_stub_lf = NULL
- Visibility: public
public mixed $country_calculation_ids = array('100', '200', '300')
- Visibility: public
public mixed $province_calculation_ids = array('200', '300')
- Visibility: public
public mixed $district_calculation_ids = array('300')
- Visibility: public
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
protected mixed $length_of_service_multiplier = array(0 => 0, 10 => 1, 20 => 7, 30 => 30.4167, 40 => 365.25, 50 => 0.041666666666666664)
- Visibility: protected
protected mixed $account_amount_type_map = array(10 => 'amount', 20 => 'units', 30 => 'ytd_amount', 40 => 'ytd_units')
- Visibility: protected
protected mixed $account_amount_type_ps_entries_map = array(10 => 'current', 20 => 'current', 30 => 'previous+ytd_adjustment', 40 => 'previous+ytd_adjustment')
- Visibility: protected
public mixed $data = array()
- Visibility: public
public mixed $old_data = array()
- Visibility: public
public mixed $tmp_data = array()
- Visibility: public
protected mixed $enable_system_log_detail = TRUE
- Visibility: protected
protected mixed $progress_bar_obj = NULL
- Visibility: protected
protected mixed $AMF_message_id = NULL
- Visibility: protected
public mixed $Validator = NULL
- Visibility: public
public mixed $validate_only = FALSE
- Visibility: public
private mixed $is_valid = FALSE
- Visibility: private
boolean Factory::_getFactoryOptions(string $name, string|integer $parent)
- Visibility: protected
- This method is defined by Factory
- $name string
- $parent string|integer
boolean Factory::_getVariableToFunctionMap(array $data)
- Visibility: protected
- This method is defined by Factory
- $data array
boolean CompanyDeductionFactory::getCompanyObject()
- Visibility: public
boolean|null CompanyDeductionFactory::getPayStubEntryAccountLinkObject()
- Visibility: public
boolean CompanyDeductionFactory::getPayStubEntryAccountObject()
- Visibility: public
boolean CompanyDeductionFactory::getLengthOfServiceContributingPayCodePolicyObject()
- Visibility: public
boolean CompanyDeductionFactory::getPayrollRemittanceAgencyObject()
- Visibility: public
boolean CompanyDeductionFactory::getLegalEntityObject()
- Visibility: public
boolean|mixed CompanyDeductionFactory::getLegalEntity()
- Visibility: public
boolean CompanyDeductionFactory::setLegalEntity($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getCompany()
- Visibility: public
boolean CompanyDeductionFactory::setCompany($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getPayrollRemittanceAgency()
- Visibility: public
boolean CompanyDeductionFactory::setPayrollRemittanceAgency($value)
- Visibility: public
- $value mixed
integer CompanyDeductionFactory::getStatus()
- Visibility: public
boolean CompanyDeductionFactory::setStatus($value)
- Visibility: public
- $value mixed
integer CompanyDeductionFactory::getType()
- Visibility: public
boolean CompanyDeductionFactory::setType($value)
- Visibility: public
- $value mixed
boolean CompanyDeductionFactory::isUniqueName($name)
- Visibility: public
- $name mixed
boolean|mixed CompanyDeductionFactory::getName()
- Visibility: public
boolean CompanyDeductionFactory::setName($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getDescription()
- Visibility: public
boolean CompanyDeductionFactory::setDescription($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getPayStubEntryDescription()
- Visibility: public
boolean CompanyDeductionFactory::setPayStubEntryDescription($value)
- Visibility: public
- $value mixed
boolean|integer|mixed CompanyDeductionFactory::getStartDate(boolean $raw)
- Visibility: public
- $raw boolean
boolean CompanyDeductionFactory::setStartDate($value)
- Visibility: public
- $value mixed
boolean|integer|mixed CompanyDeductionFactory::getEndDate(boolean $raw)
- Visibility: public
- $raw boolean
boolean CompanyDeductionFactory::setEndDate($value)
- Visibility: public
- $value mixed
boolean CompanyDeductionFactory::isActiveDate(object $ud_obj, integer $pp_end_date, integer $pp_transaction_date)
- Visibility: public
- $ud_obj object
- $pp_end_date integer - EPOCH
- $pp_transaction_date integer - EPOCH
float CompanyDeductionFactory::getMinimumLengthOfServiceDays()
- Visibility: public
boolean CompanyDeductionFactory::setMinimumLengthOfServiceDays($value)
- Visibility: public
- $value mixed
float CompanyDeductionFactory::getMinimumLengthOfService()
- Visibility: public
boolean CompanyDeductionFactory::setMinimumLengthOfService($value)
- Visibility: public
- $value mixed
integer CompanyDeductionFactory::getMinimumLengthOfServiceUnit()
- Visibility: public
boolean CompanyDeductionFactory::setMinimumLengthOfServiceUnit($value)
- Visibility: public
- $value mixed
float CompanyDeductionFactory::getMaximumLengthOfServiceDays()
- Visibility: public
boolean CompanyDeductionFactory::setMaximumLengthOfServiceDays($value)
- Visibility: public
- $value mixed
float CompanyDeductionFactory::getMaximumLengthOfService()
- Visibility: public
boolean CompanyDeductionFactory::setMaximumLengthOfService($value)
- Visibility: public
- $value mixed
integer CompanyDeductionFactory::getMaximumLengthOfServiceUnit()
- Visibility: public
boolean CompanyDeductionFactory::setMaximumLengthOfServiceUnit($value)
- Visibility: public
- $value mixed
float CompanyDeductionFactory::getMinimumUserAge()
- Visibility: public
boolean CompanyDeductionFactory::setMinimumUserAge($value)
- Visibility: public
- $value mixed
float CompanyDeductionFactory::getMaximumUserAge()
- Visibility: public
boolean CompanyDeductionFactory::setMaximumUserAge($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getLengthOfServiceContributingPayCodePolicy()
- Visibility: public
boolean CompanyDeductionFactory::setLengthOfServiceContributingPayCodePolicy($value)
- Visibility: public
- $value mixed
integer CompanyDeductionFactory::getApplyFrequency()
- Visibility: public
boolean CompanyDeductionFactory::setApplyFrequency($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getApplyFrequencyMonth()
- Visibility: public
boolean CompanyDeductionFactory::setApplyFrequencyMonth($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getApplyFrequencyDayOfMonth()
- Visibility: public
boolean CompanyDeductionFactory::setApplyFrequencyDayOfMonth($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getApplyFrequencyDayOfWeek()
- Visibility: public
boolean CompanyDeductionFactory::setApplyFrequencyDayOfWeek($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getApplyFrequencyQuarterMonth()
- Visibility: public
boolean CompanyDeductionFactory::setApplyFrequencyQuarterMonth($value)
- Visibility: public
- $value mixed
integer CompanyDeductionFactory::getApplyPayrollRunType()
- Visibility: public
boolean CompanyDeductionFactory::setApplyPayrollRunType($value)
- Visibility: public
- $value mixed
boolean CompanyDeductionFactory::inApplyFrequencyWindow(integer $pay_period_start_date, integer $pay_period_end_date, integer $hire_date, integer $termination_date, integer $birth_date)
- Visibility: public
- $pay_period_start_date integer - EPOCH
- $pay_period_end_date integer - EPOCH
- $hire_date integer - EPOCH
- $termination_date integer - EPOCH
- $birth_date integer - EPOCH
boolean CompanyDeductionFactory::inApplyPayrollRunType(integer $type_id)
- Visibility: public
- $type_id integer
boolean|integer CompanyDeductionFactory::getWorkedTimeByUserIdAndEndDate(string $user_id, integer $start_date, integer $end_date)
- Visibility: public
- $user_id string - UUID
- $start_date integer - EPOCH
- $end_date integer - EPOCH
boolean CompanyDeductionFactory::isUserLengthOfServiceEligibility()
Check to see if user length of service eligibility criteria are actually specified for this Tax/Deduction record.
- Visibility: public
boolean CompanyDeductionFactory::isActiveLengthOfService(object $ud_obj, integer $epoch, boolean $pay_period_start_date)
- Visibility: public
- $ud_obj object
- $epoch integer - EPOCH
- $pay_period_start_date boolean
boolean CompanyDeductionFactory::isCPPAgeEligible(integer $birth_date, integer $pp_transaction_date)
- Visibility: public
- $birth_date integer - EPOCH
- $pp_transaction_date integer - EPOCH
boolean CompanyDeductionFactory::isUserAgeEligibility()
Check to see if user age eligibility criteria are actually specified for this Tax/Deduction record.
- Visibility: public
boolean CompanyDeductionFactory::isActiveUserAge(integer $birth_date, integer $pp_end_date, integer $pp_transaction_date)
- Visibility: public
- $birth_date integer - EPOCH
- $pp_end_date integer - EPOCH
- $pp_transaction_date integer - EPOCH
boolean CompanyDeductionFactory::isCountryCalculationID(string $calculation_id)
- Visibility: public
- $calculation_id string - UUID
boolean CompanyDeductionFactory::isProvinceCalculationID(string $calculation_id)
- Visibility: public
- $calculation_id string - UUID
boolean CompanyDeductionFactory::isDistrictCalculationID(string $calculation_id)
- Visibility: public
- $calculation_id string - UUID
boolean|mixed CompanyDeductionFactory::getCombinedCalculationID(string $calculation_id, null $country, null $province)
- Visibility: public
- $calculation_id string - UUID
- $country null
- $province null
integer CompanyDeductionFactory::getCalculation()
- Visibility: public
boolean CompanyDeductionFactory::setCalculation($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getCalculationOrder()
- Visibility: public
boolean CompanyDeductionFactory::setCalculationOrder($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getCountry()
- Visibility: public
boolean CompanyDeductionFactory::setCountry($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getProvince()
- Visibility: public
boolean CompanyDeductionFactory::setProvince($value)
- Visibility: public
- $value mixed
boolean|mixed|null CompanyDeductionFactory::getDistrictName()
- Visibility: public
boolean|mixed CompanyDeductionFactory::getDistrict()
- Visibility: public
boolean CompanyDeductionFactory::setDistrict($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getCompanyValue1()
- Visibility: public
boolean CompanyDeductionFactory::setCompanyValue1($value)
- Visibility: public
- $value mixed
boolean CompanyDeductionFactory::getCompanyValue1Options()
- Visibility: public
boolean|mixed CompanyDeductionFactory::getCompanyValue2()
- Visibility: public
boolean CompanyDeductionFactory::setCompanyValue2($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getCompanyValue3()
- Visibility: public
boolean CompanyDeductionFactory::setCompanyValue3($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getCompanyValue4()
- Visibility: public
boolean CompanyDeductionFactory::setCompanyValue4($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getCompanyValue5()
- Visibility: public
boolean CompanyDeductionFactory::setCompanyValue5($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getCompanyValue6()
- Visibility: public
boolean CompanyDeductionFactory::setCompanyValue6($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getCompanyValue7()
- Visibility: public
boolean CompanyDeductionFactory::setCompanyValue7($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getCompanyValue8()
- Visibility: public
boolean CompanyDeductionFactory::setCompanyValue8($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getCompanyValue9()
- Visibility: public
boolean CompanyDeductionFactory::setCompanyValue9($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getCompanyValue10()
- Visibility: public
boolean CompanyDeductionFactory::setCompanyValue10($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getUserValue1()
- Visibility: public
boolean CompanyDeductionFactory::setUserValue1($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getUserValue2()
- Visibility: public
boolean CompanyDeductionFactory::setUserValue2($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getUserValue3()
- Visibility: public
boolean CompanyDeductionFactory::setUserValue3($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getUserValue4()
- Visibility: public
boolean CompanyDeductionFactory::setUserValue4($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getUserValue5()
- Visibility: public
boolean CompanyDeductionFactory::setUserValue5($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getUserValue6()
- Visibility: public
boolean CompanyDeductionFactory::setUserValue6($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getUserValue7()
- Visibility: public
boolean CompanyDeductionFactory::setUserValue7($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getUserValue8()
- Visibility: public
boolean CompanyDeductionFactory::setUserValue8($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getUserValue9()
- Visibility: public
boolean CompanyDeductionFactory::setUserValue9($value)
- Visibility: public
- $value mixed
boolean|mixed CompanyDeductionFactory::getUserValue10()
- Visibility: public
boolean CompanyDeductionFactory::setUserValue10($value)
- Visibility: public
- $value mixed
boolean CompanyDeductionFactory::getUserValue1Options()
- Visibility: public
boolean|mixed CompanyDeductionFactory::getPayStubEntryAccount()
- Visibility: public
boolean CompanyDeductionFactory::setPayStubEntryAccount($value)
- Visibility: public
- $value mixed
boolean CompanyDeductionFactory::getLockUserValue1()
- Visibility: public
boolean CompanyDeductionFactory::setLockUserValue1($value)
- Visibility: public
- $value mixed
boolean CompanyDeductionFactory::getLockUserValue2()
- Visibility: public
boolean CompanyDeductionFactory::setLockUserValue2($value)
- Visibility: public
- $value mixed
boolean CompanyDeductionFactory::getLockUserValue3()
- Visibility: public
boolean CompanyDeductionFactory::setLockUserValue3($value)
- Visibility: public
- $value mixed
boolean CompanyDeductionFactory::getLockUserValue4()
- Visibility: public
boolean CompanyDeductionFactory::setLockUserValue4($value)
- Visibility: public
- $value mixed
boolean CompanyDeductionFactory::getLockUserValue5()
- Visibility: public
boolean CompanyDeductionFactory::setLockUserValue5($value)
- Visibility: public
- $value mixed
boolean CompanyDeductionFactory::getLockUserValue6()
- Visibility: public
boolean CompanyDeductionFactory::setLockUserValue6($value)
- Visibility: public
- $value mixed
boolean CompanyDeductionFactory::getLockUserValue7()
- Visibility: public
boolean CompanyDeductionFactory::setLockUserValue7($value)
- Visibility: public
- $value mixed
boolean CompanyDeductionFactory::getLockUserValue8()
- Visibility: public
boolean CompanyDeductionFactory::setLockUserValue8($value)
- Visibility: public
- $value mixed
boolean CompanyDeductionFactory::getLockUserValue9()
- Visibility: public
boolean CompanyDeductionFactory::setLockUserValue9($value)
- Visibility: public
- $value mixed
boolean CompanyDeductionFactory::getLockUserValue10()
- Visibility: public
boolean CompanyDeductionFactory::setLockUserValue10($value)
- Visibility: public
- $value mixed
mixed|string CompanyDeductionFactory::getAccountAmountTypeMap(string $id)
- Visibility: public
- $id string - UUID
mixed|string CompanyDeductionFactory::getAccountAmountTypePSEntriesMap(string $id)
- Visibility: public
- $id string - UUID
boolean|mixed CompanyDeductionFactory::getIncludeAccountAmountType()
- Visibility: public
boolean CompanyDeductionFactory::setIncludeAccountAmountType($value)
- Visibility: public
- $value mixed
array|boolean|mixed|null CompanyDeductionFactory::getIncludePayStubEntryAccount()
- Visibility: public
boolean CompanyDeductionFactory::setIncludePayStubEntryAccount(string $ids)
- Visibility: public
- $ids string - UUID
boolean|mixed CompanyDeductionFactory::getExcludeAccountAmountType()
- Visibility: public
boolean CompanyDeductionFactory::setExcludeAccountAmountType($value)
- Visibility: public
- $value mixed
array|boolean|mixed|null CompanyDeductionFactory::getExcludePayStubEntryAccount()
- Visibility: public
boolean CompanyDeductionFactory::setExcludePayStubEntryAccount(string $ids)
- Visibility: public
- $ids string - UUID
array|boolean CompanyDeductionFactory::getUser()
- Visibility: public
boolean CompanyDeductionFactory::setUser(string $ids)
- Visibility: public
- $ids string - UUID
mixed CompanyDeductionFactory::getTotalUsers()
- Visibility: public
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
- $ids string - UUID
- $include_net_pay boolean - Check to see if Net Pay PS account is in $ids, and expand all earnings and deductions.
boolean|string CompanyDeductionFactory::getPayStubEntryAmountSum(object $pay_stub_obj, string|array $ids, string $ps_entries, string $return_value)
- Visibility: public
- $pay_stub_obj object
- $ids string|array - UUID
- $ps_entries string
- $return_value string
boolean|string CompanyDeductionFactory::getCalculationPayStubAmount(object $pay_stub_obj, integer $include_account_amount_type_id, integer $exclude_account_amount_type_id)
- Visibility: public
- $pay_stub_obj object
- $include_account_amount_type_id integer - ID
- $exclude_account_amount_type_id integer - ID
boolean CompanyDeductionFactory::isLookbackCalculation()
- Visibility: public
integer|string CompanyDeductionFactory::getLookbackCalculationPayStubAmount(integer $include_account_amount_type_id, integer $exclude_account_amount_type_id)
- Visibility: public
- $include_account_amount_type_id integer - ID
- $exclude_account_amount_type_id integer - ID
array CompanyDeductionFactory::getLookbackStartAndEndDates(object $pay_period_obj)
- Visibility: public
- $pay_period_obj object
array CompanyDeductionFactory::getLookbackPayStubs(string $user_id, object $pay_period_obj)
- Visibility: public
- $user_id string - UUID
- $pay_period_obj object
boolean|integer|string CompanyDeductionFactory::getCalculationYTDAmount(object $pay_stub_obj)
- Visibility: public
- $pay_stub_obj object
boolean|integer|string CompanyDeductionFactory::getPayStubEntryAccountYTDAmount(object $pay_stub_obj)
- Visibility: public
- $pay_stub_obj object
string CompanyDeductionFactory::getJavaScriptArrays()
- Visibility: public
boolean CompanyDeductionFactory::getPayStubEntryAccountByCompanyIDAndTypeAndFuzzyName(string $company_id, integer $type_id, $name)
- Visibility: public
- This method is static.
- $company_id string - UUID
- $type_id integer
- $name mixed
boolean CompanyDeductionFactory::Validate(boolean $ignore_warning)
- Visibility: public
- $ignore_warning boolean
boolean|mixed|string CompanyDeductionFactory::getPayrollRemittanceAgencyIdByNameOrCalculation()
- Visibility: public
boolean CompanyDeductionFactory::updateCompanyDeductionForTaxYear(integer $date)
- Visibility: public
- $date integer - EPOCH
boolean CompanyDeductionFactory::preSave()
- Visibility: public
boolean CompanyDeductionFactory::postSave()
- Visibility: public
boolean CompanyDeductionFactory::setObjectFromArray($data)
- Visibility: public
- $data mixed
array CompanyDeductionFactory::getObjectAsArray(null $include_columns, boolean $permission_children_ids, boolean $include_user_id)
- Visibility: public
- $include_columns null
- $permission_children_ids boolean
- $include_user_id boolean
boolean CompanyDeductionFactory::addLog($log_action)
- Visibility: public
- $log_action mixed
mixed Factory::__construct()
Factory constructor.
- Visibility: public
- This method is defined by Factory
boolean|null Factory::getAMFMessageID()
Used for updating progress bar for API calls.
- Visibility: public
- This method is defined by Factory
boolean Factory::setAMFMessageID(string $id)
- Visibility: public
- This method is defined by Factory
- $id string - UUID
boolean Factory::setProgressBarObject(object $obj)
- Visibility: public
- This method is defined by Factory
- $obj object
null|\ProgressBar Factory::getProgressBarObject()
- Visibility: public
- This method is defined by Factory
boolean Factory::setGenericObject(object $obj, string $variable)
- Visibility: public
- This method is defined by Factory
- $obj object
- $variable string
boolean Factory::getGenericObject(string $list_factory, string|integer $id, string $variable, string $list_factory_method, string $id_method)
Generic function to return and cache class objects ListFactory, ListFactoryMethod, Variable, ID, IDMethod
- Visibility: public
- This method is defined by Factory
- $list_factory string
- $id string|integer - UUID
- $variable string
- $list_factory_method string
- $id_method string
mixed Factory::getCompanyGenericMapData(string $company_id, integer $object_type_id, string $id, string $variable)
- Visibility: public
- This method is defined by Factory
- $company_id string - UUID
- $object_type_id integer
- $id string - UUID
- $variable string
boolean|mixed Factory::getGenericDataValue(string $name, $cast)
- Visibility: public
- This method is defined by Factory
- $name string
- $cast mixed
boolean Factory::setGenericDataValue(string $name, mixed $data, $cast)
- Visibility: public
- This method is defined by Factory
- $name string
- $data mixed
- $cast mixed
mixed Factory::castGenericDataValue($value, $cast)
Generic casting function that all set/get*() functions should pass through.
However for now lets wait until we have meta data from SQL schema so we can pass those datatypes directly into this.
- Visibility: public
- This method is defined by Factory
- $value mixed - mixed
- $cast mixed - string
boolean Factory::getGenericTempDataValue(string $name)
- Visibility: public
- This method is defined by Factory
- $name string
boolean Factory::setGenericTempDataValue(string $name, mixed $data)
- Visibility: public
- This method is defined by Factory
- $name string
- $data mixed
boolean|mixed Factory::getGenericOldDataValue(string $name)
- Visibility: public
- This method is defined by Factory
- $name string - Gets data value from old_data array, or the original value in the database, prior to any changes currently in memory.
boolean|mixed Factory::getCache(string $cache_id, string $group_id)
- Visibility: public
- This method is defined by Factory
- $cache_id string
- $group_id string
boolean Factory::saveCache(mixed $data, string $cache_id, string $group_id)
- Visibility: public
- This method is defined by Factory
- $data mixed
- $cache_id string
- $group_id string
boolean Factory::removeCache(string $cache_id, string $group_id)
- Visibility: public
- This method is defined by Factory
- $cache_id string
- $group_id string
boolean Factory::setCacheLifeTime(integer $secs)
- Visibility: public
- This method is defined by Factory
- $secs integer
string Factory::serializeRS(object $rs)
- Visibility: public
- This method is defined by Factory
- $rs object
mixed Factory::unserializeRS(string $rs)
- Visibility: public
- This method is defined by Factory
- $rs string
boolean|string Factory::getTable(boolean $strip_quotes)
- Visibility: public
- This method is defined by Factory
- $strip_quotes boolean
boolean|mixed Factory::getColumn(string $column)
- Visibility: public
- This method is defined by Factory
- $column string
boolean|string Factory::__toString()
- Visibility: public
- This method is defined by Factory
integer Factory::toBool(string|integer|boolean $value)
- Visibility: public
- This method is defined by Factory
- $value string|integer|boolean
boolean Factory::fromBool(string|integer|boolean $value)
- Visibility: public
- This method is defined by Factory
- $value string|integer|boolean
boolean Factory::isNew(boolean $force_lookup, string $id)
Determines if the data is new data, or updated data. Basically determines if a database INSERT or UPDATE SQL statement is generated.
- Visibility: public
- This method is defined by Factory
- $force_lookup boolean
- $id string - UUID
boolean|mixed|string Factory::getLabelId()
- Visibility: public
- This method is defined by Factory
boolean|mixed Factory::getId()
- Visibility: public
- This method is defined by Factory
boolean Factory::setId(string $id)
- Visibility: public
- This method is defined by Factory
- $id string - UUID
boolean Factory::getEnableSystemLogDetail()
- Visibility: public
- This method is defined by Factory
boolean Factory::setEnableSystemLogDetail($bool)
- Visibility: public
- This method is defined by Factory
- $bool mixed
boolean Factory::getDeleted()
- Visibility: public
- This method is defined by Factory
boolean Factory::setDeleted(boolean $bool)
- Visibility: public
- This method is defined by Factory
- $bool boolean
integer Factory::getCreatedDate()
- Visibility: public
- This method is defined by Factory
boolean Factory::setCreatedDate(integer $epoch)
- Visibility: public
- This method is defined by Factory
- $epoch integer - EPOCH
boolean|mixed Factory::getCreatedBy()
- Visibility: public
- This method is defined by Factory
boolean Factory::setCreatedBy(string $id)
- Visibility: public
- This method is defined by Factory
- $id string - UUID
integer Factory::getUpdatedDate()
- Visibility: public
- This method is defined by Factory
boolean|integer|null|string Factory::setUpdatedDate(integer $epoch)
- Visibility: public
- This method is defined by Factory
- $epoch integer - EPOCH
boolean|mixed Factory::getUpdatedBy()
- Visibility: public
- This method is defined by Factory
boolean|null Factory::setUpdatedBy(string $id)
- Visibility: public
- This method is defined by Factory
- $id string - UUID
boolean|mixed Factory::getDeletedDate()
- Visibility: public
- This method is defined by Factory
boolean Factory::setDeletedDate(integer $epoch)
- Visibility: public
- This method is defined by Factory
- $epoch integer - EPOCH
boolean|mixed Factory::getDeletedBy()
- Visibility: public
- This method is defined by Factory
boolean|null Factory::setDeletedBy(string $id)
- Visibility: public
- This method is defined by Factory
- $id string - UUID
boolean Factory::setIsValid(boolean $is_valid)
Sets the is_valid flag, mostly used to set it to FALSE to force a full re-validation.
Required because $this->is_valid is a private variable and should stay that way.
- Visibility: public
- This method is defined by Factory
- $is_valid boolean
boolean Factory::setCreatedAndUpdatedColumns(array $data, array $variable_to_function_map)
- Visibility: public
- This method is defined by Factory
- $data array
- $variable_to_function_map array
boolean Factory::getCreatedAndUpdatedColumns(array $data, null $include_columns)
- Visibility: public
- This method is defined by Factory
- $data array
- $include_columns null
boolean Factory::getPermissionColumns(array $data, string $object_user_id, string $created_by_id, string $permission_children_ids, array $include_columns)
- Visibility: public
- This method is defined by Factory
- $data array
- $object_user_id string - UUID
- $created_by_id string - UUID
- $permission_children_ids string - UUID
- $include_columns array
array|boolean Factory::getOptions(string $name, string|integer $parent)
- Visibility: public
- This method is defined by Factory
- $name string
- $parent string|integer
array|boolean Factory::getVariableToFunctionMap(array $data)
- Visibility: public
- This method is defined by Factory
- $data array
integer|boolean Factory::getRecordCount()
- Visibility: public
- This method is defined by Factory
integer|boolean Factory::getCurrentRow(integer $offset)
- Visibility: public
- This method is defined by Factory
- $offset integer
boolean Factory::setQueryStatementTimeout(null $milliseconds)
- Visibility: public
- This method is defined by Factory
- $milliseconds null
array|boolean Factory::getRecordSetColumnList(object $rs)
- Visibility: private
- This method is defined by Factory
- $rs object
boolean|integer|string Factory::castInteger(integer|string $int, string $type)
- Visibility: protected
- This method is defined by Factory
- $int integer|string
- $type string
boolean|integer|string|array Factory::getListSQL(array|string|integer $array, array $ph, string|boolean $cast)
- Visibility: protected
- This method is defined by Factory
- $array array|string|integer
- $ph array
- $cast string|boolean
boolean|string Factory::getDateRangeSQL(string $str, string $column, string $format, boolean $include_blank_dates)
- Visibility: public
- This method is defined by Factory
- $str string
- $column string
- $format string
- $include_blank_dates boolean
string Factory::handleSQLSyntax(string $arg)
SQL where clause Syntax: or % as wildcard.
"" as exact match, no default wildcard and no metaphone
Handles '*' and '%' as wildcards, defaults to wildcard on the end always. If no wildcard is to be added, the last character should be |
- Visibility: protected
- This method is defined by Factory
- $arg string
mixed Factory::stripSQLSyntax(string $arg)
- Visibility: protected
- This method is defined by Factory
- $arg string
string Factory::getSQLToTimeStampFunction()
- Visibility: protected
- This method is defined by Factory
string Factory::getDatabaseType()
- Visibility: protected
- This method is defined by Factory
string Factory::getGEOMAsTextFunction(string $sql)
- Visibility: protected
- This method is defined by Factory
- $sql string
string Factory::getSQLToEpochFunction(string $sql)
- Visibility: protected
- This method is defined by Factory
- $sql string
string Factory::getSQLToTimeFunction(string $sql)
- Visibility: protected
- This method is defined by Factory
- $sql string
string Factory::getSQLStringAggregate(string $sql, string $glue)
- Visibility: protected
- This method is defined by Factory
- $sql string
- $glue string
null|string Factory::getWhereClauseSQL(array|string $columns, array|string $args, string $type, array $ph, string $query_stub, boolean $and)
- Visibility: protected
- This method is defined by Factory
- $columns array|string
- $args array|string
- $type string
- $ph array
- $query_stub string
- $and boolean
boolean|string Factory::parseColumnName(string $column)
- Visibility: private
- This method is defined by Factory
- $column string
boolean|string Factory::getWhereSQL(array $array, boolean $append_where)
- Visibility: protected
- This method is defined by Factory
- $array array
- $append_where boolean
array Factory::getColumnsFromAliases(array $columns, array $aliases)
- Visibility: protected
- This method is defined by Factory
- $columns array
- $aliases array
array Factory::convertFlexArray(array $array)
- Visibility: public
- This method is defined by Factory
- $array array
array Factory::getValidSQLColumns(array $array, boolean $strict, array $additional_fields)
- Visibility: public
- This method is defined by Factory
- $array array
- $strict boolean
- $additional_fields array
boolean|string Factory::getSortSQL(array $array, boolean $strict, array $additional_fields)
- Visibility: protected
- This method is defined by Factory
- $array array
- $strict boolean
- $additional_fields array
array|boolean Factory::getColumnList()
- Visibility: public
- This method is defined by Factory
mixed Factory::getEmptyRecordSet(string $id)
- Visibility: public
- This method is defined by Factory
- $id string - UUID
boolean Factory::getUpdateQuery()
- Visibility: private
- This method is defined by Factory
mixed Factory::getInsertQuery()
- Visibility: private
- This method is defined by Factory
mixed Factory::StartTransaction()
- Visibility: public
- This method is defined by Factory
mixed Factory::FailTransaction()
- Visibility: public
- This method is defined by Factory
mixed Factory::CommitTransaction()
- Visibility: public
- This method is defined by Factory
mixed Factory::setTransactionMode(string $mode)
- Visibility: public
- This method is defined by Factory
- $mode string
string Factory::getTransactionMode()
- Visibility: public
- This method is defined by Factory
boolean Factory::isValid(boolean $ignore_warning)
- Visibility: public
- This method is defined by Factory
- $ignore_warning boolean
boolean Factory::isWarning()
- Visibility: public
- This method is defined by Factory
boolean Factory::getSequenceName()
- Visibility: public
- This method is defined by Factory
boolean|string Factory::getNextInsertId()
- Visibility: public
- This method is defined by Factory
boolean Factory::ExecuteSQL(string $query, array $ph, integer $limit, integer $page)
- Visibility: public
- This method is defined by Factory
- $query string
- $ph array
- $limit integer - Limit the number of records returned
- $page integer - Page number of records to return for pagination
boolean Factory::RetryExecuteSQL(string $query, array $ph, integer $retry_max_attempts, integer $sleep)
- Visibility: public
- This method is defined by Factory
- $query string
- $ph array
- $retry_max_attempts integer
- $sleep integer
array Factory::getDataDifferences()
Returns the differences in data from the DB vs the in-memory object, so the data will be the OLD data. Used in Validation/postSave() functions to determine if a field has changed or not.
- Visibility: public
- This method is defined by Factory
boolean Factory::isDataDifferent($key, $data_diff, null $type_id, null $new_data)
Used to check the differences between a single key in the $old_data vs. $data arrays.
This is especially important to use when trying to see if a date or timestamp field in the DB has changed, as they need to be handled in special ways.
- Visibility: public
- This method is defined by Factory
- $key mixed - string
- $data_diff mixed - array
- $type_id null - string
- $new_data null - mixed
boolean|integer|string Factory::Save(boolean $reset_data, boolean $force_lookup)
- Visibility: public
- This method is defined by Factory
- $reset_data boolean
- $force_lookup boolean
boolean Factory::Delete()
- Visibility: public
- This method is defined by Factory
array|boolean Factory::getIDSByListFactory(object $lf)
- Visibility: public
- This method is defined by Factory
- $lf object
boolean Factory::bulkDelete(string|array $ids)
- Visibility: public
- This method is defined by Factory
- $ids string|array - UUID
boolean Factory::clearGeoCode(array $data_diff)
- Visibility: public
- This method is defined by Factory
- $data_diff array
array|null Factory::clearNonMappedData(array|null $data)
Removes array elements from $data that are not in the function map.
- Visibility: public
- This method is defined by Factory
- $data array|null
boolean Factory::clearData()
- Visibility: public
- This method is defined by Factory
boolean Factory::clearOldData()
- Visibility: public
- This method is defined by Factory
\FactoryListIterator Factory::getIterator()
- Visibility: public
- This method is defined by Factory
mixed Factory::getCurrent()
- Visibility: public
- This method is defined by Factory