package Core

 Methods

BreakTimePolicySortByTriggerTimeAsc()

BreakTimePolicySortByTriggerTimeAsc($a, $b) 

Parameters

$a

$b

RegularTimePolicySortByCalculationOrderAsc()

RegularTimePolicySortByCalculationOrderAsc($a, $b) 

Parameters

$a

$b

Save()

Save() 

UserWageSortByEffectiveDateDesc()

UserWageSortByEffectiveDateDesc($a, $b) 

Parameters

$a

$b

__construct()

__construct($user_obj = NULL

Parameters

$user_obj

addCalculatedDate()

addCalculatedDate($date_stamp) 

Parameters

$date_stamp

addPendingCalculationDate()

addPendingCalculationDate($start_date, $end_date = NULL

Parameters

$start_date

$end_date

calculate()

calculate($date_stamp = FALSE

Parameters

$date_stamp

calculateAbsenceTimePolicy()

calculateAbsenceTimePolicy($date_stamp) 

Parameters

$date_stamp

calculateAccrualPolicy()

calculateAccrualPolicy() 

calculateBreakTimePolicy()

calculateBreakTimePolicy($date_stamp) 

Parameters

$date_stamp

calculateExceptionPolicy()

calculateExceptionPolicy($date_stamp) 

Parameters

$date_stamp

calculateHolidayPolicy()

calculateHolidayPolicy($date_stamp) 

Parameters

$date_stamp

calculateMealTimePolicy()

calculateMealTimePolicy($date_stamp) 

Parameters

$date_stamp

calculateOverTimeHourlyRates()

calculateOverTimeHourlyRates($user_date_total_records) 

Parameters

$user_date_total_records

calculateOverTimePolicy()

calculateOverTimePolicy($date_stamp, $trigger_time_arr, $maximum_daily_total_time = NULL

Parameters

$date_stamp

$trigger_time_arr

$maximum_daily_total_time

calculateOverTimePolicyForTriggerTime()

calculateOverTimePolicyForTriggerTime($date_stamp, $current_trigger_time_arr, $prev_policy_data = FALSE

Parameters

$date_stamp

$current_trigger_time_arr

$prev_policy_data

calculatePremiumTimePolicy()

calculatePremiumTimePolicy($date_stamp, $maximum_daily_total_time = NULL

Parameters

$date_stamp

$maximum_daily_total_time

calculateRegularTimeExclusivity()

calculateRegularTimeExclusivity() 

calculateRegularTimePolicy()

calculateRegularTimePolicy($date_stamp, $maximum_daily_total_time = NULL

Parameters

$date_stamp

$maximum_daily_total_time

calculateScheduleAbsence()

calculateScheduleAbsence($date_stamp) 

Parameters

$date_stamp

calculateSystemTotalTime()

calculateSystemTotalTime($date_stamp, $tmp_system_total_time) 

Parameters

$date_stamp

$tmp_system_total_time

calculateUnderTimeAbsencePolicy()

calculateUnderTimeAbsencePolicy($date_stamp) 

Parameters

$date_stamp

calculateUserDateTotalStartAndEndTimeStamps()

calculateUserDateTotalStartAndEndTimeStamps($udt_obj) 

Parameters

$udt_obj

compactMealAndBreakUserDateTotalObjects()

compactMealAndBreakUserDateTotalObjects($user_date_total_rows) 

Parameters

$user_date_total_rows

compactUserDateTotalDataBasedOnOverride()

compactUserDateTotalDataBasedOnOverride($udtlf) 

Parameters

$udtlf

compactUserDateTotalDataBasedOnTimeStamps()

compactUserDateTotalDataBasedOnTimeStamps($udtlf) 

Parameters

$udtlf

deleteSystemTotalTime()

deleteSystemTotalTime($date_stamp) 

Parameters

$date_stamp

filterBreakTimePolicy()

filterBreakTimePolicy($date_stamp, $daily_total_time = NULL, $type_id = NULL, $always_return_at_least_one = FALSE

Parameters

$date_stamp

$daily_total_time

$type_id

$always_return_at_least_one

filterCurrencyRate()

filterCurrencyRate($date_stamp) 

Parameters

$date_stamp

filterHoliday()

filterHoliday($date_stamp, $holiday_policy_obj = NULL, $assigned_to_policy_group = NULL

Parameters

$date_stamp

$holiday_policy_obj

$assigned_to_policy_group

filterMealTimePolicy()

filterMealTimePolicy($date_stamp, $daily_total_time = NULL, $type_id = NULL, $always_return_at_least_one = FALSE

Parameters

$date_stamp

$daily_total_time

$type_id

$always_return_at_least_one

filterOverTimePolicy()

filterOverTimePolicy($date_stamp) 

Parameters

$date_stamp

filterPremiumTimePolicy()

filterPremiumTimePolicy($date_stamp) 

Parameters

$date_stamp

filterPunchDataByDateAndTypeAndStatus()

filterPunchDataByDateAndTypeAndStatus($date_stamp, $type_ids = NULL, $status_ids = NULL

Parameters

$date_stamp

$type_ids

$status_ids

filterRegularTimePolicy()

filterRegularTimePolicy($date_stamp) 

Parameters

$date_stamp

filterScheduleDataByDateAndDirection()

filterScheduleDataByDateAndDirection($pivot_date = NULL, $status_ids = NULL, $direction = NULL, $limit = NULL

Parameters

$pivot_date

$status_ids

$direction

$limit

filterScheduleDataByShiftStartAndEnd()

filterScheduleDataByShiftStartAndEnd($start_time, $end_time, $schedule_status_id = FALSE

Parameters

$start_time

$end_time

$schedule_status_id

filterScheduleDataByStatus()

filterScheduleDataByStatus($start_date, $end_date, $status_ids = NULL

Parameters

$start_date

$end_date

$status_ids

filterSchedulePolicyByDate()

filterSchedulePolicyByDate($date_stamp, $force_all_scheduled_shifts = FALSE

Parameters

$date_stamp

$force_all_scheduled_shifts

filterUnderTimeAbsencePolicy()

filterUnderTimeAbsencePolicy($date_stamp) 

Parameters

$date_stamp

filterUserDateTotalDataByContributingShiftPolicy()

filterUserDateTotalDataByContributingShiftPolicy($start_date, $end_date, $contributing_shift_policy_obj, $object_type_ids = NULL, $additional_pay_code_ids = array(), $additional_src_object_ids = array()

Parameters

$start_date

$end_date

$contributing_shift_policy_obj

$object_type_ids

$additional_pay_code_ids

$additional_src_object_ids

filterUserDateTotalDataByObjectTypeIDs()

filterUserDateTotalDataByObjectTypeIDs($start_date, $end_date, $object_type_ids = NULL

Parameters

$start_date

$end_date

$object_type_ids

filterUserDateTotalDataByPayCodeIDs()

filterUserDateTotalDataByPayCodeIDs($start_date, $end_date, $pay_code_ids = NULL

Parameters

$start_date

$end_date

$pay_code_ids

filterUserDateTotalDataByPunchTypeIDs()

filterUserDateTotalDataByPunchTypeIDs($start_date, $end_date, $punch_type_ids = NULL

Parameters

$start_date

$end_date

$punch_type_ids

filterUserWage()

filterUserWage($wage_group_id, $date_stamp) 

Parameters

$wage_group_id

$date_stamp

filterWeeklyOverTimePolicy()

filterWeeklyOverTimePolicy() 

getAccrualPolicy()

getAccrualPolicy() 

getAverageHourlyRate()

getAverageHourlyRate($date_stamp, $hour_contributing_shift_policy_obj, $hour_object_type_ids, $wage_contributing_shift_policy_obj) 

Parameters

$date_stamp

$hour_contributing_shift_policy_obj

$hour_object_type_ids

$wage_contributing_shift_policy_obj

getBaseHourlyRate()

getBaseHourlyRate($pay_formula_policy_id, $pay_code_id, $date_stamp, $contributing_pay_code_hourly_rate = FALSE, $contributing_shift_policy_obj = NULL, $object_type_ids = NULL

Parameters

$pay_formula_policy_id

$pay_code_id

$date_stamp

$contributing_pay_code_hourly_rate

$contributing_shift_policy_obj

$object_type_ids

getBreakTimePolicy()

getBreakTimePolicy() 

getCalculatedDateRange()

getCalculatedDateRange() 

getContributingPayCodePolicy()

getContributingPayCodePolicy() 

getContributingShiftPolicy()

getContributingShiftPolicy() 

getCurrencyRateData()

getCurrencyRateData($start_date, $end_date) 

Parameters

$start_date

$end_date

getDateRangeFromDateArray()

getDateRangeFromDateArray($date_arr) 

Parameters

$date_arr

getDatesToObtainDataFor()

getDatesToObtainDataFor($date_stamp) 

Parameters

$date_stamp

getDayArrayUserDateTotalData()

getDayArrayUserDateTotalData($user_date_total_arr) 

Parameters

$user_date_total_arr

getExceptionData()

getExceptionData($start_date = NULL, $end_date = NULL

Parameters

$start_date

$end_date

getExceptionPolicy()

getExceptionPolicy() 

getFirstPendingDate()

getFirstPendingDate() 

getFlag()

getFlag($key) 

Parameters

$key

getHolidayData()

getHolidayData($start_date, $end_date, $enable_recalculate_holiday = TRUE

Parameters

$start_date

$end_date

$enable_recalculate_holiday

getHolidayPolicy()

getHolidayPolicy() 

getHolidayTime()

getHolidayTime($date_stamp, $holiday_policy_obj) 

Parameters

$date_stamp

$holiday_policy_obj

getHourlyRate()

getHourlyRate($pay_formula_policy_id, $pay_code_id, $date_stamp, $base_hourly_rate) 

Parameters

$pay_formula_policy_id

$pay_code_id

$date_stamp

$base_hourly_rate

getHourlyRateWithBurden()

getHourlyRateWithBurden($pay_formula_policy_id, $pay_code_id, $date_stamp, $base_hourly_rate = 0

Parameters

$pay_formula_policy_id

$pay_code_id

$date_stamp

$base_hourly_rate

getLastPendingDate()

getLastPendingDate() 

getMealTimePolicy()

getMealTimePolicy() 

getNextPendingDate()

getNextPendingDate() 

getOverTimePeriodDates()

getOverTimePeriodDates($date_stamp, $weeks, $first_pay_period_start_date, $start_week_day_id = 0

Parameters

$date_stamp

$weeks

$first_pay_period_start_date

$start_week_day_id

getOverTimePolicy()

getOverTimePolicy() 

getOverTimeTriggerArray()

getOverTimeTriggerArray($date_stamp) 

Parameters

$date_stamp

getOverTimeTriggerTimeAdjustAmount()

getOverTimeTriggerTimeAdjustAmount($start_date, $end_date, $otp_obj) 

Parameters

$start_date

$end_date

$otp_obj

getPayCode()

getPayCode() 

getPayFormulaPolicy()

getPayFormulaPolicy() 

getPayFormulaPolicyObjectByPayFormulaIdOrPayCodeId()

getPayFormulaPolicyObjectByPayFormulaIdOrPayCodeId($pay_formula_policy_id, $pay_code_id) 

Parameters

$pay_formula_policy_id

$pay_code_id

getPayFormulaPolicyObjectByPolicyObject()

getPayFormulaPolicyObjectByPolicyObject($obj) 

Parameters

$obj

getPayPeriodObject()

getPayPeriodObject($id) 

Parameters

$id

getPayPeriodScheduleObject()

getPayPeriodScheduleObject($id) 

Parameters

$id

getPremiumTimePolicy()

getPremiumTimePolicy() 

getPreviousDayByUserTotalData()

getPreviousDayByUserTotalData($user_date_total_arr, $date_stamp) 

Parameters

$user_date_total_arr

$date_stamp

getPunchData()

getPunchData($start_date, $end_date) 

Parameters

$start_date

$end_date

getRegularTimePolicy()

getRegularTimePolicy() 

getRequiredData()

getRequiredData($date_stamp, $enable_recalculate_holiday = TRUE

Parameters

$date_stamp

$enable_recalculate_holiday

getScheduleData()

getScheduleData($start_date = NULL, $end_date = NULL, $status_ids = NULL, $limit = NULL, $order = NULL

Parameters

$start_date

$end_date

$status_ids

$limit

$order

getScheduleDates()

getScheduleDates($schedule_arr) 

Parameters

$schedule_arr

getSchedulePolicy()

getSchedulePolicy() 

getShiftData()

getShiftData($user_date_total_arr, $epoch = NULL, $filter = NULL, $maximum_shift_time = NULL, $new_shift_trigger_time = NULL

Parameters

$user_date_total_arr

$epoch

$filter

$maximum_shift_time

$new_shift_trigger_time

getShiftStartAndEndUserDateTotal()

getShiftStartAndEndUserDateTotal($start_date, $end_date) 

Parameters

$start_date

$end_date

getSumScheduleTime()

getSumScheduleTime($schedule_arr) 

Parameters

$schedule_arr

getSumScheduledDays()

getSumScheduledDays($schedule_arr) 

Parameters

$schedule_arr

getSumUserDateTotalData()

getSumUserDateTotalData($user_date_total_arr) 

Parameters

$user_date_total_arr

getUnderTimeAbsenceTimePolicy()

getUnderTimeAbsenceTimePolicy() 

getUserDateTotalData()

getUserDateTotalData($start_date = NULL, $end_date = NULL

Parameters

$start_date

$end_date

getUserObject()

getUserObject() 

getUserWageData()

getUserWageData($start_date, $end_date) 

Parameters

$start_date

$end_date

getWeeklyOverTimePolicyIDs()

getWeeklyOverTimePolicyIDs() 

getWeeklyOverTimePolicyPayCodes()

getWeeklyOverTimePolicyPayCodes() 

insertUserDateTotal()

insertUserDateTotal($user_date_total_records) 

Parameters

$user_date_total_records

isConflictingUserDateTotal()

isConflictingUserDateTotal($date_stamp, $object_type_id, $pay_code_id = NULL, $branch_id = NULL, $department_id = NULL, $job_id = NULL, $job_item_id = NULL

Parameters

$date_stamp

$object_type_id

$pay_code_id

$branch_id

$department_id

$job_id

$job_item_id

isEligibleForHoliday()

isEligibleForHoliday($date_stamp, $holiday_policy_obj, $ignore_after_eligibility = FALSE

Parameters

$date_stamp

$holiday_policy_obj

$ignore_after_eligibility

isOverriddenUserDateTotalObject()

isOverriddenUserDateTotalObject($udt_obj) 

Parameters

$udt_obj

isPastDateCalculationRequired()

isPastDateCalculationRequired() 

isPayFormulaAccruing()

isPayFormulaAccruing($pay_formula_policy_obj) 

Parameters

$pay_formula_policy_obj

isPayFormulaPolicyAveraging()

isPayFormulaPolicyAveraging($pay_formula_policy_id, $pay_code_id) 

Parameters

$pay_formula_policy_id

$pay_code_id

isSecondBiWeeklyOverTimeWeek()

isSecondBiWeeklyOverTimeWeek($date_stamp, $first_pay_period_start_date, $start_week_day_id = 0

Parameters

$date_stamp

$first_pay_period_start_date

$start_week_day_id

processTriggerTimeArray()

processTriggerTimeArray($date_stamp, $trigger_time_arr) 

Parameters

$date_stamp

$trigger_time_arr

removeRedundantUserDateTotalObjects()

removeRedundantUserDateTotalObjects() 

revertTimeZone()

revertTimeZone() 

setFlag()

setFlag($key, $value = TRUE

Parameters

$key

$value

setPayPeriodFromDate()

setPayPeriodFromDate($date_stamp) 

Parameters

$date_stamp

setTimeZone()

setTimeZone() 

setUserObject()

setUserObject($obj) 

Parameters

$obj

sortPolicyByPayCodeDependancy()

sortPolicyByPayCodeDependancy($policy_arr) 

Parameters

$policy_arr

sortScheduleByDateASC()

sortScheduleByDateASC($a, $b) 

Parameters

$a

$b

sortScheduleByDateDESC()

sortScheduleByDateDESC($a, $b) 

Parameters

$a

$b

sortUserDateTotalData()

sortUserDateTotalData($udtlf, $sort_function_name = 'sortUserDateTotalDataByDateAndObjectTypeAndStartTimeStampAndID'

Parameters

$udtlf

$sort_function_name

sortUserDateTotalDataByDateAndObjectTypeAndStartTimeStampAndID()

sortUserDateTotalDataByDateAndObjectTypeAndStartTimeStampAndID($a, $b) 

Parameters

$a

$b

sortUserDateTotalDataByObjectTypeDescAndID()

sortUserDateTotalDataByObjectTypeDescAndID($a, $b) 

Parameters

$a

$b

sortUserDateTotalDataByTimeStampAndAndObjectTypeAndID()

sortUserDateTotalDataByTimeStampAndAndObjectTypeAndID($a, $b) 

Parameters

$a

$b

testOverriddenUserDateTotalObject()

testOverriddenUserDateTotalObject($udt_obj, $tmp_udt_obj) 

Parameters

$udt_obj

$tmp_udt_obj

_calculate()

_calculate($date_stamp) 

Parameters

$date_stamp

 Properties

 

$holiday_policy

$holiday_policy 

Default

NULL
 

$user_date_total

$user_date_total 

Default

NULL
 

$user_date_total_insert_id

$user_date_total_insert_id 

Default

-1
 

$accrual_policy

$accrual_policy 

Default

NULL
 

$accrual_time_exclusivity_map

$accrual_time_exclusivity_map 

Default

NULL
 

$break_time_policy

$break_time_policy 

Default

NULL
 

$contributing_pay_code_policy

$contributing_pay_code_policy 

Default

NULL
 

$contributing_pay_codes_by_policy_id

$contributing_pay_codes_by_policy_id 

Default

NULL
 

$contributing_shift_policy

$contributing_shift_policy 

Default

NULL
 

$currency_rates

$currency_rates 

Default

NULL
 

$dates

$dates 

Default

array('data' => array(), 'pending_calculation' => array(), 'calculated' => array())
 

$delete_system_total_time_already_run

$delete_system_total_time_already_run 

Default

FALSE
 

$exception

$exception 

Default

NULL
 

$exception_policy

$exception_policy 

Default

NULL
 

$flags

$flags 

Default

array('meal' => TRUE, 'undertime_absence' => TRUE, 'break' => TRUE, 'holiday' => TRUE, 'schedule_absence' => TRUE, 'absence' => TRUE, 'regular' => TRUE, 'overtime' => TRUE, 'premium' => TRUE, 'accrual' => TRUE, 'exception' => TRUE, 'exception_premature' => FALSE, 'exception_future' => TRUE, 'future_dates' => TRUE, 'past_dates' => FALSE)
 

$holiday

$holiday 

Default

NULL
 

$is_eligible_holiday_description

$is_eligible_holiday_description 

Default

NULL
 

$meal_time_policy

$meal_time_policy 

Default

NULL
 

$new_system_user_date_total_id

$new_system_user_date_total_id 

Default

array()
 

$new_user_date_total_ids

$new_user_date_total_ids 

Default

NULL
 

$original_time_zone

$original_time_zone 

Default

NULL
 

$over_time_policy

$over_time_policy 

Default

NULL
 

$over_time_recurse_map

$over_time_recurse_map 

Default

NULL
 

$over_time_trigger_time_exclusivity_map

$over_time_trigger_time_exclusivity_map 

Default

NULL
 

$pay_codes

$pay_codes 

Default

NULL
 

$pay_formula_policy

$pay_formula_policy 

Default

NULL
 

$pay_period_obj

$pay_period_obj 

Default

NULL
 

$pay_period_schedule_obj

$pay_period_schedule_obj 

Default

NULL
 

$pay_period_schedules

$pay_period_schedules 

Default

NULL
 

$pay_periods

$pay_periods 

Default

NULL
 

$policy_group_holiday_policy_ids

$policy_group_holiday_policy_ids 

Default

NULL
 

$premium_time_policy

$premium_time_policy 

Default

NULL
 

$prev_user_date_total_end_time_stamp

$prev_user_date_total_end_time_stamp 

Default

NULL
 

$prev_user_date_total_start_time_stamp

$prev_user_date_total_start_time_stamp 

Default

NULL
 

$punch

$punch 

Default

NULL
 

$regular_time_exclusivity_map

$regular_time_exclusivity_map 

Default

NULL
 

$regular_time_policy

$regular_time_policy 

Default

NULL
 

$schedule

$schedule 

Default

NULL
 

$schedule_over_time_policy_ids

$schedule_over_time_policy_ids 

Default

NULL
 

$schedule_policy_break_time_policy

$schedule_policy_break_time_policy 

Default

NULL
 

$schedule_policy_max_start_stop_window

$schedule_policy_max_start_stop_window 

Default

0
 

$schedule_policy_meal_time_policy

$schedule_policy_meal_time_policy 

Default

NULL
 

$schedule_policy_rs

$schedule_policy_rs 

Default

NULL
 

$schedule_premium_time_policy_ids

$schedule_premium_time_policy_ids 

Default

NULL
 

$start_week_day_id

$start_week_day_id 

Default

0
 

$undertime_absence_policy

$undertime_absence_policy 

Default

NULL
 

$user_obj

$user_obj 

Default

NULL
 

$user_wages

$user_wages 

Default

NULL