2019-02-17 11:34:46 +01:00
< ? php
2019-05-11 05:32:07 +02:00
/**
2020-09-06 11:38:10 +02:00
* Invoice Ninja ( https :// invoiceninja . com ) .
2019-05-11 05:32:07 +02:00
*
* @ link https :// github . com / invoiceninja / invoiceninja source repository
*
2021-01-03 22:54:54 +01:00
* @ copyright Copyright ( c ) 2021. Invoice Ninja LLC ( https :// invoiceninja . com )
2019-05-11 05:32:07 +02:00
*
* @ license https :// opensource . org / licenses / AAL
*/
2019-02-17 11:34:46 +01:00
namespace App\DataMapper ;
2020-03-06 12:10:59 +01:00
use App\Utils\Traits\MakesHash ;
2020-10-28 11:10:49 +01:00
use stdClass ;
2019-04-29 07:50:08 +02:00
2019-02-17 11:34:46 +01:00
/**
2020-09-06 11:38:10 +02:00
* CompanySettings .
2019-02-17 11:34:46 +01:00
*/
2020-03-21 06:37:30 +01:00
class CompanySettings extends BaseSettings
{
use MakesHash ;
/*Group settings based on functionality*/
2019-10-30 03:41:18 +01:00
2020-03-21 06:37:30 +01:00
/*Invoice*/
2020-11-04 06:22:51 +01:00
public $auto_archive_invoice = false ; // @implemented
2020-03-21 06:37:30 +01:00
2020-11-04 06:22:51 +01:00
public $lock_invoices = 'off' ; //off,when_sent,when_paid //@implemented
2020-07-16 13:01:39 +02:00
2020-11-04 06:22:51 +01:00
public $enable_client_portal_tasks = false ; //@ben to implement
public $enable_client_portal_password = false ; //@implemented
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-03-21 06:37:30 +01:00
2020-11-04 06:22:51 +01:00
public $portal_design_id = '1' ; //?@deprecated
2020-03-21 06:37:30 +01:00
2020-11-04 06:22:51 +01:00
public $timezone_id = '' ; //@implemented
public $date_format_id = '' ; //@implemented
public $military_time = false ; // @TODOImplemented in Tasks only?
2020-03-21 06:37:30 +01:00
2020-11-04 06:22:51 +01:00
public $language_id = '' ; //@implemented
public $show_currency_code = false ; //@implemented
2020-03-21 06:37:30 +01:00
2020-11-04 06:22:51 +01:00
public $company_gateway_ids = '' ; //@implemented
2020-03-21 06:37:30 +01:00
2020-11-04 06:22:51 +01:00
public $currency_id = '1' ; //@implemented
2020-03-21 06:37:30 +01:00
2020-11-04 06:22:51 +01:00
public $custom_value1 = '' ; //@implemented
public $custom_value2 = '' ; //@implemented
public $custom_value3 = '' ; //@implemented
public $custom_value4 = '' ; //@implemented
2020-03-21 06:37:30 +01:00
2020-11-04 06:22:51 +01:00
public $default_task_rate = 0 ; // @TODO Where do we inject this?
2020-03-21 06:37:30 +01:00
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-03-21 06:37:30 +01:00
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 = '' ;
public $custom_message_paid_invoice = '' ;
public $custom_message_unapproved_quote = '' ;
2020-11-04 06:22:51 +01:00
public $auto_archive_quote = false ; //@implemented
public $auto_convert_quote = true ; //@implemented
public $auto_email_invoice = true ; //@only used for Recurring Invoices, if set to false, we never send?
2020-03-21 06:37:30 +01:00
2020-11-04 06:22:51 +01:00
public $inclusive_taxes = false ; //@implemented
2020-11-04 07:02:15 +01:00
public $quote_footer = '' ; //@implmented
2020-03-21 06:37:30 +01:00
2020-11-04 07:02:15 +01:00
public $translations ; //@TODO not used anywhere
2020-03-21 06:37:30 +01:00
2020-11-04 07:02:15 +01:00
public $counter_number_applied = 'when_saved' ; // when_saved , when_sent //@implemented
public $quote_number_applied = 'when_saved' ; // when_saved , when_sent //@implemented
2020-03-21 06:37:30 +01:00
/* Counters */
2020-11-04 07:02:15 +01:00
public $invoice_number_pattern = '' ; //@implemented
public $invoice_number_counter = 1 ; //@implemented
2020-03-21 06:37:30 +01:00
2020-11-04 07:02:15 +01:00
public $recurring_invoice_number_pattern = '' ; //@implemented
public $recurring_invoice_number_counter = 1 ; //@implemented
2020-10-06 06:11:48 +02:00
2020-11-04 07:02:15 +01:00
public $quote_number_pattern = '' ; //@implemented
public $quote_number_counter = 1 ; //@implemented
2020-03-21 06:37:30 +01:00
2020-11-04 07:02:15 +01:00
public $client_number_pattern = '' ; //@implemented
public $client_number_counter = 1 ; //@implemented
2020-03-21 06:37:30 +01:00
2020-11-04 07:02:15 +01:00
public $credit_number_pattern = '' ; //@implemented
public $credit_number_counter = 1 ; //@implemented
2020-03-21 06:37:30 +01:00
2020-11-04 07:02:15 +01:00
public $task_number_pattern = '' ; //@implemented
public $task_number_counter = 1 ; //@implemented
2020-03-21 06:37:30 +01:00
2020-11-04 07:02:15 +01:00
public $expense_number_pattern = '' ; //@implemented
public $expense_number_counter = 1 ; //@implemented
2020-03-21 06:37:30 +01:00
2020-11-04 07:02:15 +01:00
public $vendor_number_pattern = '' ; //@implemented
public $vendor_number_counter = 1 ; //@implemented
2020-03-21 06:37:30 +01:00
2020-11-04 07:02:15 +01:00
public $ticket_number_pattern = '' ; //@implemented
public $ticket_number_counter = 1 ; //@implemented
2020-03-21 06:37:30 +01:00
2020-11-04 07:02:15 +01:00
public $payment_number_pattern = '' ; //@implemented
public $payment_number_counter = 1 ; //@implemented
2020-03-21 06:37:30 +01:00
2020-11-04 07:02:15 +01:00
public $project_number_pattern = '' ; //@implemented
public $project_number_counter = 1 ; //@implemented
2020-10-19 23:18:09 +02:00
2020-11-04 07:02:15 +01:00
public $shared_invoice_quote_counter = false ; //@implemented
2021-03-17 10:28:44 +01:00
public $shared_invoice_credit_counter = false ; //@implemented
2021-03-25 11:55:59 +01:00
public $recurring_number_prefix = '' ; //@implemented
2020-11-04 07:02:15 +01:00
public $reset_counter_frequency_id = '0' ; //@implemented
public $reset_counter_date = '' ; //@implemented
public $counter_padding = 4 ; //@implemented
2020-03-21 06:37:30 +01:00
2020-11-04 07:02:15 +01:00
public $auto_bill = 'off' ; //off,always,optin,optout //@implemented
public $auto_bill_date = 'on_due_date' ; // on_due_date , on_send_date //@implemented
2020-08-19 07:24:35 +02:00
2020-11-04 07:02:15 +01:00
//public $design = 'views/pdf/design1.blade.php'; //@deprecated - never used
2020-03-21 06:37:30 +01:00
2020-11-04 09:43:20 +01:00
public $invoice_terms = '' ; //@implemented
2020-11-04 07:02:15 +01:00
public $quote_terms = '' ; //@implemented
public $invoice_taxes = 0 ; // ? used in AP only?
2020-09-06 11:38:10 +02:00
// public $enabled_item_tax_rates = 0;
2020-11-04 07:02:15 +01:00
public $invoice_design_id = 'VolejRejNm' ; //@implemented
public $quote_design_id = 'VolejRejNm' ; //@implemented
public $credit_design_id = 'VolejRejNm' ; //@implemented
2020-11-04 09:43:20 +01:00
public $invoice_footer = '' ; //@implemented
public $credit_footer = '' ; //@implemented
public $credit_terms = '' ; //@implemented
2020-11-04 07:02:15 +01:00
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?
2021-02-22 23:08:43 +01:00
// public $invoice_fields = ''; //@TODO is this redundant, we store this in the custom_fields on the company?
2020-11-04 07:02:15 +01:00
2021-04-01 10:07:32 +02:00
public $valid_until = '' ; //@implemented
2020-11-04 07:02:15 +01:00
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
2020-03-21 06:37:30 +01:00
//email settings
2020-11-04 07:02:15 +01:00
public $email_sending_method = 'default' ; //enum 'default','gmail' //@implemented
public $gmail_sending_user_id = '0' ; //@implemented
public $reply_to_email = '' ; //@TODO
2021-02-11 11:09:34 +01:00
public $reply_to_name = '' ; //@TODO
2020-11-04 07:02:15 +01:00
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
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 -
2020-11-04 07:02:15 +01:00
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
2020-11-04 07:02:15 +01:00
public $email_template_custom2 = '' ; //@TODO
public $email_template_custom3 = '' ; //@TODO
2020-11-12 02:43:32 +01:00
public $enable_reminder1 = false ; //@implmemented
public $enable_reminder2 = false ; //@implmemented
public $enable_reminder3 = false ; //@implmemented
public $enable_reminder_endless = false ; //@implmemented
2020-11-04 07:02:15 +01:00
2020-11-12 02:43:32 +01:00
public $num_days_reminder1 = 0 ; //@implmemented
public $num_days_reminder2 = 0 ; //@implmemented
public $num_days_reminder3 = 0 ; //@implmemented
2020-03-21 06:37:30 +01:00
2020-11-12 02:43:32 +01:00
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
2020-11-12 02:43:32 +01:00
public $schedule_reminder3 = '' ; // (enum: after_invoice_date, before_due_date, after_due_date) implmemented
2020-03-21 06:37:30 +01:00
2020-11-12 02:43:32 +01:00
public $reminder_send_time = 32400 ; //number of seconds from UTC +0 to send reminders @TODO
2020-03-21 06:37:30 +01:00
2020-11-12 02:43:32 +01:00
public $late_fee_amount1 = 0 ; //@implemented
public $late_fee_amount2 = 0 ; //@implemented
public $late_fee_amount3 = 0 ; //@implemented
2020-03-21 06:37:30 +01:00
2020-11-12 02:43:32 +01:00
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
2020-11-04 08:57:16 +01:00
public $endless_reminder_frequency_id = '0' ; //@implemented
2020-11-12 02:43:32 +01:00
public $late_fee_endless_amount = 0 ; //@implemented
public $late_fee_endless_percent = 0 ; //@implemented
2020-03-21 06:37:30 +01:00
2020-11-12 02:43:32 +01:00
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
2020-03-21 06:37:30 +01:00
/* Company Meta data that we can use to build sub companies*/
2020-11-04 08:57:16 +01:00
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
2020-03-21 06:37:30 +01:00
2020-09-06 11:38:10 +02:00
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
2020-09-06 11:38:10 +02:00
public $primary_font = 'Roboto' ;
public $secondary_font = 'Roboto' ;
2021-01-29 13:05:03 +01:00
public $primary_color = '#142cb5' ;
public $secondary_color = '#7081e0' ;
2020-09-08 06:02:00 +02:00
2020-11-04 08:57:16 +01:00
public $hide_paid_to_date = false ; //@TODO where?
2020-11-12 02:43:32 +01:00
public $embed_documents = false ; //@TODO where?
2020-11-04 08:57:16 +01:00
public $all_pages_header = false ; //@implemented
public $all_pages_footer = false ; //@implemented
public $pdf_variables = '' ; //@implemented
2020-03-21 06:37:30 +01:00
2020-11-12 02:43:32 +01:00
public $portal_custom_head = '' ; //@TODO @BEN
public $portal_custom_css = '' ; //@TODO @BEN
public $portal_custom_footer = '' ; //@TODO @BEN
public $portal_custom_js = '' ; //@TODO @BEN
2020-04-17 12:15:26 +02:00
2020-11-04 08:57:16 +01:00
public $client_can_register = false ; //@implemented
2020-11-12 02:43:32 +01:00
public $client_portal_terms = '' ; //@TODO @BEN
public $client_portal_privacy_policy = '' ; //@TODO @BEN
2020-11-04 08:57:16 +01:00
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
2020-11-04 08:57:16 +01:00
public $use_credits_payment = 'off' ; //always, option, off //@implemented
2021-01-07 07:08:34 +01:00
public $hide_empty_columns_on_pdf = false ;
2020-10-26 20:10:04 +01:00
2020-03-21 06:37:30 +01:00
public static $casts = [
2021-03-17 10:28:44 +01:00
'shared_invoice_credit_counter' => 'bool' ,
2021-02-11 11:09:34 +01:00
'reply_to_name' => 'string' ,
2021-01-07 07:08:34 +01:00
'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' ,
2020-09-08 12:53:16 +02:00
'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' ,
2020-07-16 13:01:39 +02:00
'lock_invoices' => 'string' ,
2020-06-28 00:24:08 +02:00
'client_portal_terms' => 'string' ,
'client_portal_privacy_policy' => 'string' ,
2020-05-26 12:22:50 +02:00
'client_can_register' => 'bool' ,
2020-03-21 06:37:30 +01:00
'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' ,
2020-03-21 06:37:30 +01:00
'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' ,
2020-03-21 06:37:30 +01:00
'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' ,
2020-03-21 06:37:30 +01:00
'task_number_pattern' => 'string' ,
'task_number_counter' => 'int' ,
'expense_number_pattern' => 'string' ,
'expense_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' ,
2020-03-21 06:37:30 +01:00
'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' ,
2020-03-21 06:37:30 +01:00
'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' ,
'enable_client_portal_password' => 'bool' ,
'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',
2020-03-21 06:37:30 +01:00
'invoice_taxes' => 'int' ,
2020-06-10 23:56:08 +02:00
//'enabled_item_tax_rates' => 'int',
2020-03-21 06:37:30 +01:00
'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' ,
2020-03-21 06:37:30 +01:00
'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' ,
2021-04-01 10:07:32 +02:00
'valid_until' => 'string' ,
2020-03-21 06:37:30 +01:00
'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' ,
2020-11-04 07:02:15 +01:00
//'design' => 'string',
2020-03-21 06:37:30 +01:00
'website' => 'string' ,
'pdf_variables' => 'object' ,
2020-04-17 12:15:26 +02:00
'portal_custom_head' => 'string' ,
'portal_custom_css' => 'string' ,
'portal_custom_footer' => 'string' ,
'portal_custom_js' => 'string' ,
2020-08-19 16:35:54 +02:00
'client_portal_enable_uploads' => 'bool' ,
2020-03-21 06:37:30 +01:00
];
2020-04-21 07:16:45 +02:00
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' ,
2020-05-26 10:41:14 +02:00
'payment_terms' => 'string' ,
2020-04-21 07:16:45 +02:00
'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' ,
];
2020-03-21 06:37:30 +01:00
/**
* Array of variables which
2020-09-06 11:38:10 +02:00
* cannot be modified client side .
2020-03-21 06:37:30 +01:00
*/
public static $protected_fields = [
// 'credit_number_counter',
// 'invoice_number_counter',
// 'quote_number_counter',
];
2020-04-21 07:16:45 +02:00
public static $string_casts = [
'invoice_design_id' ,
'quote_design_id' ,
'credit_design_id' ,
];
2020-03-21 06:37:30 +01:00
/**
* Cast object values and return entire class
* prevents missing properties from not being returned
2020-09-06 11:38:10 +02:00
* and always ensure an up to date class is returned .
2020-03-21 06:37:30 +01:00
*
2020-10-28 11:10:49 +01:00
* @ param $obj
2020-03-21 06:37:30 +01:00
*/
public function __construct ( $obj )
{
// parent::__construct($obj);
}
/**
2020-09-06 11:38:10 +02:00
* Provides class defaults on init .
2020-11-25 15:19:52 +01:00
*
2020-11-01 06:09:09 +01:00
* @ return stdClass
2020-03-21 06:37:30 +01:00
*/
2020-10-28 11:10:49 +01:00
public static function defaults () : stdClass
2020-03-21 06:37:30 +01:00
{
$config = json_decode ( config ( 'ninja.settings' ));
2020-09-06 11:38:10 +02:00
$data = ( object ) get_class_vars ( self :: class );
2020-03-21 06:37:30 +01:00
unset ( $data -> casts );
unset ( $data -> protected_fields );
2020-04-21 07:16:45 +02:00
unset ( $data -> free_plan_casts );
unset ( $data -> string_casts );
2020-09-06 11:38:10 +02:00
$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 ();
2020-03-21 06:37:30 +01:00
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-03-21 06:37:30 +01:00
*/
2020-10-28 11:10:49 +01:00
public static function setProperties ( $settings ) : stdClass
2020-03-21 06:37:30 +01:00
{
2020-09-06 11:38:10 +02:00
$company_settings = ( object ) get_class_vars ( self :: class );
2020-03-21 06:37:30 +01:00
foreach ( $company_settings as $key => $value ) {
2020-09-06 11:38:10 +02:00
if ( ! property_exists ( $settings , $key )) {
2020-11-12 12:09:31 +01:00
$settings -> { $key } = self :: castAttribute ( $key , $company_settings -> { $key });
2020-03-21 06:37:30 +01:00
}
}
return $settings ;
}
2020-11-12 02:43:32 +01:00
/**
* Stubs the notification defaults
2020-11-25 15:19:52 +01:00
*
2020-11-12 02:43:32 +01:00
* @ return stdClass
*/
public static function notificationDefaults () : stdClass
2020-03-21 06:37:30 +01:00
{
2020-10-28 11:10:49 +01:00
$notification = new stdClass ;
2021-03-24 10:14:30 +01:00
$notification -> email = [];
// $notification->email = ['all_notifications'];
2020-03-21 06:37:30 +01:00
return $notification ;
}
2020-11-12 02:43:32 +01:00
/**
* Defines entity variables for PDF generation
2020-11-25 15:19:52 +01:00
*
2020-11-12 02:43:32 +01:00
* @ return stdClass The stdClass of PDF variables
*/
private static function getEntityVariableDefaults () : stdClass
2020-03-21 06:37:30 +01:00
{
$variables = [
2020-03-28 04:45:11 +01:00
'client_details' => [
'$client.name' ,
2020-12-11 13:20:46 +01:00
'$client.id_number' ,
2020-03-28 04:45:11 +01:00
'$client.vat_number' ,
'$client.address1' ,
'$client.address2' ,
'$client.city_state_postal' ,
'$client.country' ,
'$contact.email' ,
2021-04-05 14:37:25 +02:00
'$client.phone' ,
2020-03-21 06:37:30 +01:00
],
2020-03-28 04:45:11 +01:00
'company_details' => [
2020-03-29 23:29:00 +02:00
'$company.name' ,
2020-03-28 04:45:11 +01:00
'$company.id_number' ,
'$company.vat_number' ,
'$company.website' ,
'$company.email' ,
'$company.phone' ,
2020-03-21 06:37:30 +01:00
],
2020-03-28 04:45:11 +01:00
'company_address' => [
'$company.address1' ,
'$company.address2' ,
'$company.city_state_postal' ,
'$company.country' ,
2020-03-21 06:37:30 +01:00
],
2020-03-28 04:45:11 +01:00
'invoice_details' => [
2020-08-10 17:21:56 +02:00
'$invoice.number' ,
2020-03-28 04:45:11 +01:00
'$invoice.po_number' ,
2020-08-10 17:21:56 +02:00
'$invoice.date' ,
2020-03-28 04:45:11 +01:00
'$invoice.due_date' ,
2020-08-10 17:21:56 +02:00
'$invoice.total' ,
2021-03-03 11:04:10 +01:00
'$invoice.balance_due' ,
2020-03-21 06:37:30 +01:00
],
2020-03-28 04:45:11 +01:00
'quote_details' => [
2020-08-10 17:21:56 +02:00
'$quote.number' ,
2020-03-28 04:45:11 +01:00
'$quote.po_number' ,
2020-08-10 17:21:56 +02:00
'$quote.date' ,
2020-03-28 04:45:11 +01:00
'$quote.valid_until' ,
2020-08-10 17:21:56 +02:00
'$quote.total' ,
2020-03-21 06:37:30 +01:00
],
2020-03-28 04:45:11 +01:00
'credit_details' => [
2020-09-29 14:31:08 +02:00
'$credit.number' ,
2020-03-28 04:45:11 +01:00
'$credit.po_number' ,
2020-09-29 14:31:08 +02:00
'$credit.date' ,
'$credit.balance' ,
2020-09-30 00:42:55 +02:00
'$credit.total' ,
2020-03-21 06:37:30 +01:00
],
2020-03-28 04:45:11 +01:00
'product_columns' => [
2020-12-23 14:25:12 +01:00
'$product.item' ,
2020-11-13 12:52:11 +01:00
'$product.description' ,
'$product.unit_cost' ,
2020-03-28 04:45:11 +01:00
'$product.quantity' ,
2021-01-13 08:20:46 +01:00
'$product.discount' ,
2020-03-29 23:29:00 +02:00
'$product.tax' ,
2020-03-28 04:45:11 +01:00
'$product.line_total' ,
2020-03-21 06:37:30 +01:00
],
2020-03-28 04:45:11 +01:00
'task_columns' => [
2020-12-08 16:10:29 +01:00
'$task.service' ,
2020-11-13 12:52:11 +01:00
'$task.description' ,
2020-11-04 11:22:43 +01:00
'$task.rate' ,
'$task.hours' ,
2021-01-13 08:20:46 +01:00
'$task.discount' ,
2020-03-29 23:29:00 +02:00
'$task.tax' ,
2020-03-28 04:45:11 +01:00
'$task.line_total' ,
2020-03-21 06:37:30 +01:00
],
2020-08-14 05:59:14 +02:00
'total_columns' => [
'$subtotal' ,
'$discount' ,
'$custom_surcharge1' ,
'$custom_surcharge2' ,
'$custom_surcharge3' ,
'$custom_surcharge4' ,
2021-02-25 11:41:18 +01:00
'$total_taxes' ,
'$line_taxes' ,
2020-09-27 12:39:13 +02:00
'$paid_to_date' ,
'$outstanding' ,
2020-08-14 05:59:14 +02:00
],
2020-03-21 06:37:30 +01:00
];
2020-09-06 11:38:10 +02:00
2020-03-21 06:37:30 +01:00
return json_decode ( json_encode ( $variables ));
}
2019-02-17 11:34:46 +01:00
}