invoiceninja/app/Designs/Designer.php

<?php
/**
 * Invoice Ninja (https://invoiceninja.com)
 *
 * @link https://github.com/invoiceninja/invoiceninja source repository
 *
 * @copyright Copyright (c) 2020. Invoice Ninja LLC (https://invoiceninja.com)
 *
 * @license https://opensource.org/licenses/AAL
 */

namespace App\Designs;

use App\Models\Company;
use App\Models\Invoice;

class Designer {

	public $design;

	protected $input_variables;

	protected $exported_variables;

	protected $html;

	protected $entity_string;

	protected $entity;

	private static $custom_fields = [
		'invoice1',
		'invoice2',
		'invoice3',
		'invoice4',
		'surcharge1',
		'surcharge2',
		'surcharge3',
		'surcharge4',
		'client1',
		'client2',
		'client3',
		'client4',
		'contact1',
		'contact2',
		'contact3',
		'contact4',
		'company1',
		'company2',
		'company3',
		'company4',
	];

	public function __construct($entity, $design, $input_variables, $entity_string) 
	{
		$this->entity = $entity;

		$this->design = $design->design;

		$this->input_variables = json_decode(json_encode($input_variables),1);

		$this->entity_string = $entity_string;

	}

	/**
	 * Returns the design
	 * formatted HTML
	 * @return string The HTML design built
	 */
	public function build():Designer 
	{

		$this->setHtml()
			->exportVariables()
			->setDesign($this->getSection('includes'))
		    ->setDesign($this->getSection('header'))
			->setDesign($this->getSection('body'))
			->setDesign($this->getSection('footer'));

		return $this;

	}

	public function init()
	{
		$this->setHtml()
			 ->exportVariables();

		return $this;
	}

	public function getIncludes()
	{
		$this->setDesign($this->getSection('includes'));

		return $this;
	}

	public function getHeader()
	{

		$this->setDesign($this->getSection('header'));

		return $this;
	}

	public function getFooter()
	{

		$this->setDesign($this->getSection('footer'));

		return $this;		
	}

	public function getBody() 
	{

		$this->setDesign($this->getSection('body'));
		
		return $this;
	}

	public function getHtml():string 
	{
		return $this->html;
	}

	public function setHtml()
	{
		$this->html =  '';

		return $this;
	}

	private function setDesign($section) 
	{

		$this->html .= $section;

		return $this;
	}

	/**
	 * Returns the template section on with the
	 * stacked variables replaced with single variables.
	 *
	 * @param  string $section the method name to be executed ie header/body/table/footer
	 * @return string The HTML of the template section
	 */
	public function getSection($section):string 
	{
		return str_replace(array_keys($this->exported_variables), array_values($this->exported_variables), $this->design->{$section});
	}

	private function exportVariables() 
	{

		$company = $this->entity->company;
		
		$this->exported_variables['$app_url']			= $this->entity->generateAppUrl();
		$this->exported_variables['$client_details']  	= $this->processVariables($this->input_variables['client_details'], $this->clientDetails($company));
		$this->exported_variables['$company_details'] 	= $this->processVariables($this->input_variables['company_details'], $this->companyDetails($company));
		$this->exported_variables['$company_address'] 	= $this->processVariables($this->input_variables['company_address'], $this->companyAddress($company));

		if($this->entity_string == 'invoice')
		{
			$this->exported_variables['$entity_labels']  = $this->processLabels($this->input_variables['invoice_details'], $this->invoiceDetails($company));
			$this->exported_variables['$entity_details'] = $this->processVariables($this->input_variables['invoice_details'], $this->invoiceDetails($company));
		}
		elseif($this->entity_string == 'credit')
		{
			$this->exported_variables['$entity_labels']  = $this->processLabels($this->input_variables['credit_details'], $this->creditDetails($company));
			$this->exported_variables['$entity_details'] = $this->processVariables($this->input_variables['credit_details'], $this->creditDetails($company));
		}
		elseif($this->entity_string == 'quote')
		{
			$this->exported_variables['$entity_labels']  = $this->processLabels($this->input_variables['quote_details'], $this->quoteDetails($company));
			$this->exported_variables['$entity_details'] = $this->processVariables($this->input_variables['quote_details'], $this->quoteDetails($company));
		}

        $this->exported_variables['$product_table_header']= $this->entity->buildTableHeader($this->input_variables['product_columns']);
        $this->exported_variables['$product_table_body']  = $this->entity->buildTableBody($this->input_variables['product_columns'], $this->design->product, '$product');
        $this->exported_variables['$task_table_header']   = $this->entity->buildTableHeader($this->input_variables['task_columns']);
        $this->exported_variables['$task_table_body']     = $this->entity->buildTableBody($this->input_variables['task_columns'], $this->design->task, '$task');

        if(strlen($this->exported_variables['$task_table_body']) == 0)
        	$this->exported_variables['$task_table_header'] = '';

		if(strlen($this->exported_variables['$product_table_body']) == 0)
        	$this->exported_variables['$product_table_header'] = '';
        
		return $this;
	}

