BillingOverviewSettings extends BillingOverviewModel
Billing Overview settings
Table of Contents
Properties
| $default_settings |
Methods
| __construct() | Initialize |
| add() | Adds new staff settings for the Billing Overview settings |
| addDefault() | Saves the default settings for the given staff member |
| getSettings() | Retrieves a list of all billing overview settings for a given staff member |
Properties
$default_settings
private
static array<string|int, mixed>
$default_settings
= [['key' => 'revenue_today', 'value' => 1, 'order' => 1], ['key' => 'revenue_month', 'value' => 1, 'order' => 2], ['key' => 'revenue_year', 'value' => 1, 'order' => 3], ['key' => 'credits_today', 'value' => 0, 'order' => 4], ['key' => 'credits_month', 'value' => 0, 'order' => 5], ['key' => 'credits_year', 'value' => 0, 'order' => 6], ['key' => 'invoiced_today', 'value' => 1, 'order' => 7], ['key' => 'invoiced_today_proforma', 'value' => 0, 'order' => 8], ['key' => 'invoiced_month', 'value' => 1, 'order' => 9], ['key' => 'invoiced_month_proforma', 'value' => 0, 'order' => 10], ['key' => 'balance_outstanding', 'value' => 1, 'order' => 11], ['key' => 'balance_overdue', 'value' => 1, 'order' => 12], ['key' => 'scheduled_cancelation', 'value' => 1, 'order' => 13], ['key' => 'services_active', 'value' => 1, 'order' => 14], ['key' => 'services_added_today', 'value' => 1, 'order' => 15], ['key' => 'services_canceled_today', 'value' => 1, 'order' => 16], ['key' => 'graph_revenue', 'value' => 1, 'order' => 17], ['key' => 'graph_revenue_year', 'value' => 1, 'order' => 18], ['key' => 'graph_invoiced', 'value' => 1, 'order' => 19], ['key' => 'show_legend', 'value' => 1, 'order' => 20], ['key' => 'date_range', 'value' => 7, 'order' => 21]]
A list of default billing overview settings
Methods
__construct()
Initialize
public
__construct() : mixed
add()
Adds new staff settings for the Billing Overview settings
public
add(int $staff_id, int $company_id, array<string|int, mixed> $vars) : mixed
Parameters
- $staff_id : int
-
The ID of the staff member whose settings to update
- $company_id : int
-
The ID of the company to which this staff member belongs
- $vars : array<string|int, mixed>
-
A numerically-indexed list of overview setting key/value pairs
addDefault()
Saves the default settings for the given staff member
public
addDefault(int $staff_id, int $company_id) : mixed
Parameters
- $staff_id : int
-
The ID of the staff member whose settings to update
- $company_id : int
-
The ID of the company to which this staff member belongs
getSettings()
Retrieves a list of all billing overview settings for a given staff member
public
getSettings(int $staff_id, int $company_id[, mixed $order_by = ['order' => 'asc'] ]) : array<string|int, mixed>
Parameters
- $staff_id : int
-
The staff ID of the staff member to get settings for
- $company_id : int
-
The company ID to which the staff member belongs
- $order_by : mixed = ['order' => 'asc']
Return values
array<string|int, mixed> —A list of billing overview settings for the given staff member