ByTIC\Payments\Gateways\Providers\AbstractGateway\Traits\GatewayTrait

Complexity

Total Complexity

20

Size/Duplication

Total Lines	191
Duplicated Lines	0 %

Test Coverage

Coverage

66%

Importance

Changes	6
Bugs	1	Features	3

18 Methods

Rating	Name	Duplication	Size	Complexity
A	purchaseFromModel()	0	5	1
A	getManager()	0	3	1
A	getLabel()	0	7	2
A	setLabel()	0	3	1
A	setManager()	0	3	1
A	generateName()	0	3	1
A	getName()	0	7	2
A	generateLabel()	0	3	1
A	initName()	0	3	1
A	getImageBand()	0	3	1
A	setSandbox()	0	5	1
A	setName()	0	3	1
A	getSandbox()	0	3	1
A	setHttpRequest()	0	3	1
A	getLogo()	0	3	1
A	setPaymentMethod()	0	3	1
A	initLabel()	0	3	1
A	getPaymentMethod()	0	3	1

<?php

namespace ByTIC\Payments\Gateways\Providers\AbstractGateway\Traits;

use ByTIC\Common\Records\Record;
use ByTIC\Common\Records\Traits\Media\Files\RecordTrait as HasFilesRecord;
use ByTIC\Payments\Gateways\Manager;
use ByTIC\Payments\Models\Methods\Traits\RecordTrait as PaymentMethodRecord;
use ByTIC\Payments\Models\Purchase\Traits\IsPurchasableModelTrait;
use ByTIC\Payments\Utility\GatewayImages;
use Nip\Utility\Traits\NameWorksTrait;
use Omnipay\Common\Message\RequestInterface;
use Symfony\Component\HttpFoundation\Request as HttpRequest;

/**
 * Class Gateway
 * @package ByTIC\Payments\Gateways\Providers\AbstractGateway
 *
 * @property $parameters \Symfony\Component\HttpFoundation\ParameterBag
 */

The doc comment $parameters at position 0 could not be parsed: Unknown type name '$parameters' at position 0 in $parameters.

trait GatewayTrait
{
    use NameWorksTrait;
    use MagicMessagesTrait;
    use HasFormsTrait;
    use DetectFromHttpRequestTrait;
    use OverwriteCompletePurchaseTrait;


    /**
     * @var null|string
     */
    protected $name = null;

    /**
     * @var null|string
     */
    protected $label = null;

    /**
     * @var Manager
     */
    protected $manager;

    /**
     * @var PaymentMethodRecord
     */
    protected $paymentMethod;



    /**
     * @param IsPurchasableModelTrait $record
     * @return RequestInterface
     */
    public function purchaseFromModel($record)
    {
        $parameters = $record->getPurchaseParameters();

        return $this->purchase($parameters);

The method purchase() does not exist on ByTIC\Payments\Gateways\Providers\AbstractGateway\Traits\GatewayTrait. Since you implemented __call, consider adding a @method annotation.

    }

    /**
     * @return null|string
     */
    public function getName()
    {
        if ($this->name === null) {
            $this->initName();
        }

        return $this->name;
    }

    // ------------ GETTERS & SETTERS ------------ //

    /**
     * @param null $name

Are you sure the doc-type for parameter $name is correct as it would always require null to be passed?

     */
    public function setName($name)
    {
        $this->name = $name;
    }

    public function initName()
    {
        $this->setName($this->generateName());
    }

    /**
     * @return string
     */
    protected function generateName()
    {
        return strtolower($this->getLabel());
    }

    /**
     * @return null|string
     */
    public function getLabel()
    {
        if ($this->label === null) {
            $this->initLabel();
        }

        return $this->label;
    }

    /**
     * @param null|string $label
     */
    public function setLabel($label)
    {
        $this->label = $label;
    }

    public function initLabel()
    {
        $this->setLabel($this->generateLabel());
    }

    /**
     * @return string
     */
    public function generateLabel()
    {
        return $this->getNamespaceParentFolder();
    }

    /**
     * @param $value
     * @return mixed
     */
    public function setSandbox($value)
    {
        $return = $this->setParameter('sandbox', $value);

The method setParameter() does not exist on ByTIC\Payments\Gateways\Providers\AbstractGateway\Traits\GatewayTrait. Since you implemented __call, consider adding a @method annotation.

        $this->setTestMode($this->getSandbox() == 'yes');

The method setTestMode() does not exist on ByTIC\Payments\Gateways\Providers\AbstractGateway\Traits\GatewayTrait. Since you implemented __call, consider adding a @method annotation.

        return $return;
    }

    /**
     * @return mixed
     */
    public function getSandbox()
    {
        return $this->getParameter('sandbox');

The method getParameter() does not exist on ByTIC\Payments\Gateways\Providers\AbstractGateway\Traits\GatewayTrait. Since you implemented __call, consider adding a @method annotation.

    }

    /**
     * @return Manager
     */
    public function getManager()
    {
        return $this->manager;
    }

    /**
     * @param Manager $manager
     */
    public function setManager($manager)
    {
        $this->manager = $manager;
    }

    /**
     * @return PaymentMethodRecord|Record|HasFilesRecord
     */
    public function getPaymentMethod()
    {
        return $this->paymentMethod;
    }

    /**
     * @param PaymentMethodRecord $paymentMethod
     */
    public function setPaymentMethod($paymentMethod)
    {
        $this->paymentMethod = $paymentMethod;
    }

    /**
     * @param HttpRequest $httpRequest
     */
    public function setHttpRequest($httpRequest)
    {
        $this->httpRequest = $httpRequest;

The property httpRequest does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    /**
     * @param null $default

Are you sure the doc-type for parameter $default is correct as it would always require null to be passed?

     * @return string|null
     */
    public function getImageBand($default = null)
    {
        return GatewayImages::band($this->getName(), $default);
    }

    /**
     * @param null $default

Are you sure the doc-type for parameter $default is correct as it would always require null to be passed?

     * @return string|null
     */
    public function getLogo($default = null)
    {
        return GatewayImages::logo($this->getName(), $default);
    }

    /**
     * @return boolean
     */
    abstract public function isActive();
}