	private function processVariables($input_variables, $variables):string 
	{
		$output = '';

		foreach (array_keys($input_variables) as $value)
			$output .= $variables[$value];

		return $output;

	}

	private function processLabels($input_variables, $variables):string 
	{

		$output = '';

		foreach (array_keys($input_variables) as $value) {

			$tmp = str_replace("</span>", "_label</span>", $variables[$value]);
			//$output .= $variables[$value];
			$output .= $tmp;
		}

		return $output;
	}

	private function clientDetails(Company $company) 
	{

		$data = [
			'$client.name'              => '<p>$client.name</p>',
			'$client.id_number'         => '<p>$client.id_number</p>',
			'$client.vat_number'        => '<p>$client.vat_number</p>',
			'$client.address1'          => '<p>$client.address1</p>',
			'$client.address2'          => '<p>$client.address2</p>',
			'$client.city_state_postal' => '<p>$client.city_state_postal</p>',
			'$client.postal_city_state' => '<p>$client.postal_city_state</p>',
			'$client.country'           => '<p>$client.country</p>',
			'$client.email'             => '<p>$client.email</p>',
			'$client.client1'           => '<p>$client1</p>',
			'$client.client2'           => '<p>$client2</p>',
			'$client.client3'           => '<p>$client3</p>',
			'$client.client4'           => '<p>$client4</p>',
			'$client.contact1'          => '<p>$contact1</p>',
			'$client.contact2'          => '<p>$contact2</p>',
			'$client.contact3'          => '<p>$contact3</p>',
			'$client.contact4'          => '<p>$contact4</p>',
		];

		return $this->processCustomFields($company, $data);
	}

	private function companyDetails(Company $company) 
	{

		$data = [
			'$company.company_name' => '<span>$company.company_name</span>',
			'$company.id_number'    => '<span>$company.id_number</span>',
			'$company.vat_number'   => '<span>$company.vat_number</span>',
			'$company.website'      => '<span>$company.website</span>',
			'$company.email'        => '<span>$company.email</span>',
			'$company.phone'        => '<span>$company.phone</span>',
			'$company.company1'     => '<span>$company1</span>',
			'$company.company2'     => '<span>$company2</span>',
			'$company.company3'     => '<span>$company3</span>',
			'$company.company4'     => '<span>$company4</span>',
		];

		return $this->processCustomFields($company, $data);

	}

	private function companyAddress(Company $company) 
	{

		$data = [
			'$company.address1'          => '<span>$company.address1</span>',
			'$company.address2'          => '<span>$company.address2</span>',
			'$company.city_state_postal' => '<span>$company.city_state_postal</span>',
			'$company.postal_city_state' => '<span>$company.postal_city_state</span>',
			'$company.country'           => '<span>$company.country</span>',
			'$company.company1'          => '<span>$company1</span>',
			'$company.company2'          => '<span>$company2</span>',
			'$company.company3'          => '<span>$company3</span>',
			'$company.company4'          => '<span>$company4</span>',
		];

		return $this->processCustomFields($company, $data);

	}

	private function invoiceDetails(Company $company) 
	{

		$data = [
			'$invoice.invoice_number' => '<span>$invoice_number_label</span><span>$invoice_number</span>',
			'$invoice.po_number'      => '<span>$po_number_label</span><span>$po_number</span>',
			'$invoice.invoice_date'   => '<span>$invoice_date_label</span><span>$invoice_date</span>',
			'$invoice.due_date'       => '<span>$due_date_label</span><span>$due_date</span>',
			'$invoice.balance_due'    => '<span>$balance_due_label</span><span>$balance_due</span>',
			'$invoice.invoice_total'  => '<span>$invoice_total_label</span><span>$invoice_total</span>',
			'$invoice.partial_due'    => '<span>$partial_due_label</span><span>$partial_due</span>',
			'$invoice.invoice1'       => '<span>$invoice1_label</span><span>$invoice1</span>',
			'$invoice.invoice2'       => '<span>$invoice2_label</span><span>$invoice2</span>',
			'$invoice.invoice3'       => '<span>$invoice3_label</span><span>$invoice3</span>',
			'$invoice.invoice4'       => '<span>$invoice4_label</span><span>$invoice4</span>',
			'$invoice.surcharge1'     => '<span>$surcharge1_label</span><span>$surcharge1</span>',
			'$invoice.surcharge2'     => '<span>$surcharge2_label</span><span>$surcharge2</span>',
			'$invoice.surcharge3'     => '<span>$surcharge3_label</span><span>$surcharge3</span>',
			'$invoice.surcharge4'     => '<span>$surcharge4_label</span><span>$surcharge4</span>',
		];

		return $this->processCustomFields($company, $data);

	}

	private function quoteDetails(Company $company)
	{
		
		$data = [
			'$quote.quote_number' 	=> '<span>$quote_number</span>',
			'$quote.po_number'      => '<span>$po_number</span>',
			'$quote.quote_date'     => '<span>$date</span>',
			'$quote.valid_until'    => '<span>$valid_until</span>',
			'$quote.balance_due'    => '<span>$balance_due</span>',
			'$quote.quote_total'  	=> '<span>$quote_total</span>',
			'$quote.partial_due'    => '<span>$partial_due</span>',
			'$quote.quote1'       	=> '<span>$quote1</span>',
			'$quote.quote2'       	=> '<span>$quote2</span>',
			'$quote.quote3'       	=> '<span>$quote3</span>',
			'$quote.quote4'         => '<span>$quote4</span>',
			'$quote.surcharge1'     => '<span>$surcharge1</span>',
			'$quote.surcharge2'     => '<span>$surcharge2</span>',
			'$quote.surcharge3'     => '<span>$surcharge3</span>',
			'$quote.surcharge4'     => '<span>$surcharge4</span>',
		];

		return $this->processCustomFields($company, $data);

	}

	private function creditDetails(Company $company)
	{

		$data = [
			'$credit.credit_number'  => '<span>$credit_number</span>',
			'$credit.po_number'      => '<span>$po_number</span>',
			'$credit.credit_date'    => '<span>$date</span>',
			'$credit.credit_balance' => '<span>$credit_balance</span>',
			'$credit.credit_amount'  => '<span>$credit_amount</span>',
			'$credit.partial_due'    => '<span>$partial_due</span>',
			'$credit.invoice1'       => '<span>$invoice1</span>',
			'$credit.invoice2'       => '<span>$invoice2</span>',
			'$credit.invoice3'       => '<span>$invoice3</span>',
			'$credit.invoice4'       => '<span>$invoice4</span>',
			'$credit.surcharge1'     => '<span>$surcharge1</span>',
			'$credit.surcharge2'     => '<span>$surcharge2</span>',
			'$credit.surcharge3'     => '<span>$surcharge3</span>',
			'$credit.surcharge4'     => '<span>$surcharge4</span>',
		];

		return $this->processCustomFields($company, $data);

	}

	private function processCustomFields(Company $company, $data) 
	{

		$custom_fields = $company->custom_fields;

		if (!$custom_fields) {
			return $data;
		}

		foreach (self::$custom_fields as $cf) {

			if (!property_exists($custom_fields, $cf) || (strlen($custom_fields->{$cf}) == 0)) {
				unset($data[$cf]);

			}
		}

		return $data;

	}

	// private function processInputVariables($company, $variables) 
	// {
	// 	if(is_object($variables))
	// 		$variables = json_decode(json_encode($variables),true);

	// 	$custom_fields = $company->custom_fields;

	// 	$matches = array_intersect(self::$custom_fields, $variables);

	// 	foreach ($matches as $match) {

	// 		if (!property_exists($custom_fields, $match) || (strlen($custom_fields->{$match}) == 0)) {
	// 			foreach ($variables as $key => $value) {
	// 				if ($value == $match) {
	// 					unset($variables[$key]);
	// 				}
	// 			}
	// 		}

	// 	}

	// 	return $variables;

	// }

}