CalculatePayStub

Class name: CalculatePayStub
Namespace:
Parent class: PayStubFactory

Properties

$transaction_date

public mixed $transaction_date = FALSE

Visibility: public

$wage_obj

public mixed $wage_obj = NULL

Visibility: public

$user_obj

protected mixed $user_obj = NULL

Visibility: protected

$user_wage_obj

public mixed $user_wage_obj = NULL

Visibility: public

$pay_period_obj

protected mixed $pay_period_obj = NULL

Visibility: protected

$pay_period_schedule_obj

public mixed $pay_period_schedule_obj = NULL

Visibility: public

$payroll_deduction_obj

public mixed $payroll_deduction_obj = NULL

Visibility: public

$pay_stub_entry_account_link_obj

protected mixed $pay_stub_entry_account_link_obj = NULL

Visibility: protected

$pay_stub_entry_accounts_type_obj

public mixed $pay_stub_entry_accounts_type_obj = NULL

Visibility: public

$table

protected mixed $table = 'pay_stub'

Visibility: protected

$pk_sequence_name

protected mixed $pk_sequence_name = 'pay_stub_id_seq'

Visibility: protected

$tmp_data

public mixed $tmp_data = array()

Visibility: public

$is_unique_pay_stub

protected mixed $is_unique_pay_stub = NULL

Visibility: protected

$is_unique_pay_stub_type

protected mixed $is_unique_pay_stub_type = NULL

Visibility: protected

$currency_obj

protected mixed $currency_obj = NULL

Visibility: protected

$pay_stub_entry_accounts_obj

protected mixed $pay_stub_entry_accounts_obj = NULL

Visibility: protected

$old_currency_id

protected mixed $old_currency_id = NULL

Visibility: protected

$validate_only

public mixed $validate_only = FALSE

Visibility: public

$data

public mixed $data = array()

Visibility: public

$old_data

public mixed $old_data = array()

Visibility: public

$enable_system_log_detail

protected mixed $enable_system_log_detail = TRUE

Visibility: protected

$progress_bar_obj

protected mixed $progress_bar_obj = NULL

Visibility: protected

$AMF_message_id

protected mixed $AMF_message_id = NULL

Visibility: protected

$Validator

public mixed $Validator = NULL

Visibility: public

$is_valid

private mixed $is_valid = FALSE

Visibility: private

Methods

getUser

boolean|mixed PayStubFactory::getUser()

Visibility: public
This method is defined by PayStubFactory

setUser

boolean PayStubFactory::setUser(string $value)

Visibility: public
This method is defined by PayStubFactory

Arguments

$value string - UUID

getPayPeriod

boolean|mixed PayStubFactory::getPayPeriod()

Visibility: public
This method is defined by PayStubFactory

setPayPeriod

boolean PayStubFactory::setPayPeriod(string $value)

Visibility: public
This method is defined by PayStubFactory

Arguments

$value string - UUID

getRun

integer PayStubFactory::getRun()

Visibility: public
This method is defined by PayStubFactory

setRun

boolean PayStubFactory::setRun(string $value)

Visibility: public
This method is defined by PayStubFactory

Arguments

$value string - UUID

getType

boolean|integer PayStubFactory::getType()

Visibility: public
This method is defined by PayStubFactory

setType

boolean PayStubFactory::setType($value)

Visibility: public
This method is defined by PayStubFactory

Arguments

$value mixed

getTransactionDate

boolean|integer PayStubFactory::getTransactionDate(boolean $raw)

Visibility: public
This method is defined by PayStubFactory

Arguments

$raw boolean

setTransactionDate

boolean PayStubFactory::setTransactionDate(integer $value)

Visibility: public
This method is defined by PayStubFactory

Arguments

$value integer - EPOCH

getEnablePostTerminationCalculation

boolean CalculatePayStub::getEnablePostTerminationCalculation()

Visibility: public

setEnablePostTerminationCalculation

boolean CalculatePayStub::setEnablePostTerminationCalculation($bool)

Visibility: public

Arguments

$bool mixed

getEnableCorrection

boolean CalculatePayStub::getEnableCorrection()

Visibility: public

setEnableCorrection

boolean CalculatePayStub::setEnableCorrection($bool)

Visibility: public

Arguments

$bool mixed

getUserObject

boolean PayStubFactory::getUserObject()

Visibility: public
This method is defined by PayStubFactory

getPayStubEntryAccountLinkObject

boolean|null PayStubFactory::getPayStubEntryAccountLinkObject()

Visibility: public
This method is defined by PayStubFactory

getPayPeriodObject

boolean PayStubFactory::getPayPeriodObject()

Visibility: public
This method is defined by PayStubFactory

getPayPeriodScheduleObject

null CalculatePayStub::getPayPeriodScheduleObject()

Visibility: public

getWageObject

null|\Wage CalculatePayStub::getWageObject()

Visibility: public

getPayStubEntryAccountsTypeArray

array|boolean|null CalculatePayStub::getPayStubEntryAccountsTypeArray()

Visibility: public

getDeductionObjectSortValue

