1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-09-21 17:01:33 +02:00
invoiceninja/app/DataMapper/CompanySettings.php

909 lines
33 KiB
PHP
Raw Normal View History

<?php
2019-05-11 05:32:07 +02:00
/**
* Invoice Ninja (https://invoiceninja.com).
2019-05-11 05:32:07 +02:00
*
* @link https://github.com/invoiceninja/invoiceninja source repository
*
2022-04-27 05:20:41 +02:00
* @copyright Copyright (c) 2022. Invoice Ninja LLC (https://invoiceninja.com)
2019-05-11 05:32:07 +02:00
*
2021-06-16 08:58:16 +02:00
* @license https://www.elastic.co/licensing/elastic-license
2019-05-11 05:32:07 +02:00
*/
namespace App\DataMapper;
use App\Utils\Traits\MakesHash;
2020-10-28 11:10:49 +01:00
use stdClass;
/**
* CompanySettings.
*/
class CompanySettings extends BaseSettings
{
use MakesHash;
/*Group settings based on functionality*/
/*Invoice*/
2020-11-04 06:22:51 +01:00
public $auto_archive_invoice = false; // @implemented
2022-06-30 08:09:06 +02:00
public $qr_iban = ''; //@implemented
public $besr_id = ''; //@implemented
2022-06-30 06:29:18 +02:00
2020-11-04 06:22:51 +01:00
public $lock_invoices = 'off'; //off,when_sent,when_paid //@implemented
2020-11-04 06:22:51 +01:00
public $enable_client_portal_tasks = false; //@ben to implement
2021-06-22 23:54:06 +02:00
public $show_all_tasks_client_portal = 'invoiced'; // all, uninvoiced, invoiced
2020-11-04 06:22:51 +01:00
public $enable_client_portal_password = false; //@implemented
2020-11-04 06:22:51 +01:00
public $enable_client_portal = true; //@implemented
2021-01-13 08:47:14 +01:00
public $enable_client_portal_dashboard = false; // @TODO There currently is no dashboard so this is pending
2020-11-04 06:22:51 +01:00
public $signature_on_pdf = false; //@implemented
2020-11-04 09:43:20 +01:00
public $document_email_attachment = false; //@TODO I assume this is 3rd party attachments on the entity to be included
2020-11-04 06:22:51 +01:00
public $portal_design_id = '1'; //?@deprecated
2020-11-04 06:22:51 +01:00
public $timezone_id = ''; //@implemented
2020-11-04 06:22:51 +01:00
public $date_format_id = ''; //@implemented
2020-11-04 06:22:51 +01:00
public $military_time = false; // @TODOImplemented in Tasks only?
2020-11-04 06:22:51 +01:00
public $language_id = ''; //@implemented
2020-11-04 06:22:51 +01:00
public $show_currency_code = false; //@implemented
2020-11-04 06:22:51 +01:00
public $company_gateway_ids = ''; //@implemented
2020-11-04 06:22:51 +01:00
public $currency_id = '1'; //@implemented
2020-11-04 06:22:51 +01:00
public $custom_value1 = ''; //@implemented
2020-11-04 06:22:51 +01:00
public $custom_value2 = ''; //@implemented
2020-11-04 06:22:51 +01:00
public $custom_value3 = ''; //@implemented
2020-11-04 06:22:51 +01:00
public $custom_value4 = ''; //@implemented
2020-11-04 06:22:51 +01:00
public $default_task_rate = 0; // @TODO Where do we inject this?
2020-11-04 06:22:51 +01:00
public $payment_terms = ''; //@implemented
2020-11-30 08:43:33 +01:00
public $send_reminders = true; //@TODO
2020-11-04 06:22:51 +01:00
public $custom_message_dashboard = ''; // @TODO There currently is no dashboard so this is pending
2020-11-16 15:37:09 +01:00
public $custom_message_unpaid_invoice = '';
2020-11-16 15:37:09 +01:00
public $custom_message_paid_invoice = '';
2020-11-16 15:37:09 +01:00
public $custom_message_unapproved_quote = '';
2020-11-04 06:22:51 +01:00
public $auto_archive_quote = false; //@implemented
2020-11-04 06:22:51 +01:00
public $auto_convert_quote = true; //@implemented
2020-11-04 06:22:51 +01:00
public $auto_email_invoice = true; //@only used for Recurring Invoices, if set to false, we never send?
2022-03-10 21:45:23 +01:00
public $entity_send_time = 6;
2021-06-10 13:25:47 +02:00
2020-11-04 06:22:51 +01:00
public $inclusive_taxes = false; //@implemented
public $quote_footer = ''; //@implmented
public $translations;
public $counter_number_applied = 'when_saved'; // when_saved , when_sent //@implemented
public $quote_number_applied = 'when_saved'; // when_saved , when_sent //@implemented
/* Counters */
public $invoice_number_pattern = ''; //@implemented
public $invoice_number_counter = 1; //@implemented
public $recurring_invoice_number_pattern = ''; //@implemented
public $recurring_invoice_number_counter = 1; //@implemented
2020-10-06 06:11:48 +02:00
public $quote_number_pattern = ''; //@implemented
public $quote_number_counter = 1; //@implemented
public $client_number_pattern = ''; //@implemented
public $client_number_counter = 1; //@implemented
public $credit_number_pattern = ''; //@implemented
public $credit_number_counter = 1; //@implemented
public $task_number_pattern = ''; //@implemented
public $task_number_counter = 1; //@implemented
public $expense_number_pattern = ''; //@implemented
public $expense_number_counter = 1; //@implemented
public $recurring_expense_number_pattern = '';
public $recurring_expense_number_counter = 1;
2021-08-24 03:29:56 +02:00
public $recurring_quote_number_pattern = '';
public $recurring_quote_number_counter = 1;
2021-08-24 07:32:22 +02:00
public $vendor_number_pattern = ''; //@implemented
public $vendor_number_counter = 1; //@implemented
public $ticket_number_pattern = ''; //@implemented
public $ticket_number_counter = 1; //@implemented
public $payment_number_pattern = ''; //@implemented
public $payment_number_counter = 1; //@implemented
public $project_number_pattern = ''; //@implemented
public $project_number_counter = 1; //@implemented
2020-10-19 23:18:09 +02:00
2022-05-31 00:28:32 +02:00
public $purchase_order_number_pattern = ''; //@implemented
2022-05-31 00:28:32 +02:00
public $purchase_order_number_counter = 1; //@implemented
public $shared_invoice_quote_counter = false; //@implemented
public $shared_invoice_credit_counter = false; //@implemented
public $recurring_number_prefix = ''; //@implemented
public $reset_counter_frequency_id = '0'; //@implemented
public $reset_counter_date = ''; //@implemented
public $counter_padding = 4; //@implemented
public $auto_bill = 'off'; //off,always,optin,optout //@implemented
public $auto_bill_date = 'on_due_date'; // on_due_date , on_send_date //@implemented
2020-11-04 09:43:20 +01:00
public $invoice_terms = ''; //@implemented
public $quote_terms = ''; //@implemented
public $invoice_taxes = 0; // ? used in AP only?
2021-10-20 00:51:33 +02:00
public $invoice_design_id = 'Wpmbk5ezJn'; //@implemented
2021-10-20 00:51:33 +02:00
public $quote_design_id = 'Wpmbk5ezJn'; //@implemented
2021-10-20 00:51:33 +02:00
public $credit_design_id = 'Wpmbk5ezJn'; //@implemented
2022-06-05 12:30:56 +02:00
public $purchase_order_design_id = 'Wpmbk5ezJn';
2022-06-05 12:30:56 +02:00
public $purchase_order_footer = ''; //@implemented
2022-06-05 12:30:56 +02:00
public $purchase_order_terms = ''; //@implemented
2022-06-05 12:30:56 +02:00
public $purchase_order_public_notes = ''; //@implemented
2022-06-05 12:30:56 +02:00
public $require_purchase_order_signature = false; //@TODO ben to confirm
2020-11-04 09:43:20 +01:00
public $invoice_footer = ''; //@implemented
2020-11-04 09:43:20 +01:00
public $credit_footer = ''; //@implemented
2020-11-04 09:43:20 +01:00
public $credit_terms = ''; //@implemented
public $invoice_labels = ''; //@TODO used in AP only?
public $tax_name1 = ''; //@TODO where do we use this?
public $tax_rate1 = 0; //@TODO where do we use this?
public $tax_name2 = ''; //@TODO where do we use this?
public $tax_rate2 = 0; //@TODO where do we use this?
public $tax_name3 = ''; //@TODO where do we use this?
public $tax_rate3 = 0; //@TODO where do we use this?
public $payment_type_id = '0'; //@TODO where do we use this?
public $valid_until = ''; //@implemented
public $show_accept_invoice_terms = false; //@TODO ben to confirm
public $show_accept_quote_terms = false; //@TODO ben to confirm
public $require_invoice_signature = false; //@TODO ben to confirm
public $require_quote_signature = false; //@TODO ben to confirm
//email settings
2022-06-17 10:28:31 +02:00
public $email_sending_method = 'default'; //enum 'default','gmail','office365' //@implemented
public $gmail_sending_user_id = '0'; //@implemented
2021-06-17 13:55:56 +02:00
public $reply_to_email = ''; //@implemented
2021-06-17 13:55:56 +02:00
public $reply_to_name = ''; //@implemented
public $bcc_email = ''; //@TODO
public $pdf_email_attachment = false; //@implemented
public $ubl_email_attachment = false; //@implemented
public $email_style = 'light'; //plain, light, dark, custom //@implemented
public $email_style_custom = ''; //the template itself //@implemented
public $email_subject_invoice = ''; //@implemented
public $email_subject_quote = ''; //@implemented
public $email_subject_credit = ''; //@implemented
public $email_subject_payment = ''; //@implemented
public $email_subject_payment_partial = ''; //@implemented
public $email_subject_statement = ''; //@implemented
2022-06-07 00:12:06 +02:00
public $email_subject_purchase_order = ''; //@implemented
2022-06-07 00:12:06 +02:00
public $email_template_purchase_order = ''; //@implemented
public $email_template_invoice = ''; //@implemented
public $email_template_credit = ''; //@implemented
public $email_template_quote = ''; //@implemented
public $email_template_payment = ''; //@implemented
public $email_template_payment_partial = ''; //@implemented
public $email_template_statement = ''; //@implemented
public $email_subject_reminder1 = ''; //@implemented
public $email_subject_reminder2 = ''; //@implemented
public $email_subject_reminder3 = ''; //@implemented
public $email_subject_reminder_endless = ''; //@implemented
public $email_template_reminder1 = ''; //@implemented
public $email_template_reminder2 = ''; //@implemented
public $email_template_reminder3 = ''; //@implemented
public $email_template_reminder_endless = ''; //@implemented
public $email_signature = ''; //@implemented
2020-11-25 15:19:52 +01:00
public $enable_email_markup = true; //@TODO -
public $email_subject_custom1 = ''; //@TODO
public $email_subject_custom2 = ''; //@TODO
public $email_subject_custom3 = ''; //@TODO
2020-11-25 15:19:52 +01:00
public $email_template_custom1 = ''; //@TODO
public $email_template_custom2 = ''; //@TODO
public $email_template_custom3 = ''; //@TODO
public $enable_reminder1 = false; //@implmemented
public $enable_reminder2 = false; //@implmemented
public $enable_reminder3 = false; //@implmemented
public $enable_reminder_endless = false; //@implmemented
public $num_days_reminder1 = 0; //@implmemented
public $num_days_reminder2 = 0; //@implmemented
public $num_days_reminder3 = 0; //@implmemented
public $schedule_reminder1 = ''; // (enum: after_invoice_date, before_due_date, after_due_date) implmemented
2020-11-25 15:19:52 +01:00
public $schedule_reminder2 = ''; // (enum: after_invoice_date, before_due_date, after_due_date) implmemented
public $schedule_reminder3 = ''; // (enum: after_invoice_date, before_due_date, after_due_date) implmemented
2021-05-27 03:19:07 +02:00
public $reminder_send_time = 0; //number of seconds from UTC +0 to send reminders @TODO
public $late_fee_amount1 = 0; //@implemented
public $late_fee_amount2 = 0; //@implemented
public $late_fee_amount3 = 0; //@implemented
public $late_fee_percent1 = 0; //@implemented
public $late_fee_percent2 = 0; //@implemented
public $late_fee_percent3 = 0; //@implemented
2020-11-04 10:32:49 +01:00
public $endless_reminder_frequency_id = '0'; //@implemented
public $late_fee_endless_amount = 0; //@implemented
public $late_fee_endless_percent = 0; //@implemented
public $client_online_payment_notification = true; //@todo implement in notifications check this bool prior to sending payment notification to client
public $client_manual_payment_notification = true; //@todo implement in notifications check this bool prior to sending manual payment notification to client
/* Company Meta data that we can use to build sub companies*/
public $name = ''; //@implemented
public $company_logo = ''; //@implemented
public $website = ''; //@implemented
public $address1 = ''; //@implemented
public $address2 = ''; //@implemented
public $city = ''; //@implemented
public $state = ''; //@implemented
public $postal_code = ''; //@implemented
public $phone = ''; //@implemented
public $email = ''; //@implemented
public $country_id; //@implemented
public $vat_number = ''; //@implemented
public $id_number = ''; //@implemented
public $page_size = 'A4'; //Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A4, A5, A6
2021-04-08 00:19:36 +02:00
public $page_layout = 'portrait';
2021-01-28 11:07:15 +01:00
public $font_size = 7; //@implemented
public $primary_font = 'Roboto';
public $secondary_font = 'Roboto';
public $primary_color = '#298AAB';
public $secondary_color = '#7081e0';
2022-05-25 08:34:43 +02:00
public $page_numbering = false;
2022-05-25 08:34:43 +02:00
public $page_numbering_alignment = 'C'; //C,R,L
public $hide_paid_to_date = false; //@TODO where?
public $embed_documents = false; //@TODO where?
2021-05-31 00:17:42 +02:00
public $all_pages_header = false; //@deprecated 31-05-2021
2021-05-31 00:17:42 +02:00
public $all_pages_footer = false; //@deprecated 31-05-2021
public $pdf_variables = ''; //@implemented
public $portal_custom_head = ''; //@TODO @BEN
public $portal_custom_css = ''; //@TODO @BEN
public $portal_custom_footer = ''; //@TODO @BEN
public $portal_custom_js = ''; //@TODO @BEN
2021-06-05 12:31:11 +02:00
public $client_can_register = false; //@deorecated 04/06/2021
public $client_portal_terms = ''; //@TODO @BEN
public $client_portal_privacy_policy = ''; //@TODO @BEN
public $client_portal_enable_uploads = false; //@implemented
public $client_portal_allow_under_payment = false; //@implemented
public $client_portal_under_payment_minimum = 0; //@implemented
public $client_portal_allow_over_payment = false; //@implemented
2020-08-28 03:06:46 +02:00
public $use_credits_payment = 'off'; //always, option, off //@implemented
public $hide_empty_columns_on_pdf = false;
2021-09-03 14:59:48 +02:00
public $email_from_name = '';
public $auto_archive_invoice_cancelled = false;
2020-10-26 20:10:04 +01:00
2022-07-06 07:18:41 +02:00
public $vendor_portal_enable_uploads=false;
public static $casts = [
2022-07-06 07:18:41 +02:00
'vendor_portal_enable_uploads' => 'bool',
2022-06-30 08:09:06 +02:00
'besr_id' => 'string',
2022-06-30 06:29:18 +02:00
'qr_iban' => 'string',
2022-06-08 00:27:47 +02:00
'email_subject_purchase_order' => 'string',
'email_template_purchase_order' => 'string',
2022-06-05 12:30:56 +02:00
'require_purchase_order_signature' => 'bool',
'purchase_order_public_notes' => 'string',
'purchase_order_terms' => 'string',
'purchase_order_design_id' => 'string',
'purchase_order_footer' => 'string',
2022-06-05 11:41:19 +02:00
'purchase_order_number_pattern' => 'string',
2022-05-31 00:52:10 +02:00
'purchase_order_number_counter' => 'int',
2022-05-25 12:53:12 +02:00
'page_numbering_alignment' => 'string',
2022-05-25 08:34:43 +02:00
'page_numbering' => 'bool',
'auto_archive_invoice_cancelled' => 'bool',
2021-09-03 14:59:48 +02:00
'email_from_name' => 'string',
'show_all_tasks_client_portal' => 'string',
2021-06-10 13:25:47 +02:00
'entity_send_time' => 'int',
'shared_invoice_credit_counter' => 'bool',
2021-02-11 11:09:34 +01:00
'reply_to_name' => 'string',
'hide_empty_columns_on_pdf' => 'bool',
2020-10-27 12:57:12 +01:00
'enable_reminder_endless' => 'bool',
2020-10-26 20:10:04 +01:00
'use_credits_payment' => 'string',
2020-10-06 07:04:54 +02:00
'recurring_invoice_number_pattern' => 'string',
'recurring_invoice_number_counter' => 'int',
'client_portal_under_payment_minimum'=> 'float',
'auto_bill_date' => 'string',
'primary_color' => 'string',
'secondary_color' => 'string',
2020-08-28 03:06:46 +02:00
'client_portal_allow_under_payment' => 'bool',
'client_portal_allow_over_payment' => 'bool',
2020-08-19 08:09:01 +02:00
'auto_bill' => 'string',
'lock_invoices' => 'string',
2020-06-28 00:24:08 +02:00
'client_portal_terms' => 'string',
'client_portal_privacy_policy' => 'string',
'client_can_register' => 'bool',
'portal_design_id' => 'string',
'late_fee_endless_percent' => 'float',
'late_fee_endless_amount' => 'float',
'auto_email_invoice' => 'bool',
'reminder_send_time' => 'int',
'email_sending_method' => 'string',
'gmail_sending_user_id' => 'string',
'currency_id' => 'string',
'counter_number_applied' => 'string',
'quote_number_applied' => 'string',
'email_subject_custom1' => 'string',
'email_subject_custom2' => 'string',
'email_subject_custom3' => 'string',
'email_template_custom1' => 'string',
'email_template_custom2' => 'string',
'email_template_custom3' => 'string',
'enable_reminder1' => 'bool',
'enable_reminder2' => 'bool',
'enable_reminder3' => 'bool',
'num_days_reminder1' => 'int',
'num_days_reminder2' => 'int',
'num_days_reminder3' => 'int',
'schedule_reminder1' => 'string', // (enum: after_invoice_date, before_due_date, after_due_date)
'schedule_reminder2' => 'string', // (enum: after_invoice_date, before_due_date, after_due_date)
'schedule_reminder3' => 'string', // (enum: after_invoice_date, before_due_date, after_due_date)
'late_fee_amount1' => 'float',
'late_fee_amount2' => 'float',
'late_fee_amount3' => 'float',
2020-11-04 10:32:49 +01:00
'late_fee_percent1' => 'float',
'late_fee_percent2' => 'float',
'late_fee_percent3' => 'float',
'endless_reminder_frequency_id' => 'integer',
'client_online_payment_notification' => 'bool',
'client_manual_payment_notification' => 'bool',
'document_email_attachment' => 'bool',
'enable_client_portal_password' => 'bool',
'enable_email_markup' => 'bool',
'enable_client_portal_dashboard' => 'bool',
'enable_client_portal' => 'bool',
'email_template_statement' => 'string',
'email_subject_statement' => 'string',
'signature_on_pdf' => 'bool',
'quote_footer' => 'string',
'page_size' => 'string',
2021-04-08 00:19:36 +02:00
'page_layout' => 'string',
'font_size' => 'int',
'primary_font' => 'string',
'secondary_font' => 'string',
'hide_paid_to_date' => 'bool',
'embed_documents' => 'bool',
'all_pages_header' => 'bool',
'all_pages_footer' => 'bool',
2020-10-19 23:18:09 +02:00
'project_number_pattern' => 'string',
'project_number_counter' => 'int',
'task_number_pattern' => 'string',
'task_number_counter' => 'int',
'expense_number_pattern' => 'string',
'expense_number_counter' => 'int',
2021-08-24 03:29:56 +02:00
'recurring_expense_number_pattern' => 'string',
'recurring_expense_number_counter' => 'int',
2021-09-17 09:52:22 +02:00
'recurring_quote_number_pattern' => 'string',
'recurring_quote_number_counter' => 'int',
'vendor_number_pattern' => 'string',
'vendor_number_counter' => 'int',
'ticket_number_pattern' => 'string',
'ticket_number_counter' => 'int',
'payment_number_pattern' => 'string',
'payment_number_counter' => 'int',
'reply_to_email' => 'string',
'bcc_email' => 'string',
'pdf_email_attachment' => 'bool',
'ubl_email_attachment' => 'bool',
'email_style' => 'string',
'email_style_custom' => 'string',
'company_gateway_ids' => 'string',
'address1' => 'string',
'address2' => 'string',
'city' => 'string',
'company_logo' => 'string',
'country_id' => 'string',
'client_number_pattern' => 'string',
'client_number_counter' => 'integer',
'credit_number_pattern' => 'string',
'credit_number_counter' => 'integer',
'currency_id' => 'string',
'custom_value1' => 'string',
'custom_value2' => 'string',
'custom_value3' => 'string',
'custom_value4' => 'string',
'custom_message_dashboard' => 'string',
'custom_message_unpaid_invoice' => 'string',
'custom_message_paid_invoice' => 'string',
'custom_message_unapproved_quote' => 'string',
'default_task_rate' => 'float',
'email_signature' => 'string',
'email_subject_invoice' => 'string',
'email_subject_quote' => 'string',
2020-10-15 23:55:24 +02:00
'email_subject_credit' => 'string',
'email_subject_payment' => 'string',
'email_subject_payment_partial' => 'string',
'email_template_invoice' => 'string',
'email_template_quote' => 'string',
2020-10-15 23:55:24 +02:00
'email_template_credit' => 'string',
'email_template_payment' => 'string',
'email_template_payment_partial' => 'string',
'email_subject_reminder1' => 'string',
'email_subject_reminder2' => 'string',
'email_subject_reminder3' => 'string',
'email_subject_reminder_endless' => 'string',
'email_template_reminder1' => 'string',
'email_template_reminder2' => 'string',
'email_template_reminder3' => 'string',
'email_template_reminder_endless' => 'string',
'inclusive_taxes' => 'bool',
'invoice_number_pattern' => 'string',
'invoice_number_counter' => 'integer',
'invoice_design_id' => 'string',
2021-02-22 23:08:43 +01:00
// 'invoice_fields' => 'string',
'invoice_taxes' => 'int',
//'enabled_item_tax_rates' => 'int',
'invoice_footer' => 'string',
'invoice_labels' => 'string',
'invoice_terms' => 'string',
'credit_footer' => 'string',
'credit_terms' => 'string',
'name' => 'string',
2020-05-26 10:28:19 +02:00
'payment_terms' => 'string',
'payment_type_id' => 'string',
'phone' => 'string',
'postal_code' => 'string',
'quote_design_id' => 'string',
'credit_design_id' => 'string',
'quote_number_pattern' => 'string',
'quote_number_counter' => 'integer',
'quote_terms' => 'string',
'recurring_number_prefix' => 'string',
'reset_counter_frequency_id' => 'integer',
'reset_counter_date' => 'string',
'require_invoice_signature' => 'bool',
'require_quote_signature' => 'bool',
'state' => 'string',
'email' => 'string',
'vat_number' => 'string',
'id_number' => 'string',
'tax_name1' => 'string',
'tax_name2' => 'string',
'tax_name3' => 'string',
'tax_rate1' => 'float',
'tax_rate2' => 'float',
'tax_rate3' => 'float',
'show_accept_quote_terms' => 'bool',
'show_accept_invoice_terms' => 'bool',
'timezone_id' => 'string',
'valid_until' => 'string',
'date_format_id' => 'string',
'military_time' => 'bool',
'language_id' => 'string',
'show_currency_code' => 'bool',
'send_reminders' => 'bool',
'enable_client_portal_tasks' => 'bool',
'auto_archive_invoice' => 'bool',
'auto_archive_quote' => 'bool',
'auto_convert_quote' => 'bool',
'shared_invoice_quote_counter' => 'bool',
'counter_padding' => 'integer',
//'design' => 'string',
'website' => 'string',
'pdf_variables' => 'object',
'portal_custom_head' => 'string',
'portal_custom_css' => 'string',
'portal_custom_footer' => 'string',
'portal_custom_js' => 'string',
'client_portal_enable_uploads' => 'bool',
'purchase_order_number_counter' => 'integer',
];
public static $free_plan_casts = [
'currency_id' => 'string',
'company_gateway_ids' => 'string',
'address1' => 'string',
'address2' => 'string',
'city' => 'string',
'company_logo' => 'string',
'country_id' => 'string',
'custom_value1' => 'string',
'custom_value2' => 'string',
'custom_value3' => 'string',
'custom_value4' => 'string',
'inclusive_taxes' => 'bool',
'name' => 'string',
'payment_terms' => 'string',
'payment_type_id' => 'string',
'phone' => 'string',
'postal_code' => 'string',
'state' => 'string',
'email' => 'string',
'vat_number' => 'string',
'id_number' => 'string',
'tax_name1' => 'string',
'tax_name2' => 'string',
'tax_name3' => 'string',
'tax_rate1' => 'float',
'tax_rate2' => 'float',
'tax_rate3' => 'float',
'timezone_id' => 'string',
'date_format_id' => 'string',
'military_time' => 'bool',
'language_id' => 'string',
'show_currency_code' => 'bool',
'website' => 'string',
2022-04-09 08:02:12 +02:00
'default_task_rate' => 'float',
];
/**
* Array of variables which
* cannot be modified client side.
*/
public static $protected_fields = [
// 'credit_number_counter',
// 'invoice_number_counter',
// 'quote_number_counter',
];
public static $string_casts = [
'invoice_design_id',
'quote_design_id',
'credit_design_id',
2022-06-08 00:27:47 +02:00
'purchase_order_design_id',
];
/**
* Cast object values and return entire class
* prevents missing properties from not being returned
* and always ensure an up to date class is returned.
*
2020-10-28 11:10:49 +01:00
* @param $obj
*/
public function __construct($obj)
{
// parent::__construct($obj);
}
/**
* Provides class defaults on init.
2020-11-25 15:19:52 +01:00
*
* @return stdClass
*/
2020-10-28 11:10:49 +01:00
public static function defaults(): stdClass
{
$config = json_decode(config('ninja.settings'));
$data = (object) get_class_vars(self::class);
unset($data->casts);
unset($data->protected_fields);
unset($data->free_plan_casts);
unset($data->string_casts);
$data->timezone_id = (string) config('ninja.i18n.timezone_id');
$data->currency_id = (string) config('ninja.i18n.currency_id');
$data->language_id = (string) config('ninja.i18n.language_id');
$data->payment_terms = (string) config('ninja.i18n.payment_terms');
$data->military_time = (bool) config('ninja.i18n.military_time');
$data->date_format_id = (string) config('ninja.i18n.date_format_id');
$data->country_id = (string) config('ninja.i18n.country_id');
$data->translations = (object) [];
$data->pdf_variables = (object) self::getEntityVariableDefaults();
return self::setCasts($data, self::$casts);
}
/**
* In case we update the settings object in the future we
* need to provide a fallback catch on old settings objects which will
* set new properties to the object prior to being returned.
*
2020-10-28 11:10:49 +01:00
* @param $settings
2020-11-25 15:19:52 +01:00
*
2020-10-28 11:10:49 +01:00
* @return stdClass
*/
2020-10-28 11:10:49 +01:00
public static function setProperties($settings): stdClass
{
$company_settings = (object) get_class_vars(self::class);
foreach ($company_settings as $key => $value) {
if (! property_exists($settings, $key)) {
$settings->{$key} = self::castAttribute($key, $company_settings->{$key});
}
}
return $settings;
}
/**
* Stubs the notification defaults
2020-11-25 15:19:52 +01:00
*
* @return stdClass
*/
public static function notificationDefaults() :stdClass
{
2020-10-28 11:10:49 +01:00
$notification = new stdClass;
$notification->email = [];
// $notification->email = ['all_notifications'];
return $notification;
}
/**
* Defines entity variables for PDF generation
2020-11-25 15:19:52 +01:00
*
* @return stdClass The stdClass of PDF variables
*/
public static function getEntityVariableDefaults() :stdClass
{
$variables = [
'client_details' => [
'$client.name',
2021-04-09 09:44:17 +02:00
'$client.number',
'$client.vat_number',
'$client.address1',
'$client.address2',
'$client.city_state_postal',
'$client.country',
2021-04-05 14:37:25 +02:00
'$client.phone',
2021-04-09 09:39:52 +02:00
'$contact.email',
],
2022-06-06 05:28:10 +02:00
'vendor_details' => [
'$vendor.name',
'$vendor.number',
'$vendor.vat_number',
'$vendor.address1',
'$vendor.address2',
'$vendor.city_state_postal',
'$vendor.country',
'$vendor.phone',
'$contact.email',
],
2022-06-07 12:36:47 +02:00
'purchase_order_details' => [
'$purchase_order.number',
'$purchase_order.po_number',
'$purchase_order.date',
'$purchase_order.due_date',
'$purchase_order.total',
'$purchase_order.balance_due',
],
'company_details' => [
2020-03-29 23:29:00 +02:00
'$company.name',
'$company.id_number',
'$company.vat_number',
'$company.website',
'$company.email',
'$company.phone',
],
'company_address' => [
'$company.address1',
'$company.address2',
'$company.city_state_postal',
'$company.country',
],
'invoice_details' => [
'$invoice.number',
'$invoice.po_number',
'$invoice.date',
'$invoice.due_date',
'$invoice.total',
2021-03-03 11:04:10 +01:00
'$invoice.balance_due',
],
'quote_details' => [
'$quote.number',
'$quote.po_number',
'$quote.date',
'$quote.valid_until',
'$quote.total',
],
'credit_details' => [
2020-09-29 14:31:08 +02:00
'$credit.number',
'$credit.po_number',
2020-09-29 14:31:08 +02:00
'$credit.date',
'$credit.balance',
'$credit.total',
],
'product_columns' => [
'$product.item',
2020-11-13 12:52:11 +01:00
'$product.description',
'$product.unit_cost',
'$product.quantity',
'$product.discount',
2020-03-29 23:29:00 +02:00
'$product.tax',
'$product.line_total',
],
'task_columns' =>[
'$task.service',
2020-11-13 12:52:11 +01:00
'$task.description',
'$task.rate',
'$task.hours',
'$task.discount',
2020-03-29 23:29:00 +02:00
'$task.tax',
'$task.line_total',
],
'total_columns' => [
2021-07-18 10:57:26 +02:00
'$net_subtotal',
'$subtotal',
'$discount',
'$custom_surcharge1',
'$custom_surcharge2',
'$custom_surcharge3',
'$custom_surcharge4',
2021-02-25 11:41:18 +01:00
'$total_taxes',
'$line_taxes',
2021-04-09 09:44:17 +02:00
'$total',
2021-05-24 13:54:22 +02:00
'$paid_to_date',
'$outstanding',
],
'statement_invoice_columns' => [
'$invoice.number',
'$invoice.date',
'$due_date',
'$total',
2021-09-24 11:56:16 +02:00
'$balance',
],
'statement_payment_columns' => [
'$invoice.number',
'$payment.date',
'$method',
2021-09-24 11:56:16 +02:00
'$statement_amount',
],
];
return json_decode(json_encode($variables));
}
}