Filters::addInvoiceFilterByAmountRange() - Code Metrics - Inspection of "Refactor invoices search by adding custom filters." - srmklive/laravel-paypal - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — v3.0 ( 8df734...660784 )

by Raza

created 2021-11-03 13:21 UTC

Filters::addInvoiceFilterByAmountRange() A

↳ Parent: Filters

Complexity

Conditions	4
Paths	4

Size

Total Lines	25
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	4
eloc	15
c	1
b	0
f	0
nc	4
nop	3
dl	0
loc	25
rs	9.7666

<?php

namespace Srmklive\PayPal\Traits\PayPalAPI\InvoiceSearch;

use Carbon\Carbon;

trait Filters
{
    /**
     * @var array
     */
    protected $invoice_search_filters = [];

    /**
     * @var array
     */
    protected $invoices_date_types = ['invoice_date', 'due_date', 'payment_date', 'creation_date'];

    /**
     * @param string $email
     *
     * @return \Srmklive\PayPal\Services\PayPal
     */
    public function addInvoiceFilterByRecipientEmail(string $email)
    {
        $this->invoice_search_filters['recipient_email'] = $email;

        return $this;
    }

    /**
     * @param string $name
     *
     * @return \Srmklive\PayPal\Services\PayPal
     */
    public function addInvoiceFilterByRecipientFirstName(string $name)
    {
        $this->invoice_search_filters['recipient_first_name'] = $name;

        return $this;
    }

    /**
     * @param string $name
     *
     * @return \Srmklive\PayPal\Services\PayPal
     */
    public function addInvoiceFilterByRecipientLastName(string $name)
    {
        $this->invoice_search_filters['recipient_last_name'] = $name;

        return $this;
    }

    /**
     * @param string $name
     *
     * @return \Srmklive\PayPal\Services\PayPal
     */
    public function addInvoiceFilterByRecipientBusinessName(string $name)
    {
        $this->invoice_search_filters['recipient_business_name'] = $name;

        return $this;
    }

    /**
     * @param string $invoice_number
     *
     * @return \Srmklive\PayPal\Services\PayPal
     */
    public function addInvoiceFilterByInvoiceNumber(string $invoice_number)
    {
        $this->invoice_search_filters['invoice_number'] = $invoice_number;

        return $this;
    }

    /**
     * @param array $status
     *
     * @return \Srmklive\PayPal\Services\PayPal
     *
     * @see https://developer.paypal.com/docs/api/invoicing/v2/#definition-invoice_status
     */
    public function addInvoiceFilterByInvoiceStatus(array $status)
    {
        $this->invoice_search_filters['status'] = $status;

        return $this;
    }

    /**
     * @param string $reference
     * @param bool   $memo
     *
     * @return \Srmklive\PayPal\Services\PayPal
     */
    public function addInvoiceFilterByReferenceorMemo(string $reference, bool $memo = false)
    {
        $field = ($memo === false) ? 'reference' : 'memo';

        $this->invoice_search_filters[$field] = $reference;

        return $this;
    }

    /**
     * @param string $currency
     *
     * @return \Srmklive\PayPal\Services\PayPal
     */
    public function addInvoiceFilterByCurrencyCode(string $currency = '')
    {
        if (!isset($currency)) {
            $currency = $this->getCurrency();
            $currency = $this->getCurrency();
        }

        $this->invoice_search_filters['currency_code'] = $currency;

        return $this;
    }

    /**
     * @param float  $start_amount
     * @param float  $end_amount
     * @param string $amount_currency
     *
     * @return \Srmklive\PayPal\Services\PayPal
     *
     * @throws \Exception
     */
    public function addInvoiceFilterByAmountRange(float $start_amount, float $end_amount, string $amount_currency = '')
    {
        if ($start_amount > $end_amount) {
            throw new \Exception("Starting amount should always be less than end amount!");
        }

        $currency = $this->getCurrency();
        if (!isset($amount_currency)) {
            $currency = $amount_currency;
        } elseif (!empty($this->invoice_search_filters['currency_code'])) {
            $currency = $this->invoice_search_filters['currency_code'];
        }
        
        $this->invoice_search_filters['total_amount_range'] = [
            'lower_amount' => [
                'currency_code' => $currency,
                'value'         => $start_amount,
            ],
            'upper_amount' => [
                'currency_code' => $currency,
                'value'         => $end_amount,
            ],            
        ];

        return $this;
    }

    /**
     * @param string $start_date
     * @param string $end_date
     * @param string $date_type
     *
     * @return \Srmklive\PayPal\Services\PayPal
     *
     * @throws \Exception
     */
    public function addInvoiceFilterByDateRange(string $start_date, string $end_date, string $date_type)
    {
        $start_date_obj = Carbon::parse($start_date);
        $end_date_obj = Carbon::parse($end_date);

        if ($start_date_obj->gt($end_date_obj)) {
            throw new \Exception("Starting date should always be less than the end date!");
        }

        if (!in_array($date_type, $this->invoices_date_types)) {
            throw new \Exception("date type should be always one of these: " . implode(',', $this->invoices_date_types));
        }

        $this->invoice_search_filters["{$date_type}_range"] = [
            'start' => $start_date,
            'end'   => $end_date,
        ];

        return $this;
    }

    /**
     * @param bool $archived
     *
     * @return \Srmklive\PayPal\Services\PayPal
     */
    public function addInvoiceFilterByArchivedStatus(bool $archived=null)
    {
        $this->invoice_search_filters['archived'] = $archived;

        return $this;
    }
}


srmklive / laravel-paypal

Push — v3.0 ( 8df734...660784 )

Filters::addInvoiceFilterByAmountRange() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like