mirror of
				https://github.com/invoiceninja/invoiceninja.git
				synced 2025-11-04 02:57:33 -05:00 
			
		
		
		
	
		
			
				
	
	
		
			283 lines
		
	
	
		
			9.3 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
			
		
		
	
	
			283 lines
		
	
	
		
			9.3 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
<?php
 | 
						|
 | 
						|
/**
 | 
						|
 * Invoice Ninja (https://invoiceninja.com).
 | 
						|
 *
 | 
						|
 * @link https://github.com/invoiceninja/invoiceninja source repository
 | 
						|
 *
 | 
						|
 * @copyright Copyright (c) 2021. Invoice Ninja LLC (https://invoiceninja.com)
 | 
						|
 *
 | 
						|
 * @license https://www.elastic.co/licensing/elastic-license
 | 
						|
 */
 | 
						|
 | 
						|
namespace App\Utils;
 | 
						|
 | 
						|
use App\Models\Client;
 | 
						|
use App\Utils\Traits\MakesDates;
 | 
						|
use Carbon\Carbon;
 | 
						|
use Illuminate\Support\Str;
 | 
						|
use stdClass;
 | 
						|
 | 
						|
class Helpers
 | 
						|
{
 | 
						|
    use MakesDates;
 | 
						|
 | 
						|
    public static function sharedEmailVariables(?Client $client, array $settings = null): array
 | 
						|
    {
 | 
						|
        if (!$client) {
 | 
						|
            $elements['signature'] = '';
 | 
						|
            $elements['settings'] = new stdClass;
 | 
						|
            $elements['whitelabel'] = true;
 | 
						|
            $elements['company'] = '';
 | 
						|
            return $elements;
 | 
						|
        }
 | 
						|
 | 
						|
        $_settings = is_null($settings) ? $client->getMergedSettings() : $settings;
 | 
						|
 | 
						|
        $elements['signature'] = $_settings->email_signature;
 | 
						|
        $elements['settings'] = $_settings;
 | 
						|
        $elements['whitelabel'] = $client->company->account->isPaid() ? true : false;
 | 
						|
        $elements['company'] = $client->company;
 | 
						|
        
 | 
						|
        return $elements;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * A centralised method to format the custom fields content.
 | 
						|
     *
 | 
						|
     * @param mixed|null $custom_fields
 | 
						|
     * @param mixed $field
 | 
						|
     * @param mixed $value
 | 
						|
     * @param \App\Models\Client|null $client
 | 
						|
     *
 | 
						|
     * @return null|string
 | 
						|
     */
 | 
						|
    public function formatCustomFieldValue($custom_fields, $field, $value, Client $client = null): ?string
 | 
						|
    {
 | 
						|
        $custom_field = '';
 | 
						|
 | 
						|
        if ($custom_fields && property_exists($custom_fields, $field)) {
 | 
						|
            $custom_field = $custom_fields->{$field};
 | 
						|
            $custom_field_parts = explode('|', $custom_field);
 | 
						|
 | 
						|
            if (count($custom_field_parts) >= 2) {
 | 
						|
                $custom_field = $custom_field_parts[1];
 | 
						|
            }
 | 
						|
        }
 | 
						|
 | 
						|
        switch ($custom_field) {
 | 
						|
            case 'date':
 | 
						|
                return is_null($client) ? $value : $this->translateDate($value, $client->date_format(), $client->locale());
 | 
						|
                break;
 | 
						|
 | 
						|
            case 'switch':
 | 
						|
                return trim($value) == 'yes' ? ctrans('texts.yes') : ctrans('texts.no');
 | 
						|
                break;
 | 
						|
 | 
						|
            default:
 | 
						|
                return is_null($value) ? '' : $value;
 | 
						|
                break;
 | 
						|
        }
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * A centralised method to make custom field.
 | 
						|
     * @param mixed|null $custom_fields
 | 
						|
     * @param mixed $field
 | 
						|
     *
 | 
						|
     * @return string
 | 
						|
     */
 | 
						|
    public function makeCustomField($custom_fields, $field): string
 | 
						|
    {
 | 
						|
        if ($custom_fields && property_exists($custom_fields, $field)) {
 | 
						|
            $custom_field = $custom_fields->{$field};
 | 
						|
 | 
						|
            $custom_field_parts = explode('|', $custom_field);
 | 
						|
 | 
						|
            return $custom_field_parts[0];
 | 
						|
        }
 | 
						|
 | 
						|
        return '';
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Process reserved keywords on PDF.
 | 
						|
     *  
 | 
						|
     * @param string $value 
 | 
						|
     * @param Client $client 
 | 
						|
     * @return null|string 
 | 
						|
     */
 | 
						|
    public static function processReservedKeywords(?string $value, Client $client): ?string
 | 
						|
    {
 | 
						|
        if(!$value)
 | 
						|
            return '';
 | 
						|
        
 | 
						|
        Carbon::setLocale($client->locale());
 | 
						|
 | 
						|
        $replacements = [
 | 
						|
            'literal' => [
 | 
						|
                ':MONTH' => Carbon::createFromDate(now()->year, now()->month)->translatedFormat('F'),
 | 
						|
                ':YEAR' => now()->year,
 | 
						|
                ':QUARTER' => 'Q' . now()->quarter,
 | 
						|
                ':WEEK_BEFORE' => \sprintf(
 | 
						|
                    '%s %s %s',
 | 
						|
                    Carbon::now()->subDays(7)->translatedFormat($client->date_format()),
 | 
						|
                    ctrans('texts.to'),
 | 
						|
                    Carbon::now()->translatedFormat($client->date_format())
 | 
						|
                ),
 | 
						|
                ':WEEK_AHEAD' => \sprintf(
 | 
						|
                    '%s %s %s',
 | 
						|
                    Carbon::now()->addDays(7)->translatedFormat($client->date_format()),
 | 
						|
                    ctrans('texts.to'),
 | 
						|
                    Carbon::now()->addDays(14)->translatedFormat($client->date_format())
 | 
						|
                ),
 | 
						|
                ':WEEK' => \sprintf(
 | 
						|
                    '%s %s %s', 
 | 
						|
                    Carbon::now()->translatedFormat($client->date_format()), 
 | 
						|
                    ctrans('texts.to'), 
 | 
						|
                    Carbon::now()->addDays(7)->translatedFormat($client->date_format())
 | 
						|
                ),
 | 
						|
            ],
 | 
						|
            'raw' => [
 | 
						|
                ':MONTH' => now()->month,
 | 
						|
                ':YEAR' => now()->year,
 | 
						|
                ':QUARTER' => now()->quarter,
 | 
						|
            ],
 | 
						|
            'ranges' => [
 | 
						|
              'MONTHYEAR' => Carbon::createFromDate(now()->year, now()->month),
 | 
						|
            ],
 | 
						|
            'ranges_raw' => [
 | 
						|
                'MONTH' => now()->month,
 | 
						|
                'YEAR' => now()->year,
 | 
						|
            ],
 | 
						|
        ];
 | 
						|
 | 
						|
        // First case, with ranges.
 | 
						|
        preg_match_all('/\[(.*?)]/', $value, $ranges);
 | 
						|
 | 
						|
        $matches = array_shift($ranges);
 | 
						|
 | 
						|
        foreach ($matches as $match) {
 | 
						|
            if (!Str::contains($match, '|')) {
 | 
						|
                continue;
 | 
						|
            }
 | 
						|
 | 
						|
            if (Str::contains($match, '|')) {
 | 
						|
                $parts = explode('|', $match); // [ '[MONTH', 'MONTH+2]' ]
 | 
						|
 | 
						|
                $left = substr($parts[0], 1); // 'MONTH'
 | 
						|
                $right = substr($parts[1], 0, -1); // MONTH+2
 | 
						|
 | 
						|
                // If left side is not part of replacements, skip.
 | 
						|
                if (!array_key_exists($left, $replacements['ranges'])) {
 | 
						|
                    continue;
 | 
						|
                }
 | 
						|
 | 
						|
                $_left = Carbon::createFromDate(now()->year, now()->month)->translatedFormat('F Y');
 | 
						|
                $_right = '';
 | 
						|
 | 
						|
                // If right side doesn't have any calculations, replace with raw ranges keyword.
 | 
						|
                if (!Str::contains($right, ['-', '+', '/', '*'])) {
 | 
						|
                    $_right = Carbon::createFromDate(now()->year, now()->month)->translatedFormat('F Y');
 | 
						|
                }
 | 
						|
 | 
						|
                // If right side contains one of math operations, calculate.
 | 
						|
                if (Str::contains($right, ['+'])) {
 | 
						|
                    $operation = preg_match_all('/(?!^-)[+*\/-](\s?-)?/', $right, $_matches);
 | 
						|
 | 
						|
                    $_operation = array_shift($_matches)[0]; // + -
 | 
						|
 | 
						|
                    $_value = explode($_operation, $right); // [MONTHYEAR, 4]
 | 
						|
 | 
						|
                    $_right = Carbon::createFromDate(now()->year, now()->month)->addMonths($_value[1])->translatedFormat('F Y');
 | 
						|
                }
 | 
						|
 | 
						|
                $replacement = sprintf('%s to %s', $_left, $_right);
 | 
						|
 | 
						|
                $value = preg_replace(
 | 
						|
                    sprintf('/%s/', preg_quote($match)), $replacement, $value, 1
 | 
						|
                );
 | 
						|
            }
 | 
						|
        }
 | 
						|
 | 
						|
 | 
						|
        // Second case with more common calculations.
 | 
						|
        preg_match_all('/:([^:\s]+)/', $value, $common);
 | 
						|
 | 
						|
        $matches = array_shift($common);
 | 
						|
 | 
						|
        foreach ($matches as $match) {
 | 
						|
            $matches = collect($replacements['literal'])->filter(function ($value, $key) use ($match) {
 | 
						|
                return Str::startsWith($match, $key);
 | 
						|
            });
 | 
						|
 | 
						|
            if ($matches->count() === 0) {
 | 
						|
                continue;
 | 
						|
            }
 | 
						|
 | 
						|
            if (!Str::contains($match, ['-', '+', '/', '*'])) {
 | 
						|
                $value = preg_replace(
 | 
						|
                    sprintf('/%s/', $matches->keys()->first()), $replacements['literal'][$matches->keys()->first()], $value, 1
 | 
						|
                );
 | 
						|
            }
 | 
						|
 | 
						|
            if (Str::contains($match, ['-', '+', '/', '*'])) {
 | 
						|
                $operation = preg_match_all('/(?!^-)[+*\/-](\s?-)?/', $match, $_matches);
 | 
						|
 | 
						|
                $_operation = array_shift($_matches)[0];
 | 
						|
 | 
						|
                $_value = explode($_operation, $match); // [:MONTH, 4]
 | 
						|
 | 
						|
                $raw = strtr($matches->keys()->first(), $replacements['raw']); // :MONTH => 1
 | 
						|
 | 
						|
                $number = $res = preg_replace("/[^0-9]/", '', $_value[1]); // :MONTH+1. || :MONTH+2! => 1 || 2
 | 
						|
 | 
						|
                $target = "/{$matches->keys()->first()}\\{$_operation}{$number}/"; // /:$KEYWORD\\$OPERATION$VALUE => /:MONTH\\+1
 | 
						|
 | 
						|
                $output = (int) $raw + (int)$_value[1];
 | 
						|
 | 
						|
                if ($operation == '+') {
 | 
						|
                    $output = (int) $raw + (int)$_value[1]; // 1 (:MONTH) + 4
 | 
						|
                }
 | 
						|
 | 
						|
                if ($_operation == '-') {
 | 
						|
                    $output = (int)$raw - (int)$_value[1]; // 1 (:MONTH) - 4
 | 
						|
                }
 | 
						|
 | 
						|
                if ($_operation == '/' && (int)$_value[1] != 0) {
 | 
						|
                    $output = (int)$raw / (int)$_value[1]; // 1 (:MONTH) / 4
 | 
						|
                }
 | 
						|
 | 
						|
                if ($_operation == '*') {
 | 
						|
                    $output = (int)$raw * (int)$_value[1]; // 1 (:MONTH) * 4
 | 
						|
                }
 | 
						|
 | 
						|
                if ($matches->keys()->first() == ':MONTH') {
 | 
						|
                    $output = \Carbon\Carbon::create()->month($output)->translatedFormat('F');
 | 
						|
                }
 | 
						|
 | 
						|
                $value = preg_replace(
 | 
						|
                    $target, $output, $value, 1
 | 
						|
                );
 | 
						|
            }
 | 
						|
        }
 | 
						|
 | 
						|
        return $value;
 | 
						|
        // $x = str_replace(["\n", "<br>"], ["\r", "<br>"], $value);
 | 
						|
        // return $x;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Resolve the font from the supported fonts array.
 | 
						|
     * 
 | 
						|
     * @param string $font 
 | 
						|
     * @return array 
 | 
						|
     */
 | 
						|
    public static function resolveFont(string $font = 'Arial'): array
 | 
						|
    {
 | 
						|
        return $font
 | 
						|
            ? ['name' => str_replace('_', ' ', $font), 'url' => sprintf('https://fonts.googleapis.com/css2?family=%s&display=swap', str_replace('_', '+', $font))]
 | 
						|
            : ['name' => 'Arial', 'url' => ''];
 | 
						|
    }
 | 
						|
}
 |