AdminCompanyGroups extends AdminController
Admin Company Client Group Settings
Table of Contents
Properties
| $client_group_fields |
Methods
| add() | Add a new Client Group |
| delete() | Delete a Client Group |
| edit() | Edit a Client Group |
| index() | Client Group settings |
| preAction() | Pre-action |
| getSelectFields() | Retrieves a list of select fields used for AdminCompanyGroups::add() and AdminCompanyGroups::edit() |
| getSettings() | Retrieves the client group settings and includes a "use_company_settings" field in $vars, useful for add/edit client groups |
Properties
$client_group_fields
private
array<string|int, mixed>
$client_group_fields
= ['inv_days_before_renewal', 'autodebit_days_before_due', 'suspend_services_days_after_due', 'autodebit_attempts', 'service_renewal_attempts', 'first_renewal_attempt_threshold', 'first_renewal_attempt_spacing', 'second_renewal_attempt_threshold', 'second_renewal_attempt_spacing', 'service_provisioning_attempts', 'first_provisioning_attempt_threshold', 'first_provisioning_attempt_spacing', 'second_provisioning_attempt_threshold', 'second_provisioning_attempt_spacing', 'service_suspension_attempts', 'first_suspension_attempt_threshold', 'first_suspension_attempt_spacing', 'second_suspension_attempt_threshold', 'second_suspension_attempt_spacing', 'service_unsuspension_attempts', 'first_unsuspension_attempt_threshold', 'first_unsuspension_attempt_spacing', 'second_unsuspension_attempt_threshold', 'second_unsuspension_attempt_spacing', 'service_cancelation_attempts', 'first_cancelation_attempt_threshold', 'first_cancelation_attempt_spacing', 'second_cancelation_attempt_threshold', 'second_cancelation_attempt_spacing', 'client_set_invoice', 'inv_suspended_services', 'clients_cancel_services', 'clients_cancel_options', 'clients_renew_services', 'synchronize_addons', 'client_create_addons', 'auto_apply_credits', 'auto_paid_pending_services', 'client_change_service_term', 'client_change_service_package', 'delivery_methods', 'notice1', 'notice2', 'notice3', 'notice_pending_autodebit', 'send_payment_notices', 'send_cancellation_notice', 'autodebit', 'show_client_tax_id', 'client_prorate_credits', 'process_paid_service_changes', 'late_fee_total_amount', 'late_fees', 'cancel_service_changes_days', 'apply_inv_late_fees', 'inv_group_services', 'inv_append_descriptions', 'inv_lines_verbose_option_dates', 'void_invoice_canceled_service', 'void_inv_canceled_service_days', 'quotation_valid_days', 'quotation_dead_days', 'quotation_deposit_percentage', 'prevent_unverified_payments', 'unique_contact_emails', 'force_email_usernames', 'email_verification', 'required_contact_fields', 'shown_contact_fields', 'read_only_contact_fields', 'clients_increment', 'clients_start', 'clients_format', 'enable_gateway_restrictions', 'allowed_gateways', 'requeue_invoice_delivery_on_closed', 'payment_credit_enabled', 'payment_credit_limits']
Whitelist of client group settings fields
Methods
add()
Add a new Client Group
public
add() : mixed
delete()
Delete a Client Group
public
delete() : mixed
edit()
Edit a Client Group
public
edit() : mixed
index()
Client Group settings
public
index() : mixed
preAction()
Pre-action
public
preAction() : mixed
getSelectFields()
Retrieves a list of select fields used for AdminCompanyGroups::add() and AdminCompanyGroups::edit()
private
getSelectFields() : stdClass
Return values
stdClass —An stdClass object containing the arrays:
- invoice_days
- notice_range
- autodebit_days
- autodebit_attempts
- service_attempts
- service_attempt_spacing
getSettings()
Retrieves the client group settings and includes a "use_company_settings" field in $vars, useful for add/edit client groups
private
getSettings(stdClass &$vars[, int $group_id = null ]) : array<string|int, mixed>
Parameters
- $vars : stdClass
-
An stdClass object (referenced)
- $group_id : int = null
-
The client group ID (optional)
Tags
Return values
array<string|int, mixed> —A key=>value array containing all of the client group settings