Gateway::__construct() - Code Metrics - Inspection of "master" - nxmad/Larapay - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( b8b2bd...fcde1f )

by Alex
created 2018-11-18 17:46 UTC
Gateway::__construct() A

↳ Parent: Gateway
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	2
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	4
rs	10
<?php

namespace Nxmad\Larapay\Abstracts;

use RuntimeException;
use Illuminate\Config\Repository;
use Nxmad\Larapay\Models\Transaction;
filter:
    dependency_paths: ["lib/*"]
use Nxmad\Larapay\Contracts\Gateway as GatewayContract;

abstract class Gateway implements GatewayContract
{
    /**
     * The list of aliases for payment gateway.
     *
     * @var array
     */
    protected $aliases = [];

    /**
     * The list of required request attributes.
     *
     * @var array
     */
    protected $required = [];

    /**
     * The general settings for payment processor, like secret key or merchant id.
     *
     * @var Repository
     */
    protected $config;

    /**
     * The temporary settings for payment processor, actual only in for this request, like payment description, etc.
     *
     * @var Repository
     */
    protected $custom;

    /**
     * Payment process method.
     * Possible values are below.
     *
     * @var string
     */
    protected $method = self::LARAPAY_GET_REDIRECT;

    /**
     * Classic redirection with GET parameters.
     */
    const LARAPAY_GET_REDIRECT = 'GET';

    /**
     * Redirect with POST data for old gateways (using hack with form).
     */
    const LARAPAY_POST_REDIRECT = 'POST';

    /**
     * No redirect method (e.g. for card payments)
     */
    const LARAPAY_NO_REDIRECT = '_';

    /**
     * Sign outcome request (insert request signature in request parameters).
     *
     * @param array $data
     *
     * @return string
     */
    abstract public function sign(array $data): string;

    /**
     * Gateway constructor.
     *
     * @param array $config
     */
    public function __construct(array $config = [])
    {
        $this->custom = new Repository;
        $this->config = new Repository($config);
    }

    /**
     * Process payment.
     *
     * @param Transaction $transaction
     *
     * @return mixed
     */
    public function interact(Transaction $transaction)
    {
        $this->prepare($transaction);
        $this->fill([
            'amount'      => $transaction->getAmount(),
            'description' => $transaction->getDescription(),
            'id'          => $transaction->getPrimaryValue(),
        ]);

        $this->signature = $this->sign($this->custom->all());


        foreach ($this->required as $field) {
            if (! $this->custom->has($this->getAlias($field))) {
                throw new RuntimeException("Required field [{$field}] is not presented.");
            }
        }

        if ($this->method == self::LARAPAY_NO_REDIRECT) {
            return $this->customBehavior();
            return $this->/** @scrutinizer ignore-call */ customBehavior();
        }

        if ($this->method == self::LARAPAY_GET_REDIRECT) {
            return redirect()->away($this->getInteractionUrl() . '?' . http_build_query($this->custom->all()));
        }

        return view('larapay::form', [
            'method' => 'POST',
            'data'   => $this->custom->all(),
            'action' => $this->getInteractionUrl(),
        ]);
    }

    /**
     * Custom gateway logic instead redirect.
     * You can override this method in children class.
     *
     * @param Transaction $transaction
     */
    public function customBehavior(Transaction $transaction)
    public function customBehavior(/** @scrutinizer ignore-unused */ Transaction $transaction)
    {
    }

    /**
     * Prepare Transaction.
     * You can override this method in children class.
     *
     * @param Transaction $transaction
     */
    public function prepare(Transaction $transaction)
    public function prepare(/** @scrutinizer ignore-unused */ Transaction $transaction)
    {
    }

    /**
     * Determine if this gateway needs redirect.
     *
     * @return bool
     */
    public function needRedirect()
    {
        return $this->method != self::LARAPAY_NO_REDIRECT;
    }

    /**
     * Fill custom parameters.
     *
     * @param array $parameters
     *
     * @return Gateway
     */
    public function fill(array $parameters): self
    {
        foreach ($parameters as $key => $value) {
            $this->set($key, $value);
        }

        return $this;
    }

    /**
     * Set custom field value respecting aliases.
     *
     * @param $field
     * @param $value
     *
     * @return self
     */
    public function set($field, $value = null): self
    {
        if (is_array($field)) {
            return $this->fill($field);
        }

        $this->custom->set($this->getAlias($field), $value);

        return $this;
    }

    /**
     * Magic set method.
     *
     * @param $name
     * @param $value
     *
     * @return Gateway
     */
    public function __set($name, $value)
    {
        return self::set(...func_get_args());
        return self::set(/** @scrutinizer ignore-type */ ...func_get_args());
    }

    /**
     * Get custom field value respecting aliases.
     *
     * @param string  $field
     * @param mixed   $default
     *
     * @return mixed
     */
    public function get(string $field, $default = null)
    {
        return $this->custom->get($this->getAlias($field), $default);
    }

    /**
     * Magic get method.
     *
     * @param $name
     *
     * @return mixed
     */
    public function __get($name)
    {
        return self::get(...func_get_args());
        return self::get(/** @scrutinizer ignore-type */ ...func_get_args());
    }

    /**
     * Get slug of gateway based on class name.
     *
     * @return string
     */
    public function getSlug(): string
    {
        if (isset($this->slug)) {

            return $this->slug;
        }

        return str_slug(array_last(explode('\\', get_class($this))));
    }

    /**
     * Determine if field has alias for payment gateway.
     * E.g., some gateways can accept description in $_GET parameter vendorPrefix_desc,
     * so we need conversion: 'description' => 'vendorPrefix_desc'.
     *
     * @param string $field
     *
     * @return string
     */
    protected function getAlias(string $field): string
    {
        if (isset($this->aliases[$field])) {
            return $this->aliases[$field];
        }

        return $field;
    }
}

nxmad / Larapay

Push — master ( b8b2bd...fcde1f )

Gateway::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