integer CalculatePayStub::getDeductionObjectSortValue($type_order, $calculation_order, string $id)

Visibility: public

Arguments

$type_order mixed
$calculation_order mixed
$id string - UUID

getDeductionObjectArrayForSorting

array|boolean CalculatePayStub::getDeductionObjectArrayForSorting(object $obj)

Visibility: public

Arguments

$obj object

getOrderedDeductionAndPSAmendment

array|boolean CalculatePayStub::getOrderedDeductionAndPSAmendment($udlf, $psalf, $uelf)

Visibility: public

Arguments

$udlf mixed
$psalf mixed
$uelf mixed

calculate

boolean CalculatePayStub::calculate()

Visibility: public

_getFactoryOptions

boolean Factory::_getFactoryOptions(string $name, string|integer $parent)

Visibility: protected
This method is defined by Factory

Arguments

$name string
$parent string|integer

_getVariableToFunctionMap

boolean Factory::_getVariableToFunctionMap(array $data)

Visibility: protected
This method is defined by Factory

Arguments

$data array

getCurrencyObject

boolean PayStubFactory::getCurrencyObject()

Visibility: public
This method is defined by PayStubFactory

getDisplayID

boolean|mixed PayStubFactory::getDisplayID()

Visibility: public
This method is defined by PayStubFactory

getCurrency

boolean|mixed PayStubFactory::getCurrency()

Visibility: public
This method is defined by PayStubFactory

setCurrency

boolean PayStubFactory::setCurrency(string $value)

Visibility: public
This method is defined by PayStubFactory

Arguments

$value string - UUID

getCurrencyRate

boolean|mixed PayStubFactory::getCurrencyRate()

Visibility: public
This method is defined by PayStubFactory

setCurrencyRate

boolean PayStubFactory::setCurrencyRate($value)

Visibility: public
This method is defined by PayStubFactory

Arguments

$value mixed

isValidStartDate

boolean PayStubFactory::isValidStartDate(integer $epoch)

Visibility: public
This method is defined by PayStubFactory

Arguments

$epoch integer - EPOCH

getStartDate

boolean|integer PayStubFactory::getStartDate(boolean $raw)

Visibility: public
This method is defined by PayStubFactory

Arguments

$raw boolean

setStartDate

boolean PayStubFactory::setStartDate(integer $value)

Visibility: public
This method is defined by PayStubFactory

Arguments

$value integer - EPOCH

isValidEndDate

boolean PayStubFactory::isValidEndDate(integer $epoch)

Visibility: public
This method is defined by PayStubFactory

Arguments

$epoch integer - EPOCH

getEndDate

boolean|integer PayStubFactory::getEndDate(boolean $raw)

Visibility: public
This method is defined by PayStubFactory

Arguments

$raw boolean

setEndDate

boolean PayStubFactory::setEndDate(integer $value)

Visibility: public
This method is defined by PayStubFactory

Arguments

$value integer - EPOCH

isValidTransactionDate

boolean PayStubFactory::isValidTransactionDate(integer $epoch)

Visibility: public
This method is defined by PayStubFactory

Arguments

$epoch integer - EPOCH

getStatus

boolean|integer PayStubFactory::getStatus()

Visibility: public
This method is defined by PayStubFactory

setStatus

boolean PayStubFactory::setStatus($value)

Visibility: public
This method is defined by PayStubFactory

Arguments

$value mixed

getStatusDate

boolean|mixed PayStubFactory::getStatusDate()

Visibility: public
This method is defined by PayStubFactory

setStatusDate

boolean PayStubFactory::setStatusDate(integer $value)

Visibility: public
This method is defined by PayStubFactory

Arguments

$value integer - EPOCH

getStatusBy

boolean|mixed PayStubFactory::getStatusBy()

Visibility: public
This method is defined by PayStubFactory

setStatusBy

boolean PayStubFactory::setStatusBy(string $value)

Visibility: public
This method is defined by PayStubFactory

Arguments

$value string - UUID

getTainted

boolean PayStubFactory::getTainted()

Visibility: public
This method is defined by PayStubFactory

setTainted

boolean PayStubFactory::setTainted($value)

Visibility: public
This method is defined by PayStubFactory

Arguments

$value mixed

getTemp

boolean PayStubFactory::getTemp()

Visibility: public
This method is defined by PayStubFactory

setTemp

boolean PayStubFactory::setTemp($value)

Visibility: public
This method is defined by PayStubFactory

Arguments

$value mixed

isUniquePayStub

boolean|null PayStubFactory::isUniquePayStub()

Visibility: public
This method is defined by PayStubFactory

isUniquePayStubType

boolean|null PayStubFactory::isUniquePayStubType()

Visibility: public
This method is defined by PayStubFactory

setDefaultDates

boolean PayStubFactory::setDefaultDates()

Visibility: public
This method is defined by PayStubFactory

getEnableProcessEntries

boolean PayStubFactory::getEnableProcessEntries()

Visibility: public
This method is defined by PayStubFactory

setEnableProcessEntries

boolean PayStubFactory::setEnableProcessEntries($bool)

