Wage
in package
Table of Contents
- $advance : mixed
- $holiday_obj : mixed
- $labor_standard_obj : mixed
- $pay_period_id : mixed
- $pay_period_obj : mixed
- $pay_period_schedule_obj : mixed
- $pay_stub_entry_account_link_obj : mixed
- $user_date_total_arr : mixed
- $user_id : mixed
- $user_obj : mixed
- $user_pay_period_total_obj : mixed
- $user_tax_obj : mixed
- $user_wage_obj : mixed
- __construct() : mixed
- Wage constructor.
- compactUserDateTotalPayStubEntries() : array<string|int, mixed>
- Compact wage entries that have the same: user_wage_id, pay_stub_entry, rate and description.
- getAdvance() : bool
- getGrossWage() : int
- getMaximumPayPeriodWage() : string
- getPayPeriod() : null
- getPayPeriodObject() : bool|null
- getPayPeriodScheduleObject() : bool|null
- getPayStubAmendmentDeductions() : string
- getPayStubAmendmentEarnings() : string
- getPayStubEntryAccountLinkObject() : bool|null
- getRawGrossWage() : int
- getUser() : null
- getUserDateTotalArray() : array<string|int, mixed>|bool|null
- getUserObject() : bool|null
- getWage() : int|string
- setAdvance() : bool
- setUserDateTotalArray() : array<string|int, mixed>|bool
Properties
$advance
public
mixed
$advance
= \false
$holiday_obj
public
mixed
$holiday_obj
= \null
$labor_standard_obj
public
mixed
$labor_standard_obj
= \null
$pay_period_id
public
mixed
$pay_period_id
= \null
$pay_period_obj
public
mixed
$pay_period_obj
= \null
$pay_period_schedule_obj
public
mixed
$pay_period_schedule_obj
= \null
$pay_stub_entry_account_link_obj
public
mixed
$pay_stub_entry_account_link_obj
= \null
$user_date_total_arr
public
mixed
$user_date_total_arr
= \null
$user_id
public
mixed
$user_id
= \null
$user_obj
public
mixed
$user_obj
= \null
$user_pay_period_total_obj
public
mixed
$user_pay_period_total_obj
= \null
$user_tax_obj
public
mixed
$user_tax_obj
= \null
$user_wage_obj
public
mixed
$user_wage_obj
= \null
Methods
__construct()
Wage constructor.
public
__construct(string $user_id, string $pay_period_id) : mixed
Parameters
- $user_id : string
-
UUID
- $pay_period_id : string
-
UUID
Return values
mixed —compactUserDateTotalPayStubEntries()
Compact wage entries that have the same: user_wage_id, pay_stub_entry, rate and description.
public
compactUserDateTotalPayStubEntries( $array) : array<string|int, mixed>
This is primarily to avoid having multiple Regular Time entries for each meal/break policy that they have, which can be confusing for some employees.
Parameters
Return values
array<string|int, mixed> —getAdvance()
public
getAdvance() : bool
Return values
bool —getGrossWage()
public
getGrossWage() : int
Return values
int —getMaximumPayPeriodWage()
public
getMaximumPayPeriodWage(object $user_wage_obj) : string
Parameters
- $user_wage_obj : object
Return values
string —getPayPeriod()
public
getPayPeriod() : null
Return values
null —getPayPeriodObject()
public
getPayPeriodObject() : bool|null
Return values
bool|null —getPayPeriodScheduleObject()
public
getPayPeriodScheduleObject() : bool|null
Return values
bool|null —getPayStubAmendmentDeductions()
public
getPayStubAmendmentDeductions() : string
Return values
string —getPayStubAmendmentEarnings()
public
getPayStubAmendmentEarnings() : string
Return values
string —getPayStubEntryAccountLinkObject()
public
getPayStubEntryAccountLinkObject() : bool|null
Return values
bool|null —getRawGrossWage()
public
getRawGrossWage() : int
Return values
int —getUser()
public
getUser() : null
Return values
null —getUserDateTotalArray()
public
getUserDateTotalArray() : array<string|int, mixed>|bool|null
Return values
array<string|int, mixed>|bool|null —getUserObject()
public
getUserObject() : bool|null
Return values
bool|null —getWage()
public
getWage( $seconds, $rate) : int|string
Parameters
Return values
int|string —setAdvance()
public
setAdvance( $bool) : bool
Parameters
Return values
bool —setUserDateTotalArray()
public
setUserDateTotalArray() : array<string|int, mixed>|bool