CompanyDeductionFactory
extends Factory
in package
Table of Contents
- $cache : Cache_Lite_Function|Cache_Lite_Output
- $calculation_id_fields : mixed
- $company_obj : mixed
- $country_calculation_ids : mixed
- $data : mixed
- $db : mixed
- $district_calculation_ids : mixed
- $is_new : mixed
- $legal_entity_obj : mixed
- $lookback_pay_stub_lf : mixed
- $old_data : mixed
- $pay_stub_entry_account_link_obj : mixed
- $pay_stub_entry_account_obj : mixed
- $payroll_remittance_agency_obj : mixed
- $province_calculation_ids : mixed
- $rs : mixed
- $tmp_data : mixed
- $users : mixed
- $validate_only : mixed
- $Validator : mixed
- $account_amount_type_map : mixed
- $account_amount_type_ps_entries_map : mixed
- $api_message_id : mixed
- $enable_system_log_detail : mixed
- $length_of_service_multiplier : mixed
- $pk_sequence_name : mixed
- $progress_bar_obj : mixed
- $table : mixed
- $ignore_column_list : bool
- $is_valid : mixed
- __construct() : mixed
- Factory constructor.
- __toString() : bool|string
- Print primary columns from object.
- _getFactoryOptions() : array<string|int, mixed>|null
- _getVariableToFunctionMap() : array<string|int, mixed>
- addLog() : bool
- bulkDelete() : bool
- castGenericDataValue() : mixed
- Generic casting function that all set/get*() functions should pass through.
- clearCacheSavedInTransaction() : bool
- clearData() : bool
- clearGeoCode() : bool
- clearNonMappedData() : array<string|int, mixed>|null
- Removes array elements from $data that are not in the function map.
- clearOldData() : bool
- CommitSavePoint() : bool
- CommitTransaction() : mixed
- convertFlexArray() : array<string|int, mixed>
- decodeCustomFields() : bool
- decodeGenericJSONData() : bool
- Decode generic 'other_json' column data.
- decodeJSONColumn() : bool
- Decodes JSON columns that are not the 'other_json' column.
- Delete() : bool
- Deletes the record directly from the database.
- encodeCustomFields() : bool
- encodeGenericJSONData() : bool
- Encode generic 'other_json' column data. This should only be done in Save() after all validation has occurred already and we are just about to commit it to the DB.
- encodeJSONColumns() : bool
- Encode any JSON columns that are not 'other_json' column. This should only be done in Save() after all validation has occurred already and we are just about to commit it to the DB.
- ExecuteSQL() : bool
- Execute SQL queries and handle paging properly for select statements.
- FailTransaction() : mixed
- fromBool() : bool
- fromJSONBool() : bool
- getAccountAmountTypeMap() : mixed|string
- getAccountAmountTypePSEntriesMap() : mixed|string
- getAffectedRows() : int|bool
- getAPIMessageID() : bool|null
- Used for updating progress bar for API calls.
- getApplyFrequency() : int
- getApplyFrequencyDayOfMonth() : bool|mixed
- getApplyFrequencyDayOfMonth1() : bool|mixed
- getApplyFrequencyDayOfMonth2() : bool|mixed
- getApplyFrequencyDayOfWeek() : bool|mixed
- getApplyFrequencyMonth() : bool|mixed
- getApplyFrequencyQuarterMonth() : bool|mixed
- getApplyPayrollRunType() : int
- getCache() : bool|mixed
- getCalculation() : int
- getCalculationOrder() : bool|mixed
- getCalculationPayStubAmount() : bool|string
- getCalculationYTDAmount() : bool|int|string
- getColumn() : bool|mixed
- Generic function get any data from the data array.
- getColumnList() : array<string|int, mixed>|bool
- getCombinedCalculationID() : bool|mixed
- getCompany() : bool|mixed
- getCompanyGenericMapData() : mixed
- Generic function to return and cache CompanyGenericMap data, this greatly improves performance of CalculatePolicy when many policies exist.
- getCompanyObject() : bool
- getCompanyValue1() : bool|mixed
- getCompanyValue10() : bool|mixed
- getCompanyValue1Options() : bool
- getCompanyValue2() : bool|mixed
- getCompanyValue3() : bool|mixed
- getCompanyValue4() : bool|mixed
- getCompanyValue5() : bool|mixed
- getCompanyValue6() : bool|mixed
- getCompanyValue7() : bool|mixed
- getCompanyValue8() : bool|mixed
- getCompanyValue9() : bool|mixed
- getCountry() : bool|mixed
- getCreatedAndUpdatedColumns() : bool
- getCreatedBy() : bool|mixed
- getCreatedDate() : int
- getCurrent() : mixed
- Grabs the current object
- getCurrentRow() : int|bool
- getCustomField() : void
- Get a single custom field by ID.
- getCustomFields() : mixed
- getCustomFieldsColumns() : array<string|int, mixed>
- getCustomFieldsDataForObject() : array<string|int, mixed>
- Get custom field data for this specific object, so it can be easily cached in memory without having to go to the database or unserialize it from cache for every row.
- getCustomFieldsDefaultData() : mixed
- getCustomFieldsParseHints() : array<string|int, mixed>
- getCustomFieldTableName() : string
- getDataDifferences() : array<string|int, mixed>
- 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.
- getDateRangeSQL() : bool|string
- This function takes plain input from the user and creates a SQL statement for filtering based on a date range.
- getDeleted() : bool
- getDeletedBy() : bool|mixed
- getDeletedDate() : bool|mixed
- getDescription() : bool|mixed
- getDistrict() : bool|mixed
- getDistrictName() : bool|mixed|null
- Used for getting district name on W2's
- getEmptyRecordSet() : mixed
- getEnableSystemLogDetail() : bool
- getEndDate() : bool|int|mixed
- getExcludeAccountAmountType() : bool|mixed
- getExcludePayStubEntryAccount() : array<string|int, mixed>|bool|mixed|null
- getExpandedPayStubEntryAccountIDs() : array<string|int, mixed>
- Expands Total PS accounts (ie: Total Gross, Total Deduction, Total Employer Contributions, Net Pay) into their individual PS accounts.
- getFormulaPayStubAccounts() : mixed
- Parse the formula and pull out any pay stub accounts that should be considered "required" accounts for purposes of determing the calculation order.
- getGenericDataValue() : bool|mixed
- Generic getter/setter functions that should be used when Validation code is moved from get/set functions to Validate() function.
- getGenericJSONDataValue() : bool|mixed
- Generic getter/setter functions for handling generic JSON data in 'other_json' SQL column.
- getGenericObject() : object|bool
- Generic function to return and cache class objects ListFactory, ListFactoryMethod, Variable, ID, IDMethod
- getGenericOldDataValue() : bool|mixed
- getGenericTempDataValue() : bool
- Generic getter/setter functions that should be used when Validation code is moved from get/set functions to Validate() function.
- getId() : bool|mixed
- getIDSByListFactory() : array<string|int, mixed>|bool
- getIncludeAccountAmountType() : bool|mixed
- getIncludePayStubEntryAccount() : array<string|int, mixed>|bool|mixed|null
- getIterator() : FactoryListIterator
- getJavaScriptArrays() : string
- getLabelId() : bool|mixed|string
- getLegalEntity() : bool|mixed
- getLegalEntityObject() : bool
- getLengthOfServiceContributingPayCodePolicy() : bool|mixed
- getLengthOfServiceContributingPayCodePolicyObject() : bool
- getLockUserValue1() : bool
- getLockUserValue10() : bool
- getLockUserValue2() : bool
- getLockUserValue3() : bool
- getLockUserValue4() : bool
- getLockUserValue5() : bool
- getLockUserValue6() : bool
- getLockUserValue7() : bool
- getLockUserValue8() : bool
- getLockUserValue9() : bool
- getLookbackCalculationPayStubAmount() : int|string
- getLookbackPayStubs() : array<string|int, mixed>
- getLookbackStartAndEndDates() : array<string|int, mixed>
- Handle look back period, which is always based on the transaction date *before* the current pay periods transaction date.
- getMaximumLengthOfService() : float
- getMaximumLengthOfServiceDays() : float
- getMaximumLengthOfServiceUnit() : int
- getMaximumUserAge() : float
- getMinimumLengthOfService() : float
- getMinimumLengthOfServiceDays() : float
- getMinimumLengthOfServiceUnit() : int
- getMinimumUserAge() : float
- getName() : bool|mixed
- getNextInsertId() : bool|string
- getObjectAsArray() : array<string|int, mixed>
- getOptions() : array<string|int, mixed>|bool
- getPayrollRemittanceAgency() : bool|mixed
- getPayrollRemittanceAgencyIdByNameOrCalculation() : bool|mixed|string
- getPayrollRemittanceAgencyObject() : bool
- getPayStubEntryAccount() : bool|mixed
- getPayStubEntryAccountByCompanyIDAndTypeAndFuzzyName() : bool
- getPayStubEntryAccountLinkObject() : bool|null
- getPayStubEntryAccountObject() : bool
- getPayStubEntryAccountYTDAmount() : bool|int|string
- getPayStubEntryAmountSum() : bool|string
- getPayStubEntryDescription() : bool|mixed
- getPermissionColumns() : bool
- getProgressBarObject() : null|ProgressBar
- getProvince() : bool|mixed
- getRecordCount() : int|bool
- getSequenceName() : bool
- getStartDate() : bool|int|mixed
- getStatus() : int
- getTable() : bool|string
- getTotalUsers() : mixed
- getTransactionMode() : string
- getType() : int
- getUpdatedBy() : bool|mixed
- getUpdatedDate() : int
- getUser() : array<string|int, mixed>|bool
- getUserValue1() : bool|mixed
- getUserValue10() : bool|mixed
- getUserValue1Options() : bool
- getUserValue2() : bool|mixed
- getUserValue3() : bool|mixed
- getUserValue4() : bool|mixed
- getUserValue5() : bool|mixed
- getUserValue6() : bool|mixed
- getUserValue7() : bool|mixed
- getUserValue8() : bool|mixed
- getUserValue9() : bool|mixed
- getValidSQLColumns() : array<string|int, mixed>
- getVariableToFunctionMap() : array<string|int, mixed>|bool
- getWorkedTimeByUserIdAndEndDate() : bool|int
- handleSaveSQLReturning() : bool
- Used to handle any "RETURNING ..." clause on a SQL INSERT/UPDATE query.
- hasDataChanged() : bool
- Determine if the record data has changed at all.
- inApplyFrequencyWindow() : bool
- inApplyPayrollRunType() : bool
- isActiveDate() : bool
- Check if this date is within the effective date range
- isActiveLengthOfService() : bool
- isActiveUserAge() : bool
- isClientFriendly() : bool
- Check if the remote client is our main UI app controlled by us, vs. a user utilizing the API for example.
- isCountryCalculationID() : bool
- isCPPAgeEligible() : bool
- isDataDifferent() : bool
- Used to check the differences between a single key in the $old_data vs. $data arrays.
- isDistrictCalculationID() : bool
- isLookbackCalculation() : bool
- isNew() : bool
- Determines if the data is new data, or updated data. Basically determines if a database INSERT or UPDATE SQL statement is generated.
- isProvinceCalculationID() : bool
- isSQLExceptionRetryable() : bool
- Determines if a SQL exception is one that can be retried or not.
- isUniqueName() : bool
- isUserAgeEligibility() : bool
- Check to see if user age eligibility criteria are actually specified for this Tax/Deduction record.
- isUserLengthOfServiceEligibility() : bool
- Check to see if user length of service eligibility criteria are actually specified for this Tax/Deduction record.
- isValid() : bool
- Call class specific validation function just before saving.
- isWarning() : bool
- Call class specific validation function just before saving.
- modifyInsertQuery() : mixed
- Modifies the automatically generated SQL INSERT query for adding things like " ON CONFLICT ..."
- parseCustomFieldsFromArray() : mixed
- parseUserValues() : mixed
- Parse user values coming directly from the user, for handling things like parseFloat() which can be different for each calculation.
- postSave() : bool
- preSave() : bool
- removeCache() : bool
- RetryTransaction() : mixed
- Accepts a Closure and is retried at set intervals which should be in a transaction.
- rewind() : bool
- Rewinds record set iterator to begining. The same as ADODB's MoveFirst() function.
- RollbackSavePoint() : bool
- Save() : bool|int|string
- Determines to insert or update, and does it.
- saveCache() : bool
- serializeRS() : string
- Serialize ADODB recordset.
- setAPIMessageID() : bool
- setApplyFrequency() : bool
- setApplyFrequencyDayOfMonth() : bool
- setApplyFrequencyDayOfWeek() : bool
- setApplyFrequencyMonth() : bool
- setApplyFrequencyQuarterMonth() : bool
- setApplyPayrollRunType() : bool
- setCacheLifeTime() : bool
- setCalculation() : bool
- setCalculationOrder() : bool
- setCompany() : bool
- setCompanyValue1() : bool
- setCompanyValue10() : bool
- setCompanyValue2() : bool
- setCompanyValue3() : bool
- setCompanyValue4() : bool
- setCompanyValue5() : bool
- setCompanyValue6() : bool
- setCompanyValue7() : bool
- setCompanyValue8() : bool
- setCompanyValue9() : bool
- setCountry() : bool
- setCreatedAndUpdatedColumns() : bool
- setCreatedBy() : bool
- setCreatedDate() : bool
- setCustomField() : void
- Set a single custom field by ID.
- setCustomFields() : bool
- setDeleted() : bool
- setDeletedBy() : bool|null
- setDeletedDate() : bool
- setDescription() : bool
- setDistrict() : bool
- setEnableSystemLogDetail() : bool
- setEndDate() : bool
- setExcludeAccountAmountType() : bool
- setExcludePayStubEntryAccount() : bool
- setGenericDataValue() : bool
- setGenericJSONDataValue() : bool
- Generic getter/setter functions for handling generic JSON data in 'other_json' SQL column.
- setGenericObject() : bool
- Allow method to pre-populate/overwrite the cache if needed.
- setGenericTempDataValue() : bool
- setId() : bool
- setIncludeAccountAmountType() : bool
- setIncludePayStubEntryAccount() : bool
- setIsValid() : bool
- Sets the is_valid flag, mostly used to set it to FALSE to force a full re-validation.
- setLegalEntity() : bool
- setLengthOfServiceContributingPayCodePolicy() : bool
- setLockUserValue1() : bool
- setLockUserValue10() : bool
- setLockUserValue2() : bool
- setLockUserValue3() : bool
- setLockUserValue4() : bool
- setLockUserValue5() : bool
- setLockUserValue6() : bool
- setLockUserValue7() : bool
- setLockUserValue8() : bool
- setLockUserValue9() : bool
- setMaximumLengthOfService() : bool
- setMaximumLengthOfServiceDays() : bool
- setMaximumLengthOfServiceUnit() : bool
- setMaximumUserAge() : bool
- setMinimumLengthOfService() : bool
- setMinimumLengthOfServiceDays() : bool
- setMinimumLengthOfServiceUnit() : bool
- setMinimumUserAge() : bool
- setName() : bool
- setObjectFromArray() : bool
- setPayrollRemittanceAgency() : bool
- setPayStubEntryAccount() : bool
- setPayStubEntryDescription() : bool
- setProgressBarObject() : bool
- setProvince() : bool
- setQueryStatementTimeout() : bool
- setStartDate() : bool
- setStatus() : bool
- setTransactionMode() : mixed
- setType() : bool
- setUpdatedBy() : bool|null
- setUpdatedDate() : bool|int|null|string
- setUser() : bool
- setUserValue1() : bool
- setUserValue10() : bool
- setUserValue2() : bool
- setUserValue3() : bool
- setUserValue4() : bool
- setUserValue5() : bool
- setUserValue6() : bool
- setUserValue7() : bool
- setUserValue8() : bool
- setUserValue9() : bool
- StartSavePoint() : bool
- StartTransaction() : mixed
- toBool() : int
- toJSONBool() : string
- updateCompanyDeductionForTaxYear() : bool
- Validate() : bool
- validateCustomFields() : mixed
- castInteger() : bool|int|string
- getColumnsFromAliases() : array<string|int, mixed>
- getCustomFieldWhereSQL() : string
- getDatabaseType() : string
- getListSQL() : bool|int|string|array<string|int, mixed>
- getSortSQL() : bool|string
- getSQLStringAggregate() : string
- getSQLToEpochFunction() : string
- getSQLToTimeFunction() : string
- getSQLToTimeStampFunction() : string
- getWhereClauseSQL() : null|string
- getWhereSQL() : bool|string
- handleSQLSyntax() : string
- SQL where clause Syntax: or % as wildcard.
- stripSQLSyntax() : mixed
- getInsertQuery() : mixed
- getRecordSetColumnList() : array<string|int, mixed>|bool
- getUpdateQuery() : bool
- parseColumnName() : bool|string
- Parses out the exact column name, without any aliases, or = signs in it.
Properties
$cache
public
Cache_Lite_Function|Cache_Lite_Output
$cache
= \null
$calculation_id_fields
public
mixed
$calculation_id_fields
= [
'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',
'89' => '89',
'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-LA' => '200-US-LA',
'200-US-ME' => '200-US-ME',
'200-US-MD' => '200-US-MD',
//Has district taxes too
'200-US-MA' => '200-US-MA',
'200-US-MI' => '200-US-OH',
'200-US-MN' => '200-US-WI',
'200-US-MS' => '200-US-MS',
'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-NM',
//Single, Married, HoH
'200-US-NJ' => '200-US-NJ',
'200-US-NY' => '200-US-WI',
//Just Single/Married are options
'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' => '',
'210' => '210',
'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',
]
$company_obj
public
mixed
$company_obj
= \null
$country_calculation_ids
public
mixed
$country_calculation_ids
= ['100', '200', '210', '300']
$data
public
mixed
$data
= []
$db
public
mixed
$db
= \null
$district_calculation_ids
public
mixed
$district_calculation_ids
= ['300']
$is_new
public
mixed
$is_new
= \null
$legal_entity_obj
public
mixed
$legal_entity_obj
= \null
$lookback_pay_stub_lf
public
mixed
$lookback_pay_stub_lf
= \null
$old_data
public
mixed
$old_data
= []
$pay_stub_entry_account_link_obj
public
mixed
$pay_stub_entry_account_link_obj
= \null
$pay_stub_entry_account_obj
public
mixed
$pay_stub_entry_account_obj
= \null
$payroll_remittance_agency_obj
public
mixed
$payroll_remittance_agency_obj
= \null
$province_calculation_ids
public
mixed
$province_calculation_ids
= ['200', '210', '300']
$rs
public
mixed
$rs
= \null
$tmp_data
public
mixed
$tmp_data
= []
$users
public
mixed
$users
= \null
$validate_only
public
mixed
$validate_only
= \false
$Validator
public
mixed
$Validator
= \null
$account_amount_type_map
protected
mixed
$account_amount_type_map
= [10 => 'amount', 20 => 'units', 30 => 'ytd_amount', 40 => 'ytd_units']
$account_amount_type_ps_entries_map
protected
mixed
$account_amount_type_ps_entries_map
= [10 => 'current', 20 => 'current', 30 => 'previous+ytd_adjustment', 40 => 'previous+ytd_adjustment']
$api_message_id
protected
mixed
$api_message_id
= \null
$enable_system_log_detail
protected
mixed
$enable_system_log_detail
= \true
$length_of_service_multiplier
protected
mixed
$length_of_service_multiplier
= [0 => 0, 10 => 1, 20 => 7, 30 => 30.4167, 40 => 365.25, 50 => 0.041666666666666664]
$pk_sequence_name
protected
mixed
$pk_sequence_name
= 'company_deduction_id_seq'
$progress_bar_obj
protected
mixed
$progress_bar_obj
= \null
$table
protected
mixed
$table
= 'company_deduction'
$ignore_column_list
private
bool
$ignore_column_list
$is_valid
private
mixed
$is_valid
= \false
Methods
__construct()
Factory constructor.
public
__construct() : mixed
Return values
mixed —__toString()
Print primary columns from object.
public
__toString() : bool|string
Return values
bool|string —_getFactoryOptions()
public
_getFactoryOptions(string $name[, null $parent = null ]) : array<string|int, mixed>|null
Parameters
- $name : string
- $parent : null = null
Return values
array<string|int, mixed>|null —_getVariableToFunctionMap()
public
_getVariableToFunctionMap(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
Return values
array<string|int, mixed> —addLog()
public
addLog( $log_action) : bool
Parameters
Return values
bool —bulkDelete()
public
bulkDelete(string|array<string|int, mixed> $ids) : bool
Parameters
- $ids : string|array<string|int, mixed>
-
UUID
Tags
Return values
bool —castGenericDataValue()
Generic casting function that all set/get*() functions should pass through.
public
castGenericDataValue( &$value, $cast) : mixed
However for now lets wait until we have meta data from SQL schema so we can pass those datatypes directly into this.
Parameters
Return values
mixed —clearCacheSavedInTransaction()
public
clearCacheSavedInTransaction() : bool
Return values
bool —clearData()
public
clearData() : bool
Return values
bool —clearGeoCode()
public
clearGeoCode([array<string|int, mixed> $data_diff = null ]) : bool
Parameters
- $data_diff : array<string|int, mixed> = null
Return values
bool —clearNonMappedData()
Removes array elements from $data that are not in the function map.
public
clearNonMappedData([array<string|int, mixed>|null $data = null ]) : array<string|int, mixed>|null
Parameters
- $data : array<string|int, mixed>|null = null
Return values
array<string|int, mixed>|null —clearOldData()
public
clearOldData() : bool
Return values
bool —CommitSavePoint()
public
CommitSavePoint( $name) : bool
Parameters
Return values
bool —CommitTransaction()
public
CommitTransaction([bool $unnest_transactions = false ]) : mixed
Parameters
- $unnest_transactions : bool = false
Tags
Return values
mixed —convertFlexArray()
public
convertFlexArray(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
Return values
array<string|int, mixed> —decodeCustomFields()
public
decodeCustomFields() : bool
Return values
bool —decodeGenericJSONData()
Decode generic 'other_json' column data.
public
decodeGenericJSONData() : bool
Return values
bool —decodeJSONColumn()
Decodes JSON columns that are not the 'other_json' column.
public
decodeJSONColumn( $column) : bool
Parameters
Return values
bool —Delete()
Deletes the record directly from the database.
public
Delete([bool $disable_audit_log = false ]) : bool
Parameters
- $disable_audit_log : bool = false
Tags
Return values
bool —encodeCustomFields()
public
encodeCustomFields() : bool
Return values
bool —encodeGenericJSONData()
Encode generic 'other_json' column data. This should only be done in Save() after all validation has occurred already and we are just about to commit it to the DB.
public
encodeGenericJSONData() : bool
Return values
bool —encodeJSONColumns()
Encode any JSON columns that are not 'other_json' column. This should only be done in Save() after all validation has occurred already and we are just about to commit it to the DB.
public
encodeJSONColumns() : bool
Return values
bool —ExecuteSQL()
Execute SQL queries and handle paging properly for select statements.
public
ExecuteSQL(string $query[, array<string|int, mixed> $ph = null ][, int $limit = null ][, int $page = null ]) : bool
Parameters
- $query : string
- $ph : array<string|int, mixed> = null
- $limit : int = null
-
Limit the number of records returned
- $page : int = null
-
Page number of records to return for pagination
Tags
Return values
bool —FailTransaction()
public
FailTransaction() : mixed
Return values
mixed —fromBool()
public
fromBool(string|int|bool $value) : bool
Parameters
- $value : string|int|bool
Return values
bool —fromJSONBool()
public
fromJSONBool(string|int|bool $value) : bool
Parameters
- $value : string|int|bool
Return values
bool —getAccountAmountTypeMap()
public
getAccountAmountTypeMap(string $id) : mixed|string
Parameters
- $id : string
-
UUID
Return values
mixed|string —getAccountAmountTypePSEntriesMap()
public
getAccountAmountTypePSEntriesMap(string $id) : mixed|string
Parameters
- $id : string
-
UUID
Return values
mixed|string —getAffectedRows()
public
getAffectedRows() : int|bool
Return values
int|bool —getAPIMessageID()
Used for updating progress bar for API calls.
public
getAPIMessageID() : bool|null
Return values
bool|null —getApplyFrequency()
public
getApplyFrequency() : int
Return values
int —getApplyFrequencyDayOfMonth()
public
getApplyFrequencyDayOfMonth() : bool|mixed
Return values
bool|mixed —getApplyFrequencyDayOfMonth1()
public
getApplyFrequencyDayOfMonth1() : bool|mixed
Return values
bool|mixed —getApplyFrequencyDayOfMonth2()
public
getApplyFrequencyDayOfMonth2() : bool|mixed
Return values
bool|mixed —getApplyFrequencyDayOfWeek()
public
getApplyFrequencyDayOfWeek() : bool|mixed
Return values
bool|mixed —getApplyFrequencyMonth()
public
getApplyFrequencyMonth() : bool|mixed
Return values
bool|mixed —getApplyFrequencyQuarterMonth()
public
getApplyFrequencyQuarterMonth() : bool|mixed
Return values
bool|mixed —getApplyPayrollRunType()
public
getApplyPayrollRunType() : int
Return values
int —getCache()
public
getCache(string $cache_id[, string $group_id = null ]) : bool|mixed
Parameters
- $cache_id : string
- $group_id : string = null
Return values
bool|mixed —getCalculation()
public
getCalculation() : int
Return values
int —getCalculationOrder()
public
getCalculationOrder() : bool|mixed
Return values
bool|mixed —getCalculationPayStubAmount()
public
getCalculationPayStubAmount(PayStubFactory $pay_stub_obj[, int $include_account_amount_type_id = null ][, int $exclude_account_amount_type_id = null ]) : bool|string
Parameters
- $pay_stub_obj : PayStubFactory
- $include_account_amount_type_id : int = null
-
ID
- $exclude_account_amount_type_id : int = null
-
ID
Return values
bool|string —getCalculationYTDAmount()
public
getCalculationYTDAmount(PayStubFactory $pay_stub_obj) : bool|int|string
Parameters
- $pay_stub_obj : PayStubFactory
Return values
bool|int|string —getColumn()
Generic function get any data from the data array.
public
getColumn(string $column) : bool|mixed
Used mainly for the reports that return grouped queries and such.
Parameters
- $column : string
Return values
bool|mixed —getColumnList()
public
getColumnList() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool —getCombinedCalculationID()
public
getCombinedCalculationID([string $calculation_id = null ][, null $country = null ][, null $province = null ]) : bool|mixed
Parameters
- $calculation_id : string = null
-
UUID
- $country : null = null
- $province : null = null
Return values
bool|mixed —getCompany()
public
getCompany() : bool|mixed
Return values
bool|mixed —getCompanyGenericMapData()
Generic function to return and cache CompanyGenericMap data, this greatly improves performance of CalculatePolicy when many policies exist.
public
getCompanyGenericMapData(string $company_id, int $object_type_id, string $id, string $variable) : mixed
Parameters
- $company_id : string
-
UUID
- $object_type_id : int
- $id : string
-
UUID
- $variable : string
Return values
mixed —getCompanyObject()
public
getCompanyObject() : bool
Return values
bool —getCompanyValue1()
public
getCompanyValue1() : bool|mixed
Return values
bool|mixed —getCompanyValue10()
public
getCompanyValue10() : bool|mixed
Return values
bool|mixed —getCompanyValue1Options()
public
getCompanyValue1Options() : bool
Return values
bool —getCompanyValue2()
public
getCompanyValue2() : bool|mixed
Return values
bool|mixed —getCompanyValue3()
public
getCompanyValue3() : bool|mixed
Return values
bool|mixed —getCompanyValue4()
public
getCompanyValue4() : bool|mixed
Return values
bool|mixed —getCompanyValue5()
public
getCompanyValue5() : bool|mixed
Return values
bool|mixed —getCompanyValue6()
public
getCompanyValue6() : bool|mixed
Return values
bool|mixed —getCompanyValue7()
public
getCompanyValue7() : bool|mixed
Return values
bool|mixed —getCompanyValue8()
public
getCompanyValue8() : bool|mixed
Return values
bool|mixed —getCompanyValue9()
public
getCompanyValue9() : bool|mixed
Return values
bool|mixed —getCountry()
public
getCountry() : bool|mixed
Return values
bool|mixed —getCreatedAndUpdatedColumns()
public
getCreatedAndUpdatedColumns(array<string|int, mixed> &$data[, null $include_columns = null ]) : bool
Parameters
- $data : array<string|int, mixed>
- $include_columns : null = null
Return values
bool —getCreatedBy()
public
getCreatedBy() : bool|mixed
Return values
bool|mixed —getCreatedDate()
public
getCreatedDate() : int
Return values
int —getCurrent()
Grabs the current object
public
final getCurrent() : mixed
Return values
mixed —getCurrentRow()
public
getCurrentRow([int $offset = 1 ]) : int|bool
Parameters
- $offset : int = 1
Return values
int|bool —getCustomField()
Get a single custom field by ID.
public
getCustomField(string $id) : void
Parameters
- $id : string
-
UUID
Return values
void —getCustomFields()
public
getCustomFields( $company_id, $data[, $include_columns = null ]) : mixed
Parameters
Return values
mixed —getCustomFieldsColumns()
public
getCustomFieldsColumns(array<string|int, mixed> $columns, string $company_id[, bool $use_sort_prefix = true ][, string|null $table_name = null ]) : array<string|int, mixed>
Parameters
- $columns : array<string|int, mixed>
- $company_id : string
- $use_sort_prefix : bool = true
- $table_name : string|null = null
Return values
array<string|int, mixed> —getCustomFieldsDataForObject()
Get custom field data for this specific object, so it can be easily cached in memory without having to go to the database or unserialize it from cache for every row.
public
getCustomFieldsDataForObject( $company_id[, mixed $table_name = null ]) : array<string|int, mixed>
Parameters
Tags
Return values
array<string|int, mixed> —getCustomFieldsDefaultData()
public
getCustomFieldsDefaultData( $company_id, $data[, bool $get_all_fields = false ]) : mixed
Parameters
Return values
mixed —getCustomFieldsParseHints()
public
getCustomFieldsParseHints(array<string|int, mixed> $columns, string $company_id, string|null $table_name) : array<string|int, mixed>
Parameters
- $columns : array<string|int, mixed>
- $company_id : string
- $table_name : string|null
Return values
array<string|int, mixed> —getCustomFieldTableName()
public
getCustomFieldTableName() : string
Return values
string —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.
public
getDataDifferences() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDateRangeSQL()
This function takes plain input from the user and creates a SQL statement for filtering based on a date range.
public
getDateRangeSQL(string $str, string $column[, string $format = 'epoch' ][, bool $include_blank_dates = false ]) : bool|string
Supported Syntax:
=01-Jan-09 <=01-Jan-09 <01-Jan-09 01-Jan-09 01-Jan-09 & <10-Jan-09
Parameters
- $str : string
- $column : string
- $format : string = 'epoch'
- $include_blank_dates : bool = false
Return values
bool|string —getDeleted()
public
getDeleted() : bool
Return values
bool —getDeletedBy()
public
getDeletedBy() : bool|mixed
Return values
bool|mixed —getDeletedDate()
public
getDeletedDate() : bool|mixed
Return values
bool|mixed —getDescription()
public
getDescription() : bool|mixed
Return values
bool|mixed —getDistrict()
public
getDistrict() : bool|mixed
Return values
bool|mixed —getDistrictName()
Used for getting district name on W2's
public
getDistrictName() : bool|mixed|null
Return values
bool|mixed|null —getEmptyRecordSet()
public
getEmptyRecordSet([string $id = null ]) : mixed
Parameters
- $id : string = null
-
UUID
Tags
Return values
mixed —getEnableSystemLogDetail()
public
getEnableSystemLogDetail() : bool
Return values
bool —getEndDate()
public
getEndDate([bool $raw = false ]) : bool|int|mixed
Parameters
- $raw : bool = false
Return values
bool|int|mixed —getExcludeAccountAmountType()
public
getExcludeAccountAmountType() : bool|mixed
Return values
bool|mixed —getExcludePayStubEntryAccount()
public
getExcludePayStubEntryAccount() : array<string|int, mixed>|bool|mixed|null
Return values
array<string|int, mixed>|bool|mixed|null —getExpandedPayStubEntryAccountIDs()
Expands Total PS accounts (ie: Total Gross, Total Deduction, Total Employer Contributions, Net Pay) into their individual PS accounts.
public
getExpandedPayStubEntryAccountIDs(string $ids[, bool $include_net_pay = false ]) : array<string|int, mixed>
Parameters
- $ids : string
-
UUID
- $include_net_pay : bool = false
-
Check to see if Net Pay PS account is in $ids, and expand all earnings and deductions.
Return values
array<string|int, mixed> —getFormulaPayStubAccounts()
Parse the formula and pull out any pay stub accounts that should be considered "required" accounts for purposes of determing the calculation order.
public
getFormulaPayStubAccounts() : mixed
Return values
mixed —getGenericDataValue()
Generic getter/setter functions that should be used when Validation code is moved from get/set functions to Validate() function.
public
getGenericDataValue(string $name[, null $cast = null ]) : bool|mixed
Parameters
- $name : string
- $cast : null = null
Return values
bool|mixed —getGenericJSONDataValue()
Generic getter/setter functions for handling generic JSON data in 'other_json' SQL column.
public
getGenericJSONDataValue(string $name[, null $cast = null ]) : bool|mixed
Parameters
- $name : string
- $cast : null = null
Return values
bool|mixed —getGenericObject()
Generic function to return and cache class objects ListFactory, ListFactoryMethod, Variable, ID, IDMethod
public
getGenericObject(string $list_factory, string|int $id, string $variable[, string $list_factory_method = 'getById' ][, string $id_method = 'getID' ]) : object|bool
Parameters
- $list_factory : string
- $id : string|int
-
UUID
- $variable : string
- $list_factory_method : string = 'getById'
- $id_method : string = 'getID'
Return values
object|bool —getGenericOldDataValue()
public
getGenericOldDataValue(string $name) : bool|mixed
Parameters
- $name : string
-
Gets data value from old_data array, or the original value in the database, prior to any changes currently in memory.
Return values
bool|mixed —getGenericTempDataValue()
Generic getter/setter functions that should be used when Validation code is moved from get/set functions to Validate() function.
public
getGenericTempDataValue(string $name) : bool
Parameters
- $name : string
Return values
bool —getId()
public
getId() : bool|mixed
Return values
bool|mixed —getIDSByListFactory()
public
getIDSByListFactory(object $lf) : array<string|int, mixed>|bool
Parameters
- $lf : object
Return values
array<string|int, mixed>|bool —getIncludeAccountAmountType()
public
getIncludeAccountAmountType() : bool|mixed
Return values
bool|mixed —getIncludePayStubEntryAccount()
public
getIncludePayStubEntryAccount() : array<string|int, mixed>|bool|mixed|null
Return values
array<string|int, mixed>|bool|mixed|null —getIterator()
public
final getIterator() : FactoryListIterator
Return values
FactoryListIterator —getJavaScriptArrays()
public
getJavaScriptArrays() : string
Return values
string —getLabelId()
public
getLabelId() : bool|mixed|string
Return values
bool|mixed|string —getLegalEntity()
public
getLegalEntity() : bool|mixed
Return values
bool|mixed —getLegalEntityObject()
public
getLegalEntityObject() : bool
Return values
bool —getLengthOfServiceContributingPayCodePolicy()
public
getLengthOfServiceContributingPayCodePolicy() : bool|mixed
Return values
bool|mixed —getLengthOfServiceContributingPayCodePolicyObject()
public
getLengthOfServiceContributingPayCodePolicyObject() : bool
Return values
bool —getLockUserValue1()
public
getLockUserValue1() : bool
Return values
bool —getLockUserValue10()
public
getLockUserValue10() : bool
Return values
bool —getLockUserValue2()
public
getLockUserValue2() : bool
Return values
bool —getLockUserValue3()
public
getLockUserValue3() : bool
Return values
bool —getLockUserValue4()
public
getLockUserValue4() : bool
Return values
bool —getLockUserValue5()
public
getLockUserValue5() : bool
Return values
bool —getLockUserValue6()
public
getLockUserValue6() : bool
Return values
bool —getLockUserValue7()
public
getLockUserValue7() : bool
Return values
bool —getLockUserValue8()
public
getLockUserValue8() : bool
Return values
bool —getLockUserValue9()
public
getLockUserValue9() : bool
Return values
bool —getLookbackCalculationPayStubAmount()
public
getLookbackCalculationPayStubAmount([int $include_account_amount_type_id = null ][, int $exclude_account_amount_type_id = null ]) : int|string
Parameters
- $include_account_amount_type_id : int = null
-
ID
- $exclude_account_amount_type_id : int = null
-
ID
Return values
int|string —getLookbackPayStubs()
public
getLookbackPayStubs(string $user_id, object $pay_period_obj) : array<string|int, mixed>
Parameters
- $user_id : string
-
UUID
- $pay_period_obj : object
Return values
array<string|int, mixed> —getLookbackStartAndEndDates()
Handle look back period, which is always based on the transaction date *before* the current pay periods transaction date.
public
getLookbackStartAndEndDates(object $pay_period_obj) : array<string|int, mixed>
Parameters
- $pay_period_obj : object
Return values
array<string|int, mixed> —getMaximumLengthOfService()
public
getMaximumLengthOfService() : float
Return values
float —getMaximumLengthOfServiceDays()
public
getMaximumLengthOfServiceDays() : float
Return values
float —getMaximumLengthOfServiceUnit()
public
getMaximumLengthOfServiceUnit() : int
Return values
int —getMaximumUserAge()
public
getMaximumUserAge() : float
Return values
float —getMinimumLengthOfService()
public
getMinimumLengthOfService() : float
Return values
float —getMinimumLengthOfServiceDays()
public
getMinimumLengthOfServiceDays() : float
Return values
float —getMinimumLengthOfServiceUnit()
public
getMinimumLengthOfServiceUnit() : int
Return values
int —getMinimumUserAge()
public
getMinimumUserAge() : float
Return values
float —getName()
public
getName() : bool|mixed
Return values
bool|mixed —getNextInsertId()
public
getNextInsertId() : bool|string
Return values
bool|string —getObjectAsArray()
public
getObjectAsArray([null $include_columns = null ][, bool $permission_children_ids = false ][, bool $include_user_id = false ]) : array<string|int, mixed>
Parameters
- $include_columns : null = null
- $permission_children_ids : bool = false
- $include_user_id : bool = false
Return values
array<string|int, mixed> —getOptions()
public
getOptions(string $name[, string|int $parent = null ]) : array<string|int, mixed>|bool
Parameters
- $name : string
- $parent : string|int = null
Return values
array<string|int, mixed>|bool —getPayrollRemittanceAgency()
public
getPayrollRemittanceAgency() : bool|mixed
Return values
bool|mixed —getPayrollRemittanceAgencyIdByNameOrCalculation()
public
getPayrollRemittanceAgencyIdByNameOrCalculation() : bool|mixed|string
Return values
bool|mixed|string —getPayrollRemittanceAgencyObject()
public
getPayrollRemittanceAgencyObject() : bool
Return values
bool —getPayStubEntryAccount()
public
getPayStubEntryAccount() : bool|mixed
Return values
bool|mixed —getPayStubEntryAccountByCompanyIDAndTypeAndFuzzyName()
public
static getPayStubEntryAccountByCompanyIDAndTypeAndFuzzyName(string $company_id, int $type_id, $name) : bool
Parameters
Return values
bool —getPayStubEntryAccountLinkObject()
public
getPayStubEntryAccountLinkObject() : bool|null
Return values
bool|null —getPayStubEntryAccountObject()
public
getPayStubEntryAccountObject() : bool
Return values
bool —getPayStubEntryAccountYTDAmount()
public
getPayStubEntryAccountYTDAmount(PayStubFactory $pay_stub_obj) : bool|int|string
Parameters
- $pay_stub_obj : PayStubFactory
Return values
bool|int|string —getPayStubEntryAmountSum()
public
getPayStubEntryAmountSum(PayStubFactory $pay_stub_obj, string|array<string|int, mixed> $ids[, string $ps_entries = 'current' ][, string $return_value = 'amount' ]) : bool|string
Parameters
- $pay_stub_obj : PayStubFactory
- $ids : string|array<string|int, mixed>
-
UUID
- $ps_entries : string = 'current'
- $return_value : string = 'amount'
Return values
bool|string —getPayStubEntryDescription()
public
getPayStubEntryDescription() : bool|mixed
Return values
bool|mixed —getPermissionColumns()
public
getPermissionColumns(array<string|int, mixed> &$data, string $object_user_id, string $created_by_id[, string $permission_children_ids = null ][, array<string|int, mixed> $include_columns = null ]) : bool
Parameters
- $data : array<string|int, mixed>
- $object_user_id : string
-
UUID
- $created_by_id : string
-
UUID
- $permission_children_ids : string = null
-
UUID
- $include_columns : array<string|int, mixed> = null
Return values
bool —getProgressBarObject()
public
getProgressBarObject() : null|ProgressBar
Return values
null|ProgressBar —getProvince()
public
getProvince() : bool|mixed
Return values
bool|mixed —getRecordCount()
public
getRecordCount() : int|bool
Return values
int|bool —getSequenceName()
public
getSequenceName() : bool
Return values
bool —getStartDate()
public
getStartDate([bool $raw = false ]) : bool|int|mixed
Parameters
- $raw : bool = false
Return values
bool|int|mixed —getStatus()
public
getStatus() : int
Return values
int —getTable()
public
getTable([bool $strip_quotes = false ]) : bool|string
Parameters
- $strip_quotes : bool = false
Return values
bool|string —getTotalUsers()
public
getTotalUsers() : mixed
Return values
mixed —getTransactionMode()
public
getTransactionMode([bool $force = false ]) : string
Parameters
- $force : bool = false
Return values
string —getType()
public
getType() : int
Return values
int —getUpdatedBy()
public
getUpdatedBy() : bool|mixed
Return values
bool|mixed —getUpdatedDate()
public
getUpdatedDate() : int
Return values
int —getUser()
public
getUser() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool —getUserValue1()
public
getUserValue1() : bool|mixed
Return values
bool|mixed —getUserValue10()
public
getUserValue10() : bool|mixed
Return values
bool|mixed —getUserValue1Options()
public
getUserValue1Options() : bool
Return values
bool —getUserValue2()
public
getUserValue2() : bool|mixed
Return values
bool|mixed —getUserValue3()
public
getUserValue3() : bool|mixed
Return values
bool|mixed —getUserValue4()
public
getUserValue4() : bool|mixed
Return values
bool|mixed —getUserValue5()
public
getUserValue5() : bool|mixed
Return values
bool|mixed —getUserValue6()
public
getUserValue6() : bool|mixed
Return values
bool|mixed —getUserValue7()
public
getUserValue7() : bool|mixed
Return values
bool|mixed —getUserValue8()
public
getUserValue8() : bool|mixed
Return values
bool|mixed —getUserValue9()
public
getUserValue9() : bool|mixed
Return values
bool|mixed —getValidSQLColumns()
public
getValidSQLColumns(array<string|int, mixed> $array[, bool $strict = true ][, array<string|int, mixed> $additional_fields = null ]) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
- $strict : bool = true
- $additional_fields : array<string|int, mixed> = null
Tags
Return values
array<string|int, mixed> —getVariableToFunctionMap()
public
getVariableToFunctionMap([array<string|int, mixed> $data = null ]) : array<string|int, mixed>|bool
Parameters
- $data : array<string|int, mixed> = null
Return values
array<string|int, mixed>|bool —getWorkedTimeByUserIdAndEndDate()
public
getWorkedTimeByUserIdAndEndDate(string $user_id[, int $start_date = null ][, int $end_date = null ]) : bool|int
Parameters
- $user_id : string
-
UUID
- $start_date : int = null
-
EPOCH
- $end_date : int = null
-
EPOCH
Return values
bool|int —handleSaveSQLReturning()
Used to handle any "RETURNING ..." clause on a SQL INSERT/UPDATE query.
public
handleSaveSQLReturning( $rs) : bool
Parameters
Return values
bool —hasDataChanged()
Determine if the record data has changed at all.
public
hasDataChanged() : bool
Return values
bool —inApplyFrequencyWindow()
public
inApplyFrequencyWindow(int $pay_period_start_date, int $pay_period_end_date[, int $hire_date = null ][, int $termination_date = null ][, int $birth_date = null ]) : bool
Parameters
- $pay_period_start_date : int
-
EPOCH
- $pay_period_end_date : int
-
EPOCH
- $hire_date : int = null
-
EPOCH
- $termination_date : int = null
-
EPOCH
- $birth_date : int = null
-
EPOCH
Return values
bool —inApplyPayrollRunType()
public
inApplyPayrollRunType(int $type_id) : bool
Parameters
- $type_id : int
Return values
bool —isActiveDate()
Check if this date is within the effective date range
public
isActiveDate(object $ud_obj[, int $pp_end_date = null ][, int $pp_transaction_date = null ]) : bool
Parameters
- $ud_obj : object
- $pp_end_date : int = null
-
EPOCH
- $pp_transaction_date : int = null
-
EPOCH
Return values
bool —isActiveLengthOfService()
public
isActiveLengthOfService(object $ud_obj, int $epoch[, bool $pay_period_start_date = false ]) : bool
Parameters
- $ud_obj : object
- $epoch : int
-
EPOCH
- $pay_period_start_date : bool = false
Return values
bool —isActiveUserAge()
public
isActiveUserAge(int $birth_date[, int $pp_end_date = null ][, int $pp_transaction_date = null ]) : bool
Parameters
- $birth_date : int
-
EPOCH
- $pp_end_date : int = null
-
EPOCH
- $pp_transaction_date : int = null
-
EPOCH
Return values
bool —isClientFriendly()
Check if the remote client is our main UI app controlled by us, vs. a user utilizing the API for example.
public
isClientFriendly() : bool
This is mostly used to determine if we can return columns that are resource intensive to compute when obtaining a list. (ie: Users, Jobs)
Return values
bool —isCountryCalculationID()
public
isCountryCalculationID(string $calculation_id) : bool
Parameters
- $calculation_id : string
-
UUID
Return values
bool —isCPPAgeEligible()
public
isCPPAgeEligible(int $birth_date[, int $pp_transaction_date = null ]) : bool
Parameters
- $birth_date : int
-
EPOCH
- $pp_transaction_date : int = null
-
EPOCH
Return values
bool —isDataDifferent()
Used to check the differences between a single key in the $old_data vs. $data arrays.
public
isDataDifferent( $key, $data_diff[, null $type_id = null ][, null $new_data = null ]) : bool
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.
Parameters
Return values
bool —isDistrictCalculationID()
public
isDistrictCalculationID(string $calculation_id) : bool
Parameters
- $calculation_id : string
-
UUID
Return values
bool —isLookbackCalculation()
public
isLookbackCalculation() : bool
Return values
bool —isNew()
Determines if the data is new data, or updated data. Basically determines if a database INSERT or UPDATE SQL statement is generated.
public
isNew([bool $force_lookup = false ][, string $id = null ]) : bool
Parameters
- $force_lookup : bool = false
- $id : string = null
-
UUID
Return values
bool —isProvinceCalculationID()
public
isProvinceCalculationID(string $calculation_id) : bool
Parameters
- $calculation_id : string
-
UUID
Return values
bool —isSQLExceptionRetryable()
Determines if a SQL exception is one that can be retried or not.
public
isSQLExceptionRetryable( $e) : bool
Parameters
Return values
bool —isUniqueName()
public
isUniqueName( $name) : bool
Parameters
Return values
bool —isUserAgeEligibility()
Check to see if user age eligibility criteria are actually specified for this Tax/Deduction record.
public
isUserAgeEligibility() : bool
Return values
bool —isUserLengthOfServiceEligibility()
Check to see if user length of service eligibility criteria are actually specified for this Tax/Deduction record.
public
isUserLengthOfServiceEligibility() : bool
Return values
bool —isValid()
Call class specific validation function just before saving.
public
isValid([bool $ignore_warning = true ]) : bool
Parameters
- $ignore_warning : bool = true
Return values
bool —isWarning()
Call class specific validation function just before saving.
public
isWarning() : bool
Return values
bool —modifyInsertQuery()
Modifies the automatically generated SQL INSERT query for adding things like " ON CONFLICT ..."
public
modifyInsertQuery( $query) : mixed
Parameters
Return values
mixed —parseCustomFieldsFromArray()
public
parseCustomFieldsFromArray( $data) : mixed
Parameters
Return values
mixed —parseUserValues()
Parse user values coming directly from the user, for handling things like parseFloat() which can be different for each calculation.
public
parseUserValues( $calculation_id, $data) : mixed
This is also called from UserDeductionFactory.
Parameters
Return values
mixed —postSave()
public
postSave() : bool
Return values
bool —preSave()
public
preSave() : bool
Return values
bool —removeCache()
public
removeCache([string $cache_id = null ][, string $group_id = null ]) : bool
Parameters
- $cache_id : string = null
- $group_id : string = null
Return values
bool —RetryTransaction()
Accepts a Closure and is retried at set intervals which should be in a transaction.
public
RetryTransaction( $transaction_function[, int $retry_max_attempts = 4 ][, int $retry_sleep = 1 ]) : mixed
Parameters
Tags
Return values
mixed —rewind()
Rewinds record set iterator to begining. The same as ADODB's MoveFirst() function.
public
final rewind() : bool
Return values
bool —RollbackSavePoint()
public
RollbackSavePoint( $name) : bool
Parameters
Return values
bool —Save()
Determines to insert or update, and does it.
public
Save([bool $reset_data = true ][, bool $force_lookup = false ]) : bool|int|string
Have this handle created, createdby, updated, updatedby.
Parameters
- $reset_data : bool = true
- $force_lookup : bool = false
Tags
Return values
bool|int|string —saveCache()
public
saveCache(mixed $data, string $cache_id[, string $group_id = null ]) : bool
Parameters
- $data : mixed
- $cache_id : string
- $group_id : string = null
Return values
bool —serializeRS()
Serialize ADODB recordset.
public
serializeRS(object $rs) : string
Parameters
- $rs : object
Tags
Return values
string —setAPIMessageID()
public
setAPIMessageID(string $id) : bool
Parameters
- $id : string
-
UUID
Return values
bool —setApplyFrequency()
public
setApplyFrequency( $value) : bool
Parameters
Return values
bool —setApplyFrequencyDayOfMonth()
public
setApplyFrequencyDayOfMonth( $value) : bool
Parameters
Return values
bool —setApplyFrequencyDayOfWeek()
public
setApplyFrequencyDayOfWeek( $value) : bool
Parameters
Return values
bool —setApplyFrequencyMonth()
public
setApplyFrequencyMonth( $value) : bool
Parameters
Return values
bool —setApplyFrequencyQuarterMonth()
public
setApplyFrequencyQuarterMonth( $value) : bool
Parameters
Return values
bool —setApplyPayrollRunType()
public
setApplyPayrollRunType( $value) : bool
Parameters
Return values
bool —setCacheLifeTime()
public
setCacheLifeTime(int $secs) : bool
Parameters
- $secs : int
Return values
bool —setCalculation()
public
setCalculation( $value) : bool
Parameters
Return values
bool —setCalculationOrder()
public
setCalculationOrder( $value) : bool
Parameters
Return values
bool —setCompany()
public
setCompany( $value) : bool
Parameters
Return values
bool —setCompanyValue1()
public
setCompanyValue1( $value) : bool
Parameters
Return values
bool —setCompanyValue10()
public
setCompanyValue10( $value) : bool
Parameters
Return values
bool —setCompanyValue2()
public
setCompanyValue2( $value) : bool
Parameters
Return values
bool —setCompanyValue3()
public
setCompanyValue3( $value) : bool
Parameters
Return values
bool —setCompanyValue4()
public
setCompanyValue4( $value) : bool
Parameters
Return values
bool —setCompanyValue5()
public
setCompanyValue5( $value) : bool
Parameters
Return values
bool —setCompanyValue6()
public
setCompanyValue6( $value) : bool
Parameters
Return values
bool —setCompanyValue7()
public
setCompanyValue7( $value) : bool
Parameters
Return values
bool —setCompanyValue8()
public
setCompanyValue8( $value) : bool
Parameters
Return values
bool —setCompanyValue9()
public
setCompanyValue9( $value) : bool
Parameters
Return values
bool —setCountry()
public
setCountry( $value) : bool
Parameters
Return values
bool —setCreatedAndUpdatedColumns()
public
setCreatedAndUpdatedColumns(array<string|int, mixed> $data[, array<string|int, mixed> $variable_to_function_map = [] ]) : bool
Parameters
- $data : array<string|int, mixed>
- $variable_to_function_map : array<string|int, mixed> = []
Return values
bool —setCreatedBy()
public
setCreatedBy([string $id = null ]) : bool
Parameters
- $id : string = null
-
UUID
Return values
bool —setCreatedDate()
public
setCreatedDate([int $epoch = null ]) : bool
Parameters
- $epoch : int = null
-
EPOCH
Return values
bool —setCustomField()
Set a single custom field by ID.
public
setCustomField(mixed $value, string $id) : void
Parameters
- $value : mixed
- $id : string
-
UUID
Return values
void —setCustomFields()
public
setCustomFields( $data) : bool
Parameters
Return values
bool —setDeleted()
public
setDeleted(bool $bool) : bool
Parameters
- $bool : bool
Return values
bool —setDeletedBy()
public
setDeletedBy([string $id = null ]) : bool|null
Parameters
- $id : string = null
-
UUID
Return values
bool|null —setDeletedDate()
public
setDeletedDate([int $epoch = null ]) : bool
Parameters
- $epoch : int = null
-
EPOCH
Return values
bool —setDescription()
public
setDescription( $value) : bool
Parameters
Return values
bool —setDistrict()
public
setDistrict( $value) : bool
Parameters
Return values
bool —setEnableSystemLogDetail()
public
setEnableSystemLogDetail( $bool) : bool
Parameters
Return values
bool —setEndDate()
public
setEndDate( $value) : bool
Parameters
Return values
bool —setExcludeAccountAmountType()
public
setExcludeAccountAmountType( $value) : bool
Parameters
Return values
bool —setExcludePayStubEntryAccount()
public
setExcludePayStubEntryAccount(string|array<string|int, string> $ids) : bool
Parameters
- $ids : string|array<string|int, string>
-
UUID
Return values
bool —setGenericDataValue()
public
setGenericDataValue(string $name, mixed $data[, null $cast = null ]) : bool
Parameters
- $name : string
- $data : mixed
- $cast : null = null
Return values
bool —setGenericJSONDataValue()
Generic getter/setter functions for handling generic JSON data in 'other_json' SQL column.
public
setGenericJSONDataValue(string $name, mixed $data[, null $cast = null ]) : bool
Parameters
- $name : string
- $data : mixed
- $cast : null = null
Return values
bool —setGenericObject()
Allow method to pre-populate/overwrite the cache if needed.
public
setGenericObject(object $obj, string $variable) : bool
Parameters
- $obj : object
- $variable : string
Return values
bool —setGenericTempDataValue()
public
setGenericTempDataValue(string $name, mixed $data) : bool
Parameters
- $name : string
- $data : mixed
Return values
bool —setId()
public
setId(string $id) : bool
Parameters
- $id : string
-
UUID
Return values
bool —setIncludeAccountAmountType()
public
setIncludeAccountAmountType( $value) : bool
Parameters
Return values
bool —setIncludePayStubEntryAccount()
public
setIncludePayStubEntryAccount(string|array<string|int, string> $ids) : bool
Parameters
- $ids : string|array<string|int, string>
-
UUID
Return values
bool —setIsValid()
Sets the is_valid flag, mostly used to set it to FALSE to force a full re-validation.
public
setIsValid([bool $is_valid = false ]) : bool
Required because $this->is_valid is a private variable and should stay that way.
Parameters
- $is_valid : bool = false
Return values
bool —setLegalEntity()
public
setLegalEntity( $value) : bool
Parameters
Return values
bool —setLengthOfServiceContributingPayCodePolicy()
public
setLengthOfServiceContributingPayCodePolicy( $value) : bool
Parameters
Return values
bool —setLockUserValue1()
public
setLockUserValue1( $value) : bool
Parameters
Return values
bool —setLockUserValue10()
public
setLockUserValue10( $value) : bool
Parameters
Return values
bool —setLockUserValue2()
public
setLockUserValue2( $value) : bool
Parameters
Return values
bool —setLockUserValue3()
public
setLockUserValue3( $value) : bool
Parameters
Return values
bool —setLockUserValue4()
public
setLockUserValue4( $value) : bool
Parameters
Return values
bool —setLockUserValue5()
public
setLockUserValue5( $value) : bool
Parameters
Return values
bool —setLockUserValue6()
public
setLockUserValue6( $value) : bool
Parameters
Return values
bool —setLockUserValue7()
public
setLockUserValue7( $value) : bool
Parameters
Return values
bool —setLockUserValue8()
public
setLockUserValue8( $value) : bool
Parameters
Return values
bool —setLockUserValue9()
public
setLockUserValue9( $value) : bool
Parameters
Return values
bool —setMaximumLengthOfService()
public
setMaximumLengthOfService( $value) : bool
Parameters
Return values
bool —setMaximumLengthOfServiceDays()
public
setMaximumLengthOfServiceDays( $value) : bool
Parameters
Return values
bool —setMaximumLengthOfServiceUnit()
public
setMaximumLengthOfServiceUnit( $value) : bool
Parameters
Return values
bool —setMaximumUserAge()
public
setMaximumUserAge( $value) : bool
Parameters
Return values
bool —setMinimumLengthOfService()
public
setMinimumLengthOfService( $value) : bool
Parameters
Return values
bool —setMinimumLengthOfServiceDays()
public
setMinimumLengthOfServiceDays( $value) : bool
Parameters
Return values
bool —setMinimumLengthOfServiceUnit()
public
setMinimumLengthOfServiceUnit( $value) : bool
Parameters
Return values
bool —setMinimumUserAge()
public
setMinimumUserAge( $value) : bool
Parameters
Return values
bool —setName()
public
setName( $value) : bool
Parameters
Return values
bool —setObjectFromArray()
public
setObjectFromArray( $data) : bool
Parameters
Return values
bool —setPayrollRemittanceAgency()
public
setPayrollRemittanceAgency( $value) : bool
Parameters
Return values
bool —setPayStubEntryAccount()
public
setPayStubEntryAccount( $value) : bool
Parameters
Return values
bool —setPayStubEntryDescription()
public
setPayStubEntryDescription( $value) : bool
Parameters
Return values
bool —setProgressBarObject()
public
setProgressBarObject(object $obj) : bool
Parameters
- $obj : object
Return values
bool —setProvince()
public
setProvince( $value) : bool
Parameters
Return values
bool —setQueryStatementTimeout()
public
setQueryStatementTimeout([null $milliseconds = null ]) : bool
Parameters
- $milliseconds : null = null
Return values
bool —setStartDate()
public
setStartDate( $value) : bool
Parameters
Return values
bool —setStatus()
public
setStatus( $value) : bool
Parameters
Return values
bool —setTransactionMode()
public
setTransactionMode([string $mode = '' ]) : mixed
Parameters
- $mode : string = ''
Return values
mixed —setType()
public
setType( $value) : bool
Parameters
Return values
bool —setUpdatedBy()
public
setUpdatedBy([string $id = null ]) : bool|null
Parameters
- $id : string = null
-
UUID
Return values
bool|null —setUpdatedDate()
public
setUpdatedDate([int $epoch = null ]) : bool|int|null|string
Parameters
- $epoch : int = null
-
EPOCH
Return values
bool|int|null|string —setUser()
public
setUser(string $ids) : bool
Parameters
- $ids : string
-
UUID
Return values
bool —setUserValue1()
public
setUserValue1( $value) : bool
Parameters
Return values
bool —setUserValue10()
public
setUserValue10( $value) : bool
Parameters
Return values
bool —setUserValue2()
public
setUserValue2( $value) : bool
Parameters
Return values
bool —setUserValue3()
public
setUserValue3( $value) : bool
Parameters
Return values
bool —setUserValue4()
public
setUserValue4( $value) : bool
Parameters
Return values
bool —setUserValue5()
public
setUserValue5( $value) : bool
Parameters
Return values
bool —setUserValue6()
public
setUserValue6( $value) : bool
Parameters
Return values
bool —setUserValue7()
public
setUserValue7( $value) : bool
Parameters
Return values
bool —setUserValue8()
public
setUserValue8( $value) : bool
Parameters
Return values
bool —setUserValue9()
public
setUserValue9( $value) : bool
Parameters
Return values
bool —StartSavePoint()
public
StartSavePoint( $name) : bool
Parameters
Return values
bool —StartTransaction()
public
StartTransaction() : mixed
Return values
mixed —toBool()
public
toBool(string|int|bool $value) : int
Parameters
- $value : string|int|bool
Return values
int —toJSONBool()
public
toJSONBool(string|int|bool $value) : string
Parameters
- $value : string|int|bool
Return values
string —updateCompanyDeductionForTaxYear()
public
updateCompanyDeductionForTaxYear(int $date) : bool
Parameters
- $date : int
-
EPOCH
Return values
bool —Validate()
public
Validate([bool $ignore_warning = true ]) : bool
Parameters
- $ignore_warning : bool = true
Return values
bool —validateCustomFields()
public
validateCustomFields(mixed $company_id[, mixed $enable_required_field_check = true ]) : mixed
Parameters
- $company_id : mixed
- $enable_required_field_check : mixed = true
Return values
mixed —castInteger()
protected
castInteger(int|string $int[, string $type = 'int' ]) : bool|int|string
Parameters
- $int : int|string
- $type : string = 'int'
Return values
bool|int|string —getColumnsFromAliases()
protected
getColumnsFromAliases(array<string|int, mixed> $columns, array<string|int, mixed> $aliases) : array<string|int, mixed>
Parameters
- $columns : array<string|int, mixed>
- $aliases : array<string|int, mixed>
Return values
array<string|int, mixed> —getCustomFieldWhereSQL()
protected
getCustomFieldWhereSQL(mixed $company_id, mixed $column, array<string|int, mixed> $filter_data, array<string|int, mixed> &$ph) : string
Parameters
- $company_id : mixed
- $column : mixed
- $filter_data : array<string|int, mixed>
- $ph : array<string|int, mixed>
Return values
string —getDatabaseType()
protected
getDatabaseType() : string
Return values
string —getListSQL()
protected
getListSQL(array<string|int, mixed>|string|int $array[, array<string|int, mixed> &$ph = null ][, string|bool $cast = false ]) : bool|int|string|array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>|string|int
- $ph : array<string|int, mixed> = null
- $cast : string|bool = false
Return values
bool|int|string|array<string|int, mixed> —getSortSQL()
protected
getSortSQL(array<string|int, mixed> $array[, bool $strict = true ][, array<string|int, mixed> $additional_fields = null ]) : bool|string
Parameters
- $array : array<string|int, mixed>
- $strict : bool = true
- $additional_fields : array<string|int, mixed> = null
Return values
bool|string —getSQLStringAggregate()
protected
getSQLStringAggregate(string $sql, string $glue) : string
Parameters
- $sql : string
- $glue : string
Return values
string —getSQLToEpochFunction()
protected
getSQLToEpochFunction(string $sql) : string
Parameters
- $sql : string
Return values
string —getSQLToTimeFunction()
protected
getSQLToTimeFunction(string $sql) : string
Parameters
- $sql : string
Return values
string —getSQLToTimeStampFunction()
protected
getSQLToTimeStampFunction() : string
Return values
string —getWhereClauseSQL()
protected
getWhereClauseSQL(array<string|int, mixed>|string $columns, array<string|int, mixed>|string $args, string $type, array<string|int, mixed> &$ph[, string $query_stub = null ][, bool $and = true ]) : null|string
Parameters
- $columns : array<string|int, mixed>|string
- $args : array<string|int, mixed>|string
- $type : string
- $ph : array<string|int, mixed>
- $query_stub : string = null
- $and : bool = true
Tags
Return values
null|string —getWhereSQL()
protected
getWhereSQL(array<string|int, mixed> $array[, bool $append_where = false ]) : bool|string
Parameters
- $array : array<string|int, mixed>
- $append_where : bool = false
Return values
bool|string —handleSQLSyntax()
SQL where clause Syntax: or % as wildcard.
protected
handleSQLSyntax(string $arg) : string
"
Handles '*' and '%' as wildcards, defaults to wildcard on the end always. If no wildcard is to be added, the last character should be |
Parameters
- $arg : string
Return values
string —stripSQLSyntax()
protected
stripSQLSyntax(string $arg) : mixed
Parameters
- $arg : string
Return values
mixed —getInsertQuery()
private
getInsertQuery() : mixed
Return values
mixed —getRecordSetColumnList()
private
getRecordSetColumnList(object $rs) : array<string|int, mixed>|bool
Parameters
- $rs : object
Return values
array<string|int, mixed>|bool —getUpdateQuery()
private
getUpdateQuery() : bool
Tags
Return values
bool —parseColumnName()
Parses out the exact column name, without any aliases, or = signs in it.
private
parseColumnName(string $column) : bool|string
Parameters
- $column : string