Visibility: public
This method is defined by PayStubFactory

Arguments

$bool mixed

getEnableProcessTransactions

boolean PayStubFactory::getEnableProcessTransactions()

Visibility: public
This method is defined by PayStubFactory

setEnableProcessTransactions

boolean PayStubFactory::setEnableProcessTransactions($bool)

Visibility: public
This method is defined by PayStubFactory

Arguments

$bool mixed

getEnableCalcYTD

boolean PayStubFactory::getEnableCalcYTD()

Visibility: public
This method is defined by PayStubFactory

setEnableCalcYTD

boolean PayStubFactory::setEnableCalcYTD($bool)

Visibility: public
This method is defined by PayStubFactory

Arguments

$bool mixed

getEnableCalcCurrentYTD

boolean PayStubFactory::getEnableCalcCurrentYTD()

Visibility: public
This method is defined by PayStubFactory

setEnableCalcCurrentYTD

boolean PayStubFactory::setEnableCalcCurrentYTD($bool)

Visibility: public
This method is defined by PayStubFactory

Arguments

$bool mixed

getIsReCalculatingYTD

boolean PayStubFactory::getIsReCalculatingYTD()

Visibility: public
This method is defined by PayStubFactory

setIsReCalculatingYTD

boolean PayStubFactory::setIsReCalculatingYTD($bool)

Visibility: public
This method is defined by PayStubFactory

Arguments

$bool mixed

getEnableEmail

boolean PayStubFactory::getEnableEmail()

Visibility: public
This method is defined by PayStubFactory

setEnableEmail

boolean PayStubFactory::setEnableEmail($bool)

Visibility: public
This method is defined by PayStubFactory

Arguments

$bool mixed

getEnableLinkedAccruals

boolean PayStubFactory::getEnableLinkedAccruals()

Visibility: public
This method is defined by PayStubFactory

setEnableLinkedAccruals

boolean PayStubFactory::setEnableLinkedAccruals($bool)

Visibility: public
This method is defined by PayStubFactory

Arguments

$bool mixed

CalcDifferences

boolean PayStubFactory::CalcDifferences(string $pay_stub_id1, string $pay_stub_id2, integer $pay_stub_2_end_date, integer $ps_amendment_date)

Visibility: public
This method is static.
This method is defined by PayStubFactory

Arguments

$pay_stub_id1 string - UUID
$pay_stub_id2 string - UUID
$pay_stub_2_end_date integer - EPOCH
$ps_amendment_date integer - EPOCH

reCalculatePayStubYTD

boolean PayStubFactory::reCalculatePayStubYTD(string $pay_stub_id, boolean $enable_email)

Visibility: public
This method is defined by PayStubFactory

Arguments

$pay_stub_id string - UUID
$enable_email boolean

reCalculateCurrentYTD

boolean PayStubFactory::reCalculateCurrentYTD()

Visibility: public
This method is defined by PayStubFactory

reCalculateYTD

boolean PayStubFactory::reCalculateYTD()

Visibility: public
This method is defined by PayStubFactory

preSave

boolean PayStubFactory::preSave()

Visibility: public
This method is defined by PayStubFactory

Validate

boolean PayStubFactory::Validate(boolean $ignore_warning)

Visibility: public
This method is defined by PayStubFactory

Arguments

$ignore_warning boolean

ValidateEntries

boolean PayStubFactory::ValidateEntries()

Visibility: public
This method is defined by PayStubFactory

ValidateTransactions

boolean PayStubFactory::ValidateTransactions()

Visibility: public
This method is defined by PayStubFactory

postSave

boolean PayStubFactory::postSave()

Visibility: public
This method is defined by PayStubFactory

handlePayStubAmendmentStatuses

boolean PayStubFactory::handlePayStubAmendmentStatuses()

Visibility: public
This method is defined by PayStubFactory

handleUserExpenseStatuses

boolean PayStubFactory::handleUserExpenseStatuses()

Visibility: public
This method is defined by PayStubFactory

isAccrualBalanceOutstanding

boolean PayStubFactory::isAccrualBalanceOutstanding()

Visibility: public
This method is defined by PayStubFactory

getPayStubEntryAccountsArray

array|boolean|null PayStubFactory::getPayStubEntryAccountsArray()

Visibility: public
This method is defined by PayStubFactory

getPayStubEntryAccountArray

boolean|mixed PayStubFactory::getPayStubEntryAccountArray(string $id)

Visibility: public
This method is defined by PayStubFactory

Arguments

$id string - UUID

getSumByEntriesArrayAndTypeIDAndPayStubAccountID

array|boolean PayStubFactory::getSumByEntriesArrayAndTypeIDAndPayStubAccountID($ps_entries, integer $type_ids, string $ps_account_ids)

Visibility: public
This method is defined by PayStubFactory

Arguments

$ps_entries mixed
$type_ids integer - ID
$ps_account_ids string - UUID

calculateTemporaryTotals

mixed PayStubFactory::calculateTemporaryTotals($entries)

Calculate the real-time total accounts while the pay stub is being generated. This should allow Tax/Deductions records to calculate based on including/excluding Net Pay.

This only needs to work on 'current' PS entries, as previous entries should already have the net pay calculated.

Visibility: public
This method is defined by PayStubFactory

Arguments

$entries mixed - array

loadCurrentPayStubTransactions

mixed PayStubFactory::loadCurrentPayStubTransactions()

Visibility: public
This method is defined by PayStubFactory

loadCurrentPayStubEntries

boolean PayStubFactory::loadCurrentPayStubEntries()

Visibility: public
This method is defined by PayStubFactory

loadPreviousPayStub

boolean PayStubFactory::loadPreviousPayStub()

Visibility: public
This method is defined by PayStubFactory

prepareEntry

boolean PayStubFactory::prepareEntry(string $pay_stub_entry_account_id, $amount, null $units, null $rate, null $description, string $ps_amendment_id, null $ytd_amount, null $ytd_units, boolean $ytd_adjustment, string $user_expense_id)

Prepares the Pay Stub entry for adding.

Visibility: public
This method is defined by PayStubFactory

Arguments

$pay_stub_entry_account_id string - UUID
$amount mixed
$units null
$rate null
$description null
$ps_amendment_id string - UUID
$ytd_amount null
$ytd_units null
$ytd_adjustment boolean
$user_expense_id string - UUID

addEntry

boolean PayStubFactory::addEntry(string $pay_stub_entry_account_id, $amount, null $units, null $rate, null $description, string $ps_amendment_id, null $ytd_amount, null $ytd_units, boolean $ytd_adjustment, string $user_expense_id)

Visibility: public
This method is defined by PayStubFactory

Arguments

$pay_stub_entry_account_id string - UUID
$amount mixed
$units null
$rate null
$description null
$ps_amendment_id string - UUID
$ytd_amount null
$ytd_units null
$ytd_adjustment boolean
$user_expense_id string - UUID

processEntries

boolean PayStubFactory::processEntries()

Visibility: public
This method is defined by PayStubFactory

markPayStubEntriesForYTDCalculation

boolean PayStubFactory::markPayStubEntriesForYTDCalculation($pay_stub_arr, boolean $clear_out_ytd)

Visibility: public
This method is defined by PayStubFactory

Arguments

$pay_stub_arr mixed
$clear_out_ytd boolean

calcPayStubEntriesYTD

boolean PayStubFactory::calcPayStubEntriesYTD()

Visibility: public
This method is defined by PayStubFactory

savePayStubEntries

boolean PayStubFactory::savePayStubEntries()

Visibility: public
This method is defined by PayStubFactory

deleteZeroAmountEntries

boolean PayStubFactory::deleteZeroAmountEntries()

There may be cases where Tax/Deduction records need to do calculations on hours (ie: unpaid absences) when there is no pay, but they need to do other calculations to add pay.

So we need to make sure all paid and unpaid time ($0 amounts) from the timesheets still appears on the pay stubs initially, then gets deleted off after all Tax/Deductions are calculated.

Visibility: public
This method is defined by PayStubFactory

deleteEntries

boolean PayStubFactory::deleteEntries(boolean $all_entries)

Visibility: public
This method is defined by PayStubFactory

Arguments

$all_entries boolean

addUnUsedYTDEntries

boolean PayStubFactory::addUnUsedYTDEntries()

Visibility: public
This method is defined by PayStubFactory

addEarningSum

boolean PayStubFactory::addEarningSum()

Visibility: public
This method is defined by PayStubFactory

addDeductionSum

boolean PayStubFactory::addDeductionSum()

Visibility: public
This method is defined by PayStubFactory

addEmployerDeductionSum

boolean PayStubFactory::addEmployerDeductionSum()

Visibility: public
This method is defined by PayStubFactory

getNetPaySum

mixed PayStubFactory::getNetPaySum()

Visibility: public
This method is defined by PayStubFactory

addNetPay

boolean PayStubFactory::addNetPay()

Visibility: public
This method is defined by PayStubFactory

getEarningSum

array PayStubFactory::getEarningSum()

Visibility: public
This method is defined by PayStubFactory

getTotalTransactions

integer PayStubFactory::getTotalTransactions()

Visibility: public
This method is defined by PayStubFactory

getTotalPendingTransactions

integer PayStubFactory::getTotalPendingTransactions()

Visibility: public
This method is defined by PayStubFactory

getTransactionsSum

integer|string PayStubFactory::getTransactionsSum()

Visibility: public
This method is defined by PayStubFactory

getDeductionSum

array PayStubFactory::getDeductionSum()

Visibility: public
This method is defined by PayStubFactory

getEmployerDeductionSum

array PayStubFactory::getEmployerDeductionSum()

Visibility: public
This method is defined by PayStubFactory

getGrossPay

boolean|integer|mixed PayStubFactory::getGrossPay()

Visibility: public
This method is defined by PayStubFactory

getDeductions

boolean|integer|mixed PayStubFactory::getDeductions()

Visibility: public
This method is defined by PayStubFactory

getNetPay

boolean|integer|mixed PayStubFactory::getNetPay()

Visibility: public
This method is defined by PayStubFactory

checkNoEarnings

boolean PayStubFactory::checkNoEarnings()

Visibility: public
This method is defined by PayStubFactory

checkEarnings

boolean PayStubFactory::checkEarnings()

Returns TRUE unless Amount explicitly does not match Gross Pay use checkNoEarnings to see if any earnings exist or not.

Visibility: public
This method is defined by PayStubFactory

checkTransactions

boolean PayStubFactory::checkTransactions()

Visibility: public
This method is defined by PayStubFactory

checkDeductions

boolean PayStubFactory::checkDeductions()

Visibility: public
This method is defined by PayStubFactory

checkNetPay

boolean PayStubFactory::checkNetPay()

Visibility: public
This method is defined by PayStubFactory

checkNegativeNetPay

boolean PayStubFactory::checkNegativeNetPay()

Visibility: public
This method is defined by PayStubFactory

addTransaction

boolean PayStubFactory::addTransaction(object $pst_obj)

For the api to edit transactions ensure that you validate at the API before calling this method.

Visibility: public
This method is defined by PayStubFactory

Arguments

$pst_obj object

savePayStubTransactions

boolean PayStubFactory::savePayStubTransactions()

Visibility: public
This method is defined by PayStubFactory

calculateDefaultTransactions

boolean PayStubFactory::calculateDefaultTransactions()

Visibility: public
This method is defined by PayStubFactory

getEmailPayStubAddresses

array|boolean PayStubFactory::getEmailPayStubAddresses()

Visibility: public
This method is defined by PayStubFactory

emailPayStub

boolean PayStubFactory::emailPayStub()

Visibility: public
This method is defined by PayStubFactory

setObjectFromArray

boolean PayStubFactory::setObjectFromArray($data)

Visibility: public
This method is defined by PayStubFactory

Arguments

$data mixed

getObjectAsArray

mixed PayStubFactory::getObjectAsArray(null $include_columns, boolean $permission_children_ids)

Visibility: public
This method is defined by PayStubFactory

Arguments

$include_columns null
$permission_children_ids boolean

getFormObject

mixed PayStubFactory::getFormObject()

Visibility: public
This method is defined by PayStubFactory

getChequeFormsObject

mixed PayStubFactory::getChequeFormsObject($format)

Visibility: public
This method is defined by PayStubFactory

Arguments

$format mixed

getPayStub

boolean|string PayStubFactory::getPayStub(null $pslf, boolean $hide_employer_rows)

Visibility: public
This method is defined by PayStubFactory

Arguments

$pslf null
$hide_employer_rows boolean

addLog

boolean PayStubFactory::addLog($log_action)

Visibility: public
This method is defined by PayStubFactory

Arguments

$log_action mixed

__construct

mixed Factory::__construct()

Factory constructor.

Visibility: public
This method is defined by Factory

getAMFMessageID

boolean|null Factory::getAMFMessageID()

Used for updating progress bar for API calls.

Visibility: public
This method is defined by Factory

setAMFMessageID

boolean Factory::setAMFMessageID(string $id)

Visibility: public
This method is defined by Factory

Arguments

$id string - UUID

setProgressBarObject

boolean Factory::setProgressBarObject(object $obj)

Visibility: public
This method is defined by Factory

Arguments

$obj object

getProgressBarObject

null|\ProgressBar Factory::getProgressBarObject()

Visibility: public
This method is defined by Factory

setGenericObject

boolean Factory::setGenericObject(object $obj, string $variable)

Visibility: public
This method is defined by Factory

Arguments

$obj object
$variable string

getGenericObject

boolean Factory::getGenericObject(string $list_factory, string|integer $id, string $variable, string $list_factory_method, string $id_method)

Generic function to return and cache class objects ListFactory, ListFactoryMethod, Variable, ID, IDMethod

Visibility: public
This method is defined by Factory

Arguments

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

getCompanyGenericMapData

mixed Factory::getCompanyGenericMapData(string $company_id, integer $object_type_id, string $id, string $variable)

Visibility: public
This method is defined by Factory

Arguments

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

getGenericDataValue

boolean|mixed Factory::getGenericDataValue(string $name, $cast)

Visibility: public
This method is defined by Factory

Arguments

$name string
$cast mixed

setGenericDataValue

boolean Factory::setGenericDataValue(string $name, mixed $data, $cast)

Visibility: public
This method is defined by Factory

Arguments

$name string
$data mixed
$cast mixed

castGenericDataValue

mixed Factory::castGenericDataValue($value, $cast)

Generic casting function that all set/get*() functions should pass through.

However for now lets wait until we have meta data from SQL schema so we can pass those datatypes directly into this.

Visibility: public
This method is defined by Factory

Arguments

$value mixed - mixed
$cast mixed - string

getGenericTempDataValue

boolean Factory::getGenericTempDataValue(string $name)

Visibility: public
This method is defined by Factory

Arguments

$name string

setGenericTempDataValue

boolean Factory::setGenericTempDataValue(string $name, mixed $data)

Visibility: public
This method is defined by Factory

Arguments

$name string
$data mixed

getGenericOldDataValue

boolean|mixed Factory::getGenericOldDataValue(string $name)

Visibility: public
This method is defined by Factory

Arguments

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

getCache

boolean|mixed Factory::getCache(string $cache_id, string $group_id)

Visibility: public
This method is defined by Factory

Arguments

$cache_id string
$group_id string

saveCache

boolean Factory::saveCache(mixed $data, string $cache_id, string $group_id)

Visibility: public
This method is defined by Factory

Arguments

$data mixed
$cache_id string
$group_id string

removeCache

boolean Factory::removeCache(string $cache_id, string $group_id)

Visibility: public
This method is defined by Factory

Arguments

$cache_id string
$group_id string

setCacheLifeTime

boolean Factory::setCacheLifeTime(integer $secs)

Visibility: public
This method is defined by Factory

Arguments

$secs integer

serializeRS

string Factory::serializeRS(object $rs)

Visibility: public
This method is defined by Factory

Arguments

$rs object

unserializeRS

mixed Factory::unserializeRS(string $rs)

Visibility: public
This method is defined by Factory

Arguments

$rs string

getTable

boolean|string Factory::getTable(boolean $strip_quotes)

Visibility: public
This method is defined by Factory

Arguments

$strip_quotes boolean

getColumn

boolean|mixed Factory::getColumn(string $column)

Visibility: public
This method is defined by Factory

Arguments

$column string

__toString

boolean|string Factory::__toString()

Visibility: public
This method is defined by Factory

toBool

integer Factory::toBool(string|integer|boolean $value)

Visibility: public
This method is defined by Factory

Arguments

$value string|integer|boolean

fromBool

boolean Factory::fromBool(string|integer|boolean $value)

Visibility: public
This method is defined by Factory

Arguments

$value string|integer|boolean

isNew

boolean Factory::isNew(boolean $force_lookup, string $id)

Determines if the data is new data, or updated data. Basically determines if a database INSERT or UPDATE SQL statement is generated.

Visibility: public
This method is defined by Factory

Arguments

$force_lookup boolean
$id string - UUID

getLabelId

boolean|mixed|string Factory::getLabelId()

Visibility: public
This method is defined by Factory

getId

boolean|mixed Factory::getId()

Visibility: public
This method is defined by Factory

setId

boolean Factory::setId(string $id)

Visibility: public
This method is defined by Factory

Arguments

$id string - UUID

getEnableSystemLogDetail

boolean Factory::getEnableSystemLogDetail()

Visibility: public
This method is defined by Factory

setEnableSystemLogDetail

boolean Factory::setEnableSystemLogDetail($bool)

Visibility: public
This method is defined by Factory

Arguments

$bool mixed

getDeleted

boolean Factory::getDeleted()

Visibility: public
This method is defined by Factory

setDeleted

boolean Factory::setDeleted(boolean $bool)

Visibility: public
This method is defined by Factory

Arguments

$bool boolean

getCreatedDate

integer Factory::getCreatedDate()

Visibility: public
This method is defined by Factory

setCreatedDate

boolean Factory::setCreatedDate(integer $epoch)

Visibility: public
This method is defined by Factory

Arguments

$epoch integer - EPOCH

getCreatedBy

boolean|mixed Factory::getCreatedBy()

Visibility: public
This method is defined by Factory

setCreatedBy

boolean Factory::setCreatedBy(string $id)

Visibility: public
This method is defined by Factory

Arguments

$id string - UUID

getUpdatedDate

integer Factory::getUpdatedDate()

Visibility: public
This method is defined by Factory

setUpdatedDate

boolean|integer|null|string Factory::setUpdatedDate(integer $epoch)

Visibility: public
This method is defined by Factory

Arguments

$epoch integer - EPOCH

getUpdatedBy

boolean|mixed Factory::getUpdatedBy()

Visibility: public
This method is defined by Factory

setUpdatedBy

boolean|null Factory::setUpdatedBy(string $id)

Visibility: public
This method is defined by Factory

Arguments

$id string - UUID

getDeletedDate

boolean|mixed Factory::getDeletedDate()

Visibility: public
This method is defined by Factory

setDeletedDate

boolean Factory::setDeletedDate(integer $epoch)

Visibility: public
This method is defined by Factory

Arguments

$epoch integer - EPOCH

getDeletedBy

boolean|mixed Factory::getDeletedBy()

Visibility: public
This method is defined by Factory

setDeletedBy

boolean|null Factory::setDeletedBy(string $id)

Visibility: public
This method is defined by Factory

Arguments

$id string - UUID

setIsValid

boolean Factory::setIsValid(boolean $is_valid)

Sets the is_valid flag, mostly used to set it to FALSE to force a full re-validation.

Required because $this->is_valid is a private variable and should stay that way.

Visibility: public
This method is defined by Factory

Arguments

$is_valid boolean

setCreatedAndUpdatedColumns

boolean Factory::setCreatedAndUpdatedColumns(array $data, array $variable_to_function_map)

Visibility: public
This method is defined by Factory

Arguments

$data array
$variable_to_function_map array

getCreatedAndUpdatedColumns

boolean Factory::getCreatedAndUpdatedColumns(array $data, null $include_columns)

Visibility: public
This method is defined by Factory

Arguments

$data array
$include_columns null

getPermissionColumns

boolean Factory::getPermissionColumns(array $data, string $object_user_id, string $created_by_id, string $permission_children_ids, array $include_columns)

Visibility: public
This method is defined by Factory

Arguments

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

getOptions

array|boolean Factory::getOptions(string $name, string|integer $parent)

Visibility: public
This method is defined by Factory

Arguments

$name string
$parent string|integer

getVariableToFunctionMap

array|boolean Factory::getVariableToFunctionMap(array $data)

Visibility: public
This method is defined by Factory

Arguments

$data array

getRecordCount

integer|boolean Factory::getRecordCount()

Visibility: public
This method is defined by Factory

getCurrentRow

integer|boolean Factory::getCurrentRow(integer $offset)

Visibility: public
This method is defined by Factory

Arguments

$offset integer

setQueryStatementTimeout

boolean Factory::setQueryStatementTimeout(null $milliseconds)

Visibility: public
This method is defined by Factory

Arguments

$milliseconds null

getRecordSetColumnList

array|boolean Factory::getRecordSetColumnList(object $rs)

Visibility: private
This method is defined by Factory

Arguments

$rs object

castInteger

boolean|integer|string Factory::castInteger(integer|string $int, string $type)

Visibility: protected
This method is defined by Factory

Arguments

$int integer|string
$type string

getListSQL

boolean|integer|string|array Factory::getListSQL(array|string|integer $array, array $ph, string|boolean $cast)

Visibility: protected
This method is defined by Factory

Arguments

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

getDateRangeSQL

boolean|string Factory::getDateRangeSQL(string $str, string $column, string $format, boolean $include_blank_dates)

Visibility: public
This method is defined by Factory

Arguments

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

handleSQLSyntax

string Factory::handleSQLSyntax(string $arg)

SQL where clause Syntax: or % as wildcard.

"" as exact match, no default wildcard and no metaphone

Handles '*' and '%' as wildcards, defaults to wildcard on the end always. If no wildcard is to be added, the last character should be |

Visibility: protected
This method is defined by Factory

Arguments

$arg string

stripSQLSyntax

mixed Factory::stripSQLSyntax(string $arg)

Visibility: protected
This method is defined by Factory

Arguments

$arg string

getSQLToTimeStampFunction

string Factory::getSQLToTimeStampFunction()

Visibility: protected
This method is defined by Factory

getDatabaseType

string Factory::getDatabaseType()

Visibility: protected
This method is defined by Factory

getGEOMAsTextFunction

string Factory::getGEOMAsTextFunction(string $sql)

Visibility: protected
This method is defined by Factory

Arguments

$sql string

getSQLToEpochFunction

string Factory::getSQLToEpochFunction(string $sql)

Visibility: protected
This method is defined by Factory

Arguments

$sql string

getSQLToTimeFunction

string Factory::getSQLToTimeFunction(string $sql)

Visibility: protected
This method is defined by Factory

Arguments

$sql string

getSQLStringAggregate

string Factory::getSQLStringAggregate(string $sql, string $glue)

Visibility: protected
This method is defined by Factory

Arguments

$sql string
$glue string

getWhereClauseSQL

null|string Factory::getWhereClauseSQL(array|string $columns, array|string $args, string $type, array $ph, string $query_stub, boolean $and)

Visibility: protected
This method is defined by Factory

Arguments

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

parseColumnName

boolean|string Factory::parseColumnName(string $column)

Visibility: private
This method is defined by Factory

Arguments

$column string

getWhereSQL

boolean|string Factory::getWhereSQL(array $array, boolean $append_where)

Visibility: protected
This method is defined by Factory

Arguments

$array array
$append_where boolean

getColumnsFromAliases

array Factory::getColumnsFromAliases(array $columns, array $aliases)

Visibility: protected
This method is defined by Factory

Arguments

$columns array
$aliases array

convertFlexArray

array Factory::convertFlexArray(array $array)

Visibility: public
This method is defined by Factory

Arguments

$array array

getValidSQLColumns

array Factory::getValidSQLColumns(array $array, boolean $strict, array $additional_fields)

Visibility: public
This method is defined by Factory

Arguments

$array array
$strict boolean
$additional_fields array

getSortSQL

boolean|string Factory::getSortSQL(array $array, boolean $strict, array $additional_fields)

Visibility: protected
This method is defined by Factory

Arguments

$array array
$strict boolean
$additional_fields array

getColumnList

array|boolean Factory::getColumnList()

Visibility: public
This method is defined by Factory

getEmptyRecordSet

mixed Factory::getEmptyRecordSet(string $id)

Visibility: public
This method is defined by Factory

Arguments

$id string - UUID

getUpdateQuery

boolean Factory::getUpdateQuery()

Visibility: private
This method is defined by Factory

getInsertQuery

mixed Factory::getInsertQuery()

Visibility: private
This method is defined by Factory

StartTransaction

mixed Factory::StartTransaction()

Visibility: public
This method is defined by Factory

FailTransaction

mixed Factory::FailTransaction()

Visibility: public
This method is defined by Factory

CommitTransaction

mixed Factory::CommitTransaction()

Visibility: public
This method is defined by Factory

setTransactionMode

mixed Factory::setTransactionMode(string $mode)

Visibility: public
This method is defined by Factory

Arguments

$mode string

getTransactionMode

string Factory::getTransactionMode()

Visibility: public
This method is defined by Factory

isValid

boolean Factory::isValid(boolean $ignore_warning)

Visibility: public
This method is defined by Factory

Arguments

$ignore_warning boolean

isWarning

boolean Factory::isWarning()

Visibility: public
This method is defined by Factory

getSequenceName

boolean Factory::getSequenceName()

Visibility: public
This method is defined by Factory

getNextInsertId

boolean|string Factory::getNextInsertId()

Visibility: public
This method is defined by Factory

ExecuteSQL

boolean Factory::ExecuteSQL(string $query, array $ph, integer $limit, integer $page)

Visibility: public
This method is defined by Factory

Arguments

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

RetryExecuteSQL

boolean Factory::RetryExecuteSQL(string $query, array $ph, integer $retry_max_attempts, integer $sleep)

Visibility: public
This method is defined by Factory

Arguments

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

getDataDifferences

array Factory::getDataDifferences()

Returns the differences in data from the DB vs the in-memory object, so the data will be the OLD data. Used in Validation/postSave() functions to determine if a field has changed or not.

Visibility: public
This method is defined by Factory

isDataDifferent

boolean Factory::isDataDifferent($key, $data_diff, null $type_id, null $new_data)

Used to check the differences between a single key in the $old_data vs. $data arrays.

This is especially important to use when trying to see if a date or timestamp field in the DB has changed, as they need to be handled in special ways.

Visibility: public
This method is defined by Factory

Arguments

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

Save

boolean|integer|string Factory::Save(boolean $reset_data, boolean $force_lookup)

Visibility: public
This method is defined by Factory

Arguments

$reset_data boolean
$force_lookup boolean

Delete

boolean Factory::Delete()

Visibility: public
This method is defined by Factory

getIDSByListFactory

array|boolean Factory::getIDSByListFactory(object $lf)

Visibility: public
This method is defined by Factory

Arguments

$lf object

bulkDelete

boolean Factory::bulkDelete(string|array $ids)

Visibility: public
This method is defined by Factory

Arguments

$ids string|array - UUID

clearGeoCode

boolean Factory::clearGeoCode(array $data_diff)

Visibility: public
This method is defined by Factory

Arguments

$data_diff array

clearNonMappedData

array|null Factory::clearNonMappedData(array|null $data)

Removes array elements from $data that are not in the function map.

Visibility: public
This method is defined by Factory

Arguments

$data array|null

clearData

boolean Factory::clearData()

Visibility: public
This method is defined by Factory

clearOldData

boolean Factory::clearOldData()

Visibility: public
This method is defined by Factory

getIterator

\FactoryListIterator Factory::getIterator()

Visibility: public
This method is defined by Factory

getCurrent

mixed Factory::getCurrent()

Visibility: public
This method is defined by Factory

CalculatePayStub - staffcheck/api GitHub Wiki

CalculatePayStub

Properties

$transaction_date

$wage_obj

$user_obj

$user_wage_obj

$pay_period_obj

$pay_period_schedule_obj

$payroll_deduction_obj

$pay_stub_entry_account_link_obj

$pay_stub_entry_accounts_type_obj

$table

$pk_sequence_name

$tmp_data

$is_unique_pay_stub

$is_unique_pay_stub_type

$currency_obj

$pay_stub_entry_accounts_obj

$old_currency_id

$validate_only

$data

$old_data

$enable_system_log_detail

$progress_bar_obj

$AMF_message_id

$Validator

$is_valid

Methods

getUser

setUser

Arguments

getPayPeriod

setPayPeriod

Arguments

getRun

setRun

Arguments

getType

setType

Arguments

getTransactionDate

Arguments

setTransactionDate

Arguments

getEnablePostTerminationCalculation

setEnablePostTerminationCalculation

Arguments

getEnableCorrection

setEnableCorrection

Arguments

getUserObject

getPayStubEntryAccountLinkObject

getPayPeriodObject

getPayPeriodScheduleObject

getWageObject

getPayStubEntryAccountsTypeArray

getDeductionObjectSortValue

Arguments

getDeductionObjectArrayForSorting

Arguments

getOrderedDeductionAndPSAmendment

Arguments

calculate

_getFactoryOptions

Arguments

_getVariableToFunctionMap

Arguments

getCurrencyObject

getDisplayID

getCurrency

setCurrency

Arguments

getCurrencyRate

setCurrencyRate

Arguments

isValidStartDate

Arguments

getStartDate

Arguments