invoiceninja/app/Utils/Traits/GeneratesCounter.php

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

namespace App\Utils\Traits;

use App\Models\Client;
use App\Models\Credit;
use App\Models\Invoice;
use App\Models\Quote;
use App\Models\RecurringInvoice;
use Illuminate\Support\Carbon;
use Illuminate\Support\Facades\Log;

/**
 * Class GeneratesCounter
 * @package App\Utils\Traits
 */
trait GeneratesNumberCounter
{

	public function getNextInvoiceNumber(Client $client)
	{
		//Reset counters if enabled
		$this->resetCounters($client);

		$counter = $this->getNextInvoiceCounter($client);
		$counter = $this->checkEntityNumber($client, $counter, $client->company->settings->counter_padding, $client->company->settings->invoice_number_prefix);

		$client_counter = $this->getNextInvoiceClientCounter($client);
		$client_counter = $this->checkEntityNumber($client, $client_counter, $client->company->settings->counter_padding, $client->company->settings->invoice_number_prefix);

		//build number pattern
		$invoice_number = $this->applyNumberPattern($client, $counter, $client_counter, $client->company->settings->invoice_number_pattern);
		
	}

	public function getNextCreditNumber()
	{

	}

	public function getNextQuoteNumber()
	{

	}

	public function getNextRecurringInvoiceNumber()
	{

	}

	public function getNextClientInvoiceNumber()
	{

	}

	public function getNextClientNumber()
	{

	}


	/**
	 * Checks that the number has not already been used
	 *
	 * @param      Collection  $entity   The entity ie App\Models\Client, Invoice, Quote etc
	 * @param      integer  $counter  The counter
	 * @param      integer   $padding  The padding
	 * @param      string  $prefix   The prefix
	 *
	 * @return     <type>   ( description_of_the_return_value )
	 */
	private function checkEntityNumber($entity, $counter, $padding, $prefix)
	{
		$check = false;

		do {

			$number = $this->padCounter($counter, $padding);
			$number = $this->prefixCounter($number, $prefix);

			$check = $entity::company($entity->company_id)->whereIdNumber($number)->withTrashed()->first();

			$counter++;

		} while ($check);

		$this->incrementCounter($client, 'invoice_number_counter');
		
        return $number;
	}


	/**
	 * Saves counters at both the company and client level
	 *
	 * @param      \App\Models\Client                 $client        The client
	 * @param      \App\Models\Client|integer|string  $counter_name  The counter name
	 */
	private function incrementCounter(Client $client, string $counter_name) :void 
	{
		$company_settings = $client->company->settings;
		$company_settings->$counter_name = $company_settings->$counter_name + 1;
		$client->company->settings = $company_settings;
		$client->company->save();

		$client_settings = $client->settings;
		$client_settings->$counter_name = $client_settings->$counter_name + 1;
		$client->settings = $client_settings;
		$client->save();
	}

	private function prefixCounter($counter, $prefix) : string
	{
		if(strlen($prefix) == 0)
			return $counter;

		return  $prefix . $counter;

	}

	/**
	 * Pads a number with leading 000000's
	 *
	 * @param      int  $counter  The counter
	 * @param      int  $padding  The padding
	 *
	 * @return     int  the padded counter
	 */
	private function padCounter($counter, $padding)
	{

		return str_pad($counter, $padding, '0', STR_PAD_LEFT);

	}

	/**
	 * Gets the next invoice counter.
	 *
	 * Determine whether we need to harvest the
	 * Client specific invoice increment OR 
	 * the Company wide invoice increment
	 *
	 * @param      string              $number_pattern  The number pattern
	 * @param      \App\Models\Client  $client          The client
	 *
	 * @return     string              The next invoice counter.
	 */
	private function getNextInvoiceCounter(Client $client) : string
	{

		return $client->company->settings->invoice_number_counter;

	}

	private function getNextInvoiceClientCounter(Client $client) : string
	{

		return $client->settings->invoice_number_counter;

	}

	/**
	 * If we are using counter reset, 
	 * check if we need to reset here
	 * 
	 * @param  Client $client client entity
	 * @return void
	 */
	private function resetCounters(Client $client)
    {

        $timezone = $client->company->timezone()->name;

        $reset_date = Carbon::parse($client->company->settings->reset_counter_date, $timezone);

        if (! $reset_date->isToday()) 
            return false;

        switch ($client->company->reset_counter_frequency_id) {
            case RecurringInvoice::FREQUENCY_WEEKLY:
                $reset_date->addWeek();
                break;
            case RecurringInvoice::FREQUENCY_TWO_WEEKS:
                $reset_date->addWeeks(2);
                break;
            case RecurringInvoice::FREQUENCY_FOUR_WEEKS:
                $reset_date->addWeeks(4);
                break;
            case RecurringInvoice::FREQUENCY_MONTHLY:
                $reset_date->addMonth();
                break;
            case RecurringInvoice::FREQUENCY_TWO_MONTHS:
                $reset_date->addMonths(2);
                break;
            case RecurringInvoice::FREQUENCY_THREE_MONTHS:
                $reset_date->addMonths(3);
                break;
            case RecurringInvoice::FREQUENCY_FOUR_MONTHS:
                $reset_date->addMonths(4);
                break;
            case RecurringInvoice::FREQUENCY_SIX_MONTHS:
                $reset_date->addMonths(6);
                break;
            case RecurringInvoice::FREQUENCY_ANNUALLY:
                $reset_date->addYear();
                break;
            case RecurringInvoice::FREQUENCY_TWO_YEARS:
                $reset_date->addYears(2);
                break;
        }

        $settings = $client->company->settings;
        $settings->reset_counter_date = $reset_date->format('Y-m-d');
        $settings->invoice_number_counter = 1;
        $settings->quote_number_counter = 1;
        $settings->credit_number_counter = 1;

        $client->company->settings = $settings;
        $client->company->save();
    }

    private function applyNumberPattern($client, $counter, $client_counter, $pattern)
    {
    	if(!$pattern)
    		return $counter;

        $search = ['{$year}'];
        $replace = [date('Y')];

        $search[] = '{$counter}';
        $replace[] = [$counter];

        $search[] = '{$client_counter';
        $replace[] = [$client_counter];

        if (strstr($pattern, '{$user_id}')) {
            $user_id = auth()->check() ? auth()->user()->id : 0;
            $search[] = '{$user_id}';
            $replace[] = str_pad(($user_id), 2, '0', STR_PAD_LEFT);
        }

        $matches = false;
        preg_match('/{\$date:(.*?)}/', $pattern, $matches);
        if (count($matches) > 1) {
            $format = $matches[1];
            $search[] = $matches[0];

            /* The following adjusts for the company timezone - may bork tests depending on the time of day the tests are run!!!!!!*/
            $date = Carbon::now($client->company->timezone()->name)->format($format);
            $replace[] = str_replace($format, $date, $matches[1]);
        }

        $search[] = '{$custom1}';
        $replace[] = [$client->custom_value1];

        $search[] = '{$custom2}';
        $replace[] = [$client->custom_value1];

        $search[] = '{$custom3}';
        $replace[] = [$client->custom_value1];

        $search[] = '{$custom4}';
        $replace[] = [$client->custom_value1];

        $search[] = '{$id_number}';
        $replace[] = [$client->id_number];

        return str_replace($search, $replace, $pattern);

    }

}