2019-09-02 07:08:26 +02:00
< ? php
/**
* Invoice Ninja ( https :// invoiceninja . com )
*
* @ link https :// github . com / invoiceninja / invoiceninja source repository
*
2020-01-07 01:13:47 +01:00
* @ copyright Copyright ( c ) 2020. Invoice Ninja LLC ( https :// invoiceninja . com )
2019-09-02 07:08:26 +02:00
*
* @ license https :// opensource . org / licenses / AAL
*/
namespace App\Utils\Traits ;
2019-12-16 12:34:38 +01:00
use App\Models\Country ;
2020-02-26 05:11:17 +01:00
use App\Models\Credit ;
use App\Models\Invoice ;
use App\Models\Quote ;
2019-09-02 07:08:26 +02:00
use App\Utils\Number ;
/**
* Class MakesInvoiceValues
* @ package App\Utils\Traits
*/
trait MakesInvoiceValues
{
2019-12-30 22:59:12 +01:00
/**
* Master list of columns used
* for invoice tables
* @ var array
*/
2019-09-04 01:16:23 +02:00
private static $master_columns = [
'date' ,
'discount' ,
'product_key' ,
'notes' ,
'cost' ,
'quantity' ,
'tax_name1' ,
'tax_name2' ,
2019-10-05 04:28:23 +02:00
'tax_name3' ,
2019-09-04 01:16:23 +02:00
'line_total' ,
'custom_label1' ,
'custom_label2' ,
'custom_label3' ,
'custom_label4' ,
];
2020-02-10 10:53:02 +01:00
private static $custom_label_fields = [
'invoice1' ,
'invoice2' ,
'invoice3' ,
'invoice4' ,
'surcharge1' ,
'surcharge2' ,
'surcharge3' ,
'surcharge4' ,
'client1' ,
'client2' ,
'client3' ,
'client4' ,
'contact1' ,
'contact2' ,
'contact3' ,
'contact4' ,
'company1' ,
'company2' ,
'company3' ,
'company4' ,
2019-09-04 03:45:53 +02:00
];
2020-03-16 11:12:10 +01:00
public function makeCustomField ( $field ) : string
2019-09-03 01:00:52 +02:00
{
2020-02-06 10:35:51 +01:00
$custom_fields = $this -> company -> custom_fields ;
2020-03-17 09:40:10 +01:00
if ( $custom_fields && property_exists ( $custom_fields , $field )){
2020-03-16 11:12:10 +01:00
$custom_field = $custom_fields -> { $field };
$custom_field_parts = explode ( " | " , $custom_field );
return $custom_field_parts [ 0 ];
2019-09-03 01:00:52 +02:00
2019-12-30 22:59:12 +01:00
}
2019-09-03 01:00:52 +02:00
2020-03-16 11:12:10 +01:00
return '' ;
2020-02-10 10:53:02 +01:00
2020-03-16 11:12:10 +01:00
}
public function makeLabels ( $contact = null ) : array
{
$data = [];
$values = $this -> makeLabelsAndValues ( $contact );
foreach ( $values as $key => $value )
{
$data [ $key . '_label' ] = $value [ 'label' ];
}
2020-02-06 10:35:51 +01:00
2019-12-30 22:59:12 +01:00
return $data ;
}
2019-09-03 01:00:52 +02:00
2019-12-30 22:59:12 +01:00
/**
* Transforms all placeholders
2019-09-04 23:50:16 +02:00
* to invoice values
2019-12-30 22:59:12 +01:00
*
* @ return array returns an array
2019-09-04 23:50:16 +02:00
* of keyed labels ( appended with _label )
2019-09-03 01:00:52 +02:00
*/
2019-12-24 22:55:29 +01:00
public function makeValues ( $contact = null ) : array
2020-03-16 11:12:10 +01:00
{
$data = [];
$values = $this -> makeLabelsAndValues ( $contact );
foreach ( $values as $key => $value )
{
$data [ $key ] = $value [ 'value' ];
}
return $data ;
}
private function makeLabelsAndValues ( $contact = null ) : array
2019-09-02 07:08:26 +02:00
{
2019-12-30 22:59:12 +01:00
if ( ! $this -> client -> currency () || ! $this -> client ) {
2020-02-17 19:05:11 +01:00
throw new \Exception ( debug_backtrace ()[ 1 ][ 'function' ], 1 );
2019-10-07 11:39:22 +02:00
exit ;
}
2019-12-16 12:34:38 +01:00
$settings = $this -> client -> getMergedSettings ();
2019-09-02 07:08:26 +02:00
$data = [];
2020-03-16 11:12:10 +01:00
$data [ '$tax' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.tax' )];
$data [ '$app_url' ] = [ 'value' => $this -> generateAppUrl (), 'label' => '' ];
$data [ '$from' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.from' )];
$data [ '$to' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.to' )];
$data [ '$total_tax_labels' ] = [ 'value' => $this -> totalTaxLabels (), 'label' => ctrans ( 'texts.taxes' )];
$data [ '$total_tax_values' ] = [ 'value' => $this -> totalTaxValues (), 'label' => ctrans ( 'texts.taxes' )];
$data [ '$line_tax_labels' ] = [ 'value' => $this -> lineTaxLabels (), 'label' => ctrans ( 'texts.taxes' )];
$data [ '$line_tax_values' ] = [ 'value' => $this -> lineTaxValues (), 'label' => ctrans ( 'texts.taxes' )];
$data [ '$date' ] = [ 'value' => $this -> date ? : ' ' , 'label' => ctrans ( 'texts.date' )];
$data [ '$invoice_date' ] = [ 'value' => $this -> date ? : ' ' , 'label' => ctrans ( 'texts.invoice_date' )];
$data [ '$invoice.date' ] = & $data [ '$date' ];
$data [ '$due_date' ] = [ 'value' => $this -> due_date ? : ' ' , 'label' => ctrans ( 'texts.due_date' )];
$data [ '$invoice.due_date' ] = & $data [ '$due_date' ];
$data [ '$invoice.number' ] = [ 'value' => $this -> number ? : ' ' , 'label' => ctrans ( 'texts.invoice_number' )];
$data [ '$invoice.invoice_number' ] = & $data [ '$invoice.number' ];
$data [ '$invoice_number' ] = & $data [ '$invoice.number' ];
$data [ '$po_number' ] = [ 'value' => $this -> po_number ? : ' ' , 'label' => ctrans ( 'texts.po_number' )];
$data [ '$invoice.po_number' ] = & $data [ '$po_number' ];
$data [ '$line_taxes' ] = [ 'value' => $this -> makeLineTaxes () ? : ' ' , 'label' => ctrans ( 'texts.taxes' )];
$data [ '$invoice.line_taxes' ] = & $data [ '$line_taxes' ];
$data [ '$total_taxes' ] = [ 'value' => $this -> makeTotalTaxes () ? : ' ' , 'label' => ctrans ( 'texts.taxes' )];
$data [ '$invoice.total_taxes' ] = & $data [ '$total_taxes' ];
if ( $this instanceof Invoice ){
$data [ '$entity_label' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.invoice' )];
$data [ '$number' ] = [ 'value' => $this -> number ? : ' ' , 'label' => ctrans ( 'texts.invoice_number' )];
$data [ '$entity.terms' ] = [ 'value' => $this -> terms ? : ' ' , 'label' => ctrans ( 'texts.invoice_terms' )];
$data [ '$terms' ] = & $data [ '$entity.terms' ];
}
if ( $this instanceof Quote ){
$data [ '$entity_label' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.quote' )];
$data [ '$number' ] = [ 'value' => $this -> number ? : ' ' , 'label' => ctrans ( 'texts.quote_number' )];
$data [ '$entity.terms' ] = [ 'value' => $this -> terms ? : ' ' , 'label' => ctrans ( 'texts.quote_terms' )];
$data [ '$terms' ] = & $data [ '$entity.terms' ];
}
2019-09-02 07:08:26 +02:00
2020-03-16 11:12:10 +01:00
if ( $this instanceof Credit ){
$data [ '$entity_label' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.credit' )];
$data [ '$number' ] = [ 'value' => $this -> number ? : ' ' , 'label' => ctrans ( 'texts.credit_number' )];
$data [ '$entity.terms' ] = [ 'value' => $this -> terms ? : ' ' , 'label' => ctrans ( 'texts.credit_terms' )];
$data [ '$terms' ] = & $data [ '$entity.terms' ];
}
$data [ '$entity_number' ] = & $data [ '$number' ];
//$data['$paid_to_date'] = ;
$data [ '$discount' ] = [ 'value' => Number :: formatMoney ( $this -> calc () -> getTotalDiscount (), $this -> client ) ? : ' ' , 'label' => ctrans ( 'texts.discount' )];
$data [ '$invoice.discount' ] = & $data [ '$discount' ];
$data [ '$subtotal' ] = [ 'value' => Number :: formatMoney ( $this -> calc () -> getSubTotal (), $this -> client ) ? : ' ' , 'label' => ctrans ( 'texts.subtotal' )];
$data [ '$invoice.subtotal' ] = & $data [ '$subtotal' ];
$data [ '$balance_due' ] = [ 'value' => Number :: formatMoney ( $this -> balance , $this -> client ) ? : ' ' , 'label' => ctrans ( 'texts.balance_due' )];
$data [ '$invoice.balance_due' ] = & $data [ '$balance_due' ];
$data [ '$partial_due' ] = [ 'value' => Number :: formatMoney ( $this -> partial , $this -> client ) ? : ' ' , 'label' => ctrans ( 'texts.partial_due' )];
$data [ '$invoice.partial_due' ] = & $data [ '$partial_due' ];
$data [ '$total' ] = [ 'value' => Number :: formatMoney ( $this -> calc () -> getTotal (), $this -> client ) ? : ' ' , 'label' => ctrans ( 'texts.total' )];
$data [ '$invoice.total' ] = [ 'value' => Number :: formatMoney ( $this -> calc () -> getTotal (), $this -> client ) ? : ' ' , 'label' => ctrans ( 'texts.invoice_total' )];
$data [ '$amount' ] = & $data [ '$total' ];
$data [ '$invoice_total' ] = & $data [ '$total' ];
$data [ '$invoice.amount' ] = & $data [ '$total' ];
$data [ '$quote_total' ] = [ 'value' => Number :: formatMoney ( $this -> calc () -> getTotal (), $this -> client ) ? : ' ' , 'label' => ctrans ( 'texts.quote_total' )];
$data [ '$quote.amount' ] = & $data [ '$quote_total' ];
$data [ '$credit_total' ] = [ 'value' => Number :: formatMoney ( $this -> calc () -> getTotal (), $this -> client ) ? : ' ' , 'label' => ctrans ( 'texts.credit_total' )];
$data [ '$credit.amount' ] = & $data [ '$credit_total' ];
$data [ '$balance' ] = [ 'value' => Number :: formatMoney ( $this -> calc () -> getBalance (), $this -> client ) ? : ' ' , 'label' => ctrans ( 'texts.balance' )];
$data [ '$invoice.balance' ] = & $data [ '$balance' ];
$data [ '$taxes' ] = [ 'value' => Number :: formatMoney ( $this -> calc () -> getItemTotalTaxes (), $this -> client ) ? : ' ' , 'label' => ctrans ( 'texts.taxes' )];
$data [ '$invoice.taxes' ] = & $data [ '$taxes' ];
$data [ '$invoice1' ] = [ 'value' => $this -> custom_value1 ? : ' ' , 'label' => $this -> makeCustomField ( 'invoice1' )];
$data [ '$invoice2' ] = [ 'value' => $this -> custom_value2 ? : ' ' , 'label' => $this -> makeCustomField ( 'invoice2' )];
$data [ '$invoice3' ] = [ 'value' => $this -> custom_value3 ? : ' ' , 'label' => $this -> makeCustomField ( 'invoice3' )];
$data [ '$invoice4' ] = [ 'value' => $this -> custom_value4 ? : ' ' , 'label' => $this -> makeCustomField ( 'invoice4' )];
$data [ '$invoice.public_notes' ] = [ 'value' => $this -> public_notes ? : ' ' , 'label' => ctrans ( 'texts.public_notes' )];
$data [ '$entity.public_notes' ] = & $data [ '$invoice.public_notes' ];
2020-02-20 22:05:01 +01:00
2019-12-30 22:59:12 +01:00
// $data['$your_invoice'] = ;
// $data['$quote'] = ;
// $data['$your_quote'] = ;
2020-03-16 11:12:10 +01:00
//
$data [ '$quote_date' ] = [ 'value' => $this -> date ? : ' ' , 'label' => ctrans ( 'texts.quote_date' )];
$data [ '$quote_number' ] = [ 'value' => $this -> number ? : ' ' , 'label' => ctrans ( 'texts.quote_number' )];
$data [ '$quote.quote_number' ] = & $data [ '$quote_number' ];
$data [ '$quote_no' ] = & $data [ '$quote_number' ];
$data [ '$quote.quote_no' ] = & $data [ '$quote_number' ];
$data [ '$valid_until' ] = [ 'value' => $this -> due_date , 'label' => ctrans ( 'texts.valid_until' )];
$data [ '$quote_total' ] = [ 'value' => Number :: formatMoney ( $this -> calc () -> getTotal (), $this -> client ) ? : ' ' , 'label' => ctrans ( 'texts.quote_total' )];
$data [ '$credit_amount' ] = [ 'value' => Number :: formatMoney ( $this -> calc () -> getTotal (), $this -> client ) ? : ' ' , 'label' => ctrans ( 'texts.credit_amount' )];
$data [ '$credit_balance' ] = [ 'value' => Number :: formatMoney ( $this -> balance , $this -> client ) ? : ' ' , 'label' => ctrans ( 'texts.credit_balance' )];;
$data [ '$credit_number' ] = & $data [ '$number' ];
$data [ '$credit_no' ] = & $data [ '$number' ];
$data [ '$credit.credit_no' ] = & $data [ '$number' ];
2020-02-19 21:44:12 +01:00
2019-12-30 22:59:12 +01:00
// $data['$invoice_issued_to'] = ;
// $data['$quote_issued_to'] = ;
// $data['$rate'] = ;
// $data['$hours'] = ;
// $data['$from'] = ;
// $data['$to'] = ;
// $data['$invoice_to'] = ;
// $data['$quote_to'] = ;
// $data['$details'] = ;
2020-03-16 11:12:10 +01:00
$data [ '$invoice_no' ] = & $data [ '$number' ];
$data [ '$invoice.invoice_no' ] = & $data [ '$number' ];
$data [ '$client1' ] = [ 'value' => $this -> client -> custom_value1 ? : ' ' , 'label' => $this -> makeCustomField ( 'client1' )];
$data [ '$client2' ] = [ 'value' => $this -> client -> custom_value2 ? : ' ' , 'label' => $this -> makeCustomField ( 'client2' )];
$data [ '$client3' ] = [ 'value' => $this -> client -> custom_value3 ? : ' ' , 'label' => $this -> makeCustomField ( 'client3' )];
$data [ '$client4' ] = [ 'value' => $this -> client -> custom_value4 ? : ' ' , 'label' => $this -> makeCustomField ( 'client4' )];
$data [ '$address1' ] = [ 'value' => $this -> client -> address1 ? : ' ' , 'label' => ctrans ( 'texts.address1' )];
$data [ '$address2' ] = [ 'value' => $this -> client -> address2 ? : ' ' , 'label' => ctrans ( 'texts.address2' )];
$data [ '$id_number' ] = [ 'value' => $this -> client -> id_number ? : ' ' , 'label' => ctrans ( 'texts.id_number' )];
$data [ '$vat_number' ] = [ 'value' => $this -> client -> vat_number ? : ' ' , 'label' => ctrans ( 'texts.vat_number' )];
$data [ '$website' ] = [ 'value' => $this -> client -> present () -> website () ? : ' ' , 'label' => ctrans ( 'texts.website' )];
$data [ '$phone' ] = [ 'value' => $this -> client -> present () -> phone () ? : ' ' , 'label' => ctrans ( 'texts.phone' )];
$data [ '$country' ] = [ 'value' => isset ( $this -> client -> country -> name ) ? $this -> client -> country -> name : 'No Country Set' , 'label' => ctrans ( 'texts.country' )];
$data [ '$email' ] = [ 'value' => isset ( $this -> client -> primary_contact () -> first () -> email ) ? $this -> client -> primary_contact () -> first () -> email : 'no contact email on record' , 'label' => ctrans ( 'texts.email' )];
$data [ '$client_name' ] = [ 'value' => $this -> present () -> clientName () ? : ' ' , 'label' => ctrans ( 'texts.client_name' )];
$data [ '$client.name' ] = & $data [ '$client_name' ];
$data [ '$client.address1' ] = & $data [ '$address1' ];
$data [ '$client.address2' ] = & $data [ '$address2' ];
$data [ '$client_address' ] = [ 'value' => $this -> present () -> address () ? : ' ' , 'label' => ctrans ( 'texts.address' )];
$data [ '$client.address' ] = & $data [ '$client_address' ];
$data [ '$client.id_number' ] = & $data [ '$id_number' ];
$data [ '$client.vat_number' ] = & $data [ '$vat_number' ];
$data [ '$client.website' ] = & $data [ '$website' ];
$data [ '$client.phone' ] = & $data [ '$phone' ];
$data [ '$city_state_postal' ] = [ 'value' => $this -> present () -> cityStateZip ( $this -> client -> city , $this -> client -> state , $this -> client -> postal_code , false ) ? : ' ' , 'label' => ctrans ( 'texts.city_state_postal' )];
$data [ '$client.city_state_postal' ] = & $data [ '$city_state_postal' ];
$data [ '$postal_city_state' ] = [ 'value' => $this -> present () -> cityStateZip ( $this -> client -> city , $this -> client -> state , $this -> client -> postal_code , true ) ? : ' ' , 'label' => ctrans ( 'texts.postal_city_state' )];
$data [ '$client.postal_city_state' ] = & $data [ '$postal_city_state' ];
$data [ '$client.country' ] = & $data [ '$country' ];
$data [ '$client.email' ] = & $data [ '$email' ];
2019-12-30 22:59:12 +01:00
2020-02-05 05:06:03 +01:00
if ( ! $contact )
2020-02-05 11:28:56 +01:00
$contact = $this -> client -> primary_contact () -> first ();
2020-02-05 05:06:03 +01:00
2020-03-16 11:12:10 +01:00
$data [ '$contact_name' ] = [ 'value' => isset ( $contact ) ? $contact -> present () -> name () : 'no contact name on record' , 'label' => ctrans ( 'texts.contact_name' )];
$data [ '$contact.name' ] = & $data [ '$contact_name' ];
$data [ '$contact1' ] = [ 'value' => isset ( $contact ) ? $contact -> custom_value1 : ' ' , 'label' => $this -> makeCustomField ( 'contact1' )];
$data [ '$contact2' ] = [ 'value' => isset ( $contact ) ? $contact -> custom_value2 : ' ' , 'label' => $this -> makeCustomField ( 'contact1' )];
$data [ '$contact3' ] = [ 'value' => isset ( $contact ) ? $contact -> custom_value3 : ' ' , 'label' => $this -> makeCustomField ( 'contact1' )];
$data [ '$contact4' ] = [ 'value' => isset ( $contact ) ? $contact -> custom_value4 : ' ' , 'label' => $this -> makeCustomField ( 'contact1' )];
$data [ '$company.city_state_postal' ] = [ 'value' => $this -> company -> present () -> cityStateZip ( $settings -> city , $settings -> state , $settings -> postal_code , false ) ? : ' ' , 'label' => ctrans ( 'texts.city_state_postal' )];
$data [ '$company.postal_city_state' ] = [ 'value' => $this -> company -> present () -> cityStateZip ( $settings -> city , $settings -> state , $settings -> postal_code , true ) ? : ' ' , 'label' => ctrans ( 'texts.postal_city_state' )];
$data [ '$company.name' ] = [ 'value' => $this -> company -> present () -> name () ? : ' ' , 'label' => ctrans ( 'texts.company_name' )];
$data [ '$company.company_name' ] = & $data [ '$company.name' ];
$data [ '$company.address1' ] = [ 'value' => $settings -> address1 ? : ' ' , 'label' => ctrans ( 'texts.address1' )];
$data [ '$company.address2' ] = [ 'value' => $settings -> address2 ? : ' ' , 'label' => ctrans ( 'texts.address2' )];
$data [ '$company.city' ] = [ 'value' => $settings -> city ? : ' ' , 'label' => ctrans ( 'texts.city' )];
$data [ '$company.state' ] = [ 'value' => $settings -> state ? : ' ' , 'label' => ctrans ( 'texts.state' )];
$data [ '$company.postal_code' ] = [ 'value' => $settings -> postal_code ? : ' ' , 'label' => ctrans ( 'texts.postal_code' )];
$data [ '$company.country' ] = [ 'value' => Country :: find ( $settings -> country_id ) -> first () -> name ? : ' ' , 'label' => ctrans ( 'texts.country' )];
$data [ '$company.phone' ] = [ 'value' => $settings -> phone ? : ' ' , 'label' => ctrans ( 'texts.phone' )];
$data [ '$company.email' ] = [ 'value' => $settings -> email ? : ' ' , 'label' => ctrans ( 'texts.email' )];
$data [ '$company.vat_number' ] = [ 'value' => $settings -> vat_number ? : ' ' , 'label' => ctrans ( 'texts.vat_number' )];
$data [ '$company.id_number' ] = [ 'value' => $settings -> id_number ? : ' ' , 'label' => ctrans ( 'texts.id_number' )];
$data [ '$company.website' ] = [ 'value' => $settings -> website ? : ' ' , 'label' => ctrans ( 'texts.website' )];
$data [ '$company.address' ] = [ 'value' => $this -> company -> present () -> address ( $settings ) ? : ' ' , 'label' => ctrans ( 'texts.address' )];
2020-02-05 11:28:56 +01:00
$logo = $this -> company -> present () -> logo ( $settings );
2020-03-16 11:12:10 +01:00
$data [ '$company.logo' ] = [ 'value' => " <img src=' { $logo } ' class='w-48' alt='logo'> " ? : ' ' , 'label' => ctrans ( 'texts.logo' )];
$data [ '$company_logo' ] = & $data [ '$company.logo' ];
$data [ '$company1' ] = [ 'value' => $settings -> custom_value1 ? : ' ' , 'label' => $this -> makeCustomField ( 'company1' )];
$data [ '$company2' ] = [ 'value' => $settings -> custom_value2 ? : ' ' , 'label' => $this -> makeCustomField ( 'company2' )];
$data [ '$company3' ] = [ 'value' => $settings -> custom_value3 ? : ' ' , 'label' => $this -> makeCustomField ( 'company3' )];
$data [ '$company4' ] = [ 'value' => $settings -> custom_value4 ? : ' ' , 'label' => $this -> makeCustomField ( 'company4' )];
$data [ '$product.date' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.date' )];
$data [ '$product.discount' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.discount' )];
$data [ '$product.product_key' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.product_key' )];
$data [ '$product.notes' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.notes' )];
$data [ '$product.cost' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.cost' )];
$data [ '$product.quantity' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.quantity' )];
$data [ '$product.tax_name1' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.tax' )];
$data [ '$product.tax_name2' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.tax' )];
$data [ '$product.tax_name3' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.tax' )];
$data [ '$product.line_total' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.line_total' )];
$data [ '$task.date' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.date' )];
$data [ '$task.discount' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.discount' )];
$data [ '$task.product_key' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.product_key' )];
$data [ '$task.notes' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.notes' )];
$data [ '$task.cost' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.cost' )];
$data [ '$task.quantity' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.quantity' )];
$data [ '$task.tax_name1' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.tax' )];
$data [ '$task.tax_name2' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.tax' )];
$data [ '$task.tax_name3' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.tax' )];
$data [ '$task.line_total' ] = [ 'value' => '' , 'label' => ctrans ( 'texts.line_total' )];
// $data['custom_label1'] = ['value' => '', 'label' => ctrans('texts.')];
// $data['custom_label2'] = ['value' => '', 'label' => ctrans('texts.')];
// $data['custom_label3'] = ['value' => '', 'label' => ctrans('texts.')];
// $data['custom_label4'] = ['value' => '', 'label' => ctrans('texts.')];
2019-12-30 22:59:12 +01:00
//$data['$blank'] = ;
//$data['$surcharge'] = ;
/*
$data [ '$tax_invoice' ] =
$data [ '$tax_quote' ] =
$data [ '$statement' ] = ;
$data [ '$statement_date' ] = ;
$data [ '$your_statement' ] = ;
$data [ '$statement_issued_to' ] = ;
$data [ '$statement_to' ] = ;
$data [ '$credit_note' ] = ;
$data [ '$credit_date' ] = ;
$data [ '$credit_issued_to' ] = ;
$data [ '$credit_to' ] = ;
$data [ '$your_credit' ] = ;
$data [ '$phone' ] = ;
2020-02-05 05:06:03 +01:00
2019-12-30 22:59:12 +01:00
$data [ '$outstanding' ] = ;
$data [ '$invoice_due_date' ] = ;
$data [ '$quote_due_date' ] = ;
$data [ '$service' ] = ;
$data [ '$product_key' ] = ;
$data [ '$unit_cost' ] = ;
$data [ '$custom_value1' ] = ;
$data [ '$custom_value2' ] = ;
$data [ '$delivery_note' ] = ;
$data [ '$date' ] = ;
$data [ '$method' ] = ;
$data [ '$payment_date' ] = ;
$data [ '$reference' ] = ;
$data [ '$amount' ] = ;
$data [ '$amount_paid' ] = ;
2019-09-02 07:08:26 +02:00
*/
2020-02-10 10:53:02 +01:00
$arrKeysLength = array_map ( 'strlen' , array_keys ( $data ));
array_multisort ( $arrKeysLength , SORT_DESC , $data );
2019-09-02 07:08:26 +02:00
return $data ;
}
2019-09-03 01:00:52 +02:00
/**
2020-03-16 11:12:10 +01:00
* V2 of building a table header for PDFs
* @ param array $columns The array ( or string of column headers )
* @ return string injectable HTML string
2019-09-03 01:00:52 +02:00
*/
2020-03-16 11:12:10 +01:00
public function buildTableHeader ( $columns ) : ? string
2019-09-03 01:00:52 +02:00
{
2019-09-04 01:16:23 +02:00
2020-03-16 11:12:10 +01:00
$data = $this -> makeLabels ();
2019-09-03 01:00:52 +02:00
2020-03-16 11:12:10 +01:00
$table_header = '<tr>' ;
2019-09-03 01:00:52 +02:00
2020-03-16 11:12:10 +01:00
foreach ( $columns as $key => $column ) {
2019-09-04 01:16:23 +02:00
2020-03-16 11:12:10 +01:00
$table_header .= '<td class="table_header_td_class">' . $key . '_label</td>' ;
2019-12-30 22:59:12 +01:00
}
2020-02-05 11:28:56 +01:00
2020-03-09 21:07:46 +01:00
$table_header .= '</tr>' ;
2020-02-05 11:28:56 +01:00
2020-03-16 11:12:10 +01:00
$table_header = str_replace ( array_keys ( $data ), array_values ( $data ), $table_header );
2020-02-05 11:28:56 +01:00
return $table_header ;
}
2020-03-07 07:31:26 +01:00
/**
2020-03-16 11:12:10 +01:00
* V2 of building a table body for PDFs
* @ param array $columns The array ( or string of column headers )
* @ return string injectable HTML string
2020-03-07 07:31:26 +01:00
*/
2020-03-16 11:12:10 +01:00
public function buildTableBody ( array $default_columns , string $user_columns , string $table_prefix ) : ? string
2020-02-05 11:28:56 +01:00
{
2020-03-16 11:12:10 +01:00
$items = $this -> transformLineItems ( $this -> line_items , $table_prefix );
if ( count ( $items ) == 0 )
return '' ;
2020-02-05 11:28:56 +01:00
2020-03-16 11:12:10 +01:00
$data = $this -> makeValues ();
2020-02-05 11:28:56 +01:00
2020-03-16 11:12:10 +01:00
$output = '' ;
2020-02-05 11:28:56 +01:00
2020-03-16 11:12:10 +01:00
if ( strlen ( $user_columns ) > 1 ) {
2020-02-05 11:28:56 +01:00
2020-03-16 11:12:10 +01:00
foreach ( $items as $key => $item ){
$tmp = str_replace ( array_keys ( $data ), array_values ( $data ), $user_columns );
$tmp = str_replace ( array_keys ( $item ), array_values ( $item ), $tmp );
2020-02-05 11:28:56 +01:00
2020-03-16 11:12:10 +01:00
$output .= $tmp ;
2020-02-05 11:28:56 +01:00
}
2020-03-16 11:12:10 +01:00
}
else {
$table_row = '<tr>' ;
2020-02-05 11:28:56 +01:00
2020-03-16 11:12:10 +01:00
foreach ( $default_columns as $key => $column ) {
$table_row .= '<td class="table_header_td_class">' . $key . '</td>' ;
}
$table_row .= '</tr>' ;
foreach ( $items as $key => $item ){
$tmp = str_replace ( array_keys ( $item ), array_values ( $item ), $table_row );
$tmp = str_replace ( array_keys ( $data ), array_values ( $data ), $tmp );
$output .= $tmp ;
}
2020-02-05 11:28:56 +01:00
}
2020-03-16 11:12:10 +01:00
return $output ;
2020-02-05 11:28:56 +01:00
}
2019-09-03 08:01:40 +02:00
/**
2019-09-04 01:16:23 +02:00
* Transform the column headers into translated header values
2019-12-30 22:59:12 +01:00
*
2019-09-04 01:16:23 +02:00
* @ param array $columns The column header values
* @ return array The new column header variables
*/
private function transformColumnsForHeader ( array $columns ) : array
{
2020-03-05 08:14:57 +01:00
if ( count ( $columns ) == 0 )
return [];
2019-09-04 07:10:10 +02:00
$pre_columns = $columns ;
$columns = array_intersect ( $columns , self :: $master_columns );
2019-09-04 01:16:23 +02:00
2019-12-30 22:59:12 +01:00
return str_replace (
[
2019-09-04 01:16:23 +02:00
'tax_name1' ,
2020-02-19 21:44:12 +01:00
'tax_name2' ,
'tax_name3'
2019-12-30 22:59:12 +01:00
],
2019-09-04 01:16:23 +02:00
[
'tax' ,
'tax' ,
2020-02-19 21:44:12 +01:00
'tax'
2019-12-30 22:59:12 +01:00
],
$columns
);
2019-09-04 01:16:23 +02:00
}
/**
2019-12-30 22:59:12 +01:00
*
2019-09-03 08:01:40 +02:00
* Transform the column headers into invoice variables
2019-12-30 22:59:12 +01:00
*
2019-09-03 08:01:40 +02:00
* @ param array $columns The column header values
* @ return array The invoice variables
*/
2019-09-04 01:16:23 +02:00
private function transformColumnsForLineItems ( array $columns ) : array
2019-09-03 08:01:40 +02:00
{
2019-09-04 01:16:23 +02:00
/* Removes any invalid columns the user has entered. */
2019-09-04 07:10:10 +02:00
$columns = array_intersect ( $columns , self :: $master_columns );
2019-09-04 01:16:23 +02:00
2019-12-30 22:59:12 +01:00
return str_replace (
[
'custom_invoice_label1' ,
'custom_invoice_label2' ,
'custom_invoice_label3' ,
'custom_invoice_label4' ,
'tax_name1' ,
2020-02-19 21:44:12 +01:00
'tax_name2' ,
'tax_name3'
2019-12-30 22:59:12 +01:00
],
[
2019-09-04 00:16:53 +02:00
'custom_invoice_value1' ,
'custom_invoice_value2' ,
'custom_invoice_value3' ,
'custom_invoice_value4' ,
'tax_rate1' ,
2020-02-19 21:44:12 +01:00
'tax_rate2' ,
'tax_rate3'
2019-12-30 22:59:12 +01:00
],
$columns
);
2019-09-03 08:01:40 +02:00
}
/**
* Formats the line items for display
* @ param array $items The array of invoice items
* @ return array The formatted array of invoice items
*/
2020-03-16 11:12:10 +01:00
private function transformLineItems ( $items , $table_type = '$product' ) : array
2019-09-03 08:01:40 +02:00
{
2020-03-16 11:12:10 +01:00
$data = [];
2020-02-17 10:37:44 +01:00
if ( ! is_array ( $items ))
2020-03-16 11:12:10 +01:00
$data ;
2020-02-17 10:37:44 +01:00
2020-03-16 11:12:10 +01:00
foreach ( $items as $key => $item ) {
if ( $table_type == '$product' && $item -> type_id != 1 )
continue ;
if ( $table_type == '$task' && $item -> type_id != 2 )
continue ;
$data [ $key ][ $table_type . '.product_key' ] = $item -> product_key ;
$data [ $key ][ $table_type . '.notes' ] = $item -> notes ;
$data [ $key ][ $table_type . '.custom_value1' ] = $item -> custom_value1 ;
$data [ $key ][ $table_type . '.custom_value2' ] = $item -> custom_value2 ;
$data [ $key ][ $table_type . '.custom_value3' ] = $item -> custom_value3 ;
$data [ $key ][ $table_type . '.custom_value4' ] = $item -> custom_value4 ;
$data [ $key ][ $table_type . '.quantity' ] = $item -> quantity ;
$data [ $key ][ $table_type . '.cost' ] = Number :: formatMoney ( $item -> cost , $this -> client );
$data [ $key ][ $table_type . '.line_total' ] = Number :: formatMoney ( $item -> line_total , $this -> client );
2019-09-04 00:16:53 +02:00
2019-12-30 22:59:12 +01:00
if ( isset ( $item -> discount ) && $item -> discount > 0 ) {
if ( $item -> is_amount_discount ) {
2020-03-16 11:12:10 +01:00
$data [ $key ][ $table_type . '.discount' ] = Number :: formatMoney ( $item -> discount , $this -> client );
2019-12-30 22:59:12 +01:00
} else {
2020-03-16 11:12:10 +01:00
$data [ $key ][ $table_type . '.discount' ] = $item -> discount . '%' ;
2019-12-30 22:59:12 +01:00
}
2019-09-04 00:16:53 +02:00
}
2020-02-10 10:53:02 +01:00
else
2020-03-16 11:12:10 +01:00
$data [ $key ][ $table_type . '.discount' ] = '' ;
2020-02-10 10:53:02 +01:00
2020-03-16 11:12:10 +01:00
if ( isset ( $item -> tax_rate1 ) && $item -> tax_rate1 > 0 ){
$data [ $key ][ $table_type . '.tax_rate1' ] = round ( $item -> tax_rate1 , 2 ) . " % " ;
$data [ $key ][ $table_type . '.tax1' ] = & $data [ $key ][ $table_type . '.tax_rate1' ];
}
2020-02-10 10:53:02 +01:00
2020-03-16 11:12:10 +01:00
if ( isset ( $item -> tax_rate2 ) && $item -> tax_rate2 > 0 ){
$data [ $key ][ $table_type . '.tax_rate2' ] = round ( $item -> tax_rate2 , 2 ) . " % " ;
$data [ $key ][ $table_type . '.tax2' ] = & $data [ $key ][ $table_type . '.tax_rate2' ];
}
2020-02-10 10:53:02 +01:00
2020-03-16 11:12:10 +01:00
if ( isset ( $item -> tax_rate3 ) && $item -> tax_rate3 > 0 ){
$data [ $key ][ $table_type . '.tax_rate3' ] = round ( $item -> tax_rate3 , 2 ) . " % " ;
$data [ $key ][ $table_type . '.tax3' ] = & $data [ $key ][ $table_type . '.tax_rate3' ];
}
2020-02-10 10:53:02 +01:00
2020-03-16 11:12:10 +01:00
if ( isset ( $item -> tax_rate1 ) && $item -> tax_rate1 == 0 ){
$data [ $key ][ $table_type . '.tax_rate1' ] = '' ;
$data [ $key ][ $table_type . '.tax1' ] = & $data [ $key ][ $table_type . '.tax_rate1' ];
}
2020-02-10 10:53:02 +01:00
2020-03-16 11:12:10 +01:00
if ( isset ( $item -> tax_rate2 ) && $item -> tax_rate2 == 0 ){
$data [ $key ][ $table_type . '.tax_rate2' ] = '' ;
$data [ $key ][ $table_type . '.tax2' ] = & $data [ $key ][ $table_type . '.tax_rate2' ];
}
2020-02-10 10:53:02 +01:00
2020-03-16 11:12:10 +01:00
if ( isset ( $item -> tax_rate3 ) && $item -> tax_rate3 == 0 ){
$data [ $key ][ $table_type . '.tax_rate3' ] = '' ;
$data [ $key ][ $table_type . '.tax3' ] = & $data [ $key ][ $table_type . '.tax_rate3' ];
}
2019-09-04 00:16:53 +02:00
}
2020-03-16 11:12:10 +01:00
return $data ;
2019-09-03 08:01:40 +02:00
}
2019-09-04 14:01:19 +02:00
/**
2019-12-30 22:59:12 +01:00
* Due to the way we are compiling the blade template we
2019-09-04 14:01:19 +02:00
* have no ability to iterate , so in the case
2019-12-30 22:59:12 +01:00
* of line taxes where there are multiple rows ,
2019-09-04 14:01:19 +02:00
* we use this function to format a section of rows
2019-12-30 22:59:12 +01:00
*
* @ return string a collection of < tr > rows with line item
2019-09-04 14:01:19 +02:00
* aggregate data
*/
private function makeLineTaxes () : string
{
$tax_map = $this -> calc () -> getTaxMap ();
$data = '' ;
2019-12-30 22:59:12 +01:00
foreach ( $tax_map as $tax ) {
2019-09-04 14:01:19 +02:00
$data .= '<tr class="line_taxes">' ;
$data .= '<td>' . $tax [ 'name' ] . '</td>' ;
2019-09-11 05:46:23 +02:00
$data .= '<td>' . Number :: formatMoney ( $tax [ 'total' ], $this -> client ) . '</td></tr>' ;
2019-09-04 14:01:19 +02:00
}
return $data ;
}
2019-10-13 12:59:55 +02:00
/**
2019-12-30 22:59:12 +01:00
* @ return string a collectino of < tr > with
2019-10-13 12:59:55 +02:00
* itemised total tax data
*/
private function makeTotalTaxes () : string
{
$data = '' ;
2019-12-30 22:59:12 +01:00
if ( ! $this -> calc () -> getTotalTaxMap ()) {
2019-10-16 11:28:52 +02:00
return $data ;
2019-12-30 22:59:12 +01:00
}
2019-10-16 11:28:52 +02:00
2019-12-30 22:59:12 +01:00
foreach ( $this -> calc () -> getTotalTaxMap () as $tax ) {
2019-10-13 12:59:55 +02:00
$data .= '<tr class="total_taxes">' ;
$data .= '<td>' . $tax [ 'name' ] . '</td>' ;
$data .= '<td>' . Number :: formatMoney ( $tax [ 'total' ], $this -> client ) . '</td></tr>' ;
}
return $data ;
}
2020-02-06 10:35:51 +01:00
private function totalTaxLabels () : string
{
$data = '' ;
if ( ! $this -> calc () -> getTotalTaxMap ()) {
return $data ;
}
foreach ( $this -> calc () -> getTotalTaxMap () as $tax ) {
$data .= '<span>' . $tax [ 'name' ] . '</span>' ;
}
return $data ;
}
private function totalTaxValues () : string
{
$data = '' ;
if ( ! $this -> calc () -> getTotalTaxMap ()) {
return $data ;
}
foreach ( $this -> calc () -> getTotalTaxMap () as $tax ) {
$data .= '<span>' . Number :: formatMoney ( $tax [ 'total' ], $this -> client ) . '</span>' ;
}
return $data ;
}
private function lineTaxLabels () : string
{
$tax_map = $this -> calc () -> getTaxMap ();
$data = '' ;
foreach ( $tax_map as $tax )
$data .= '<span>' . $tax [ 'name' ] . '</span>' ;
return $data ;
}
private function lineTaxValues () : string
{
$tax_map = $this -> calc () -> getTaxMap ();
$data = '' ;
foreach ( $tax_map as $tax )
$data .= '<span>' . Number :: formatMoney ( $tax [ 'total' ], $this -> client ) . '</span>' ;
return $data ;
}
2020-03-16 11:12:10 +01:00
/*
| Ensures the URL doesn ' t have duplicated trailing slash
*/
public function generateAppUrl ()
{
return rtrim ( config ( 'ninja.app_url' ), " / " );
}
2019-12-30 22:59:12 +01:00
}
