ByTIC\Payments\Gateways\Providers\AbstractGateway\Message\Traits\HasModelRequest

Complexity

Total Complexity

26

Size/Duplication

Total Lines	193
Duplicated Lines	0 %

Test Coverage

Coverage

83.87%

Importance

Changes	1
Bugs	0	Features	1

16 Methods

Rating	Name	Duplication	Size	Complexity
A	getModel()	0	3	1
A	setModel()	0	5	1
A	generateModelFromRequest()	0	7	2
A	setModelManager()	0	3	1
A	getModelUrlPkRequestKey()	0	8	2
A	findModelByField()	0	7	2
A	getHttpRequest()	0	3	1
A	getModelPKFromRequestQuery()	0	5	1
A	findModel()	0	3	1
A	validateModel()	0	9	2
A	isValidModel()	0	3	1
A	getModelManager()	0	3	1
A	generateModelFromRequestQuery()	0	8	2
A	setModelFromId()	0	9	2
A	generateModelFromRequestBody()	0	8	4
A	getModelIdFromRequest()	0	7	2

<?php

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

use ByTIC\Payments\Models\Purchase\Traits\IsPurchasableModelTrait;
use Nip\Records\AbstractModels\Record;
use Nip\Records\AbstractModels\RecordManager;

/**
 * Class HasModelRequest
 * @package ByTIC\Common\Payments\Gateways\Providers\AbstractGateway\Message\Traits
 *
 * @property \Symfony\Component\HttpFoundation\Request $httpRequest
 */
trait HasModelRequest
{

    /**
     * @param  string $value
     * @return mixed
     */
    public function setModelManager($value)
    {
        return $this->setParameter('modelManager', $value);
    }

    /**
     * @return bool
     */
    protected function validateModel()
    {
        $model = $this->generateModelFromRequest();
        if ($this->isValidModel($model)) {
            $this->setModel($model);
            return true;
        }

        return false;
    }

    /**
     * @return bool|IsPurchasableModelTrait|Record
     */
    protected function generateModelFromRequest()
    {
        $model = $this->generateModelFromRequestBody();
        if ($this->isValidModel($model)) {
            return $model;
        } else {
            return $this->generateModelFromRequestQuery();
        }
    }

    /**
     * @return bool|IsPurchasableModelTrait|Record
     */
    protected function generateModelFromRequestBody()
    {
        $idModel = $this->getModelIdFromRequest();
        $id = intval($idModel);
        if (strlen($idModel) === strlen($id) && is_int($id) && $id > 0) {
            return $this->findModel($idModel);
        }
        return false;
    }

    /**
     * Returns ID if it has it
     * @return int
     */
    public function getModelIdFromRequest()
    {
        if (is_callable('parent::getModelIdFromRequest')) {
            /** @noinspection PhpUndefinedClassInspection */
            return parent::getModelIdFromRequest();
        }
        return false;

The expression return false returns the type false which is incompatible with the documented return type integer.

    }

    /**
     * @param $id
     * @return IsPurchasableModelTrait|Record
     */
    protected function findModel($id)
    {
        return $this->getModelManager()->findOne($id);
    }

    /**
     * @return RecordManager
     */
    public function getModelManager()
    {
        return $this->getParameter('modelManager');
    }

    /**
     * @param $model
     * @return bool
     */
    protected function isValidModel($model)
    {
        return is_object($model);
    }

    /**
     * @return bool|IsPurchasableModelTrait
     */
    protected function generateModelFromRequestQuery()
    {
        $pkValue = $this->getModelPKFromRequestQuery();
        $field = $this->getModelUrlPkRequestKey();
        if ($pkValue) {
            return $this->findModelByField($field, $pkValue);

The expression return $this->findModelByField($field, $pkValue) also could return the type Nip\Records\AbstractModels\Record which is incompatible with the documented return type ByTIC\Payments\Models\Purchase\Traits\IsPurchasableModelTrait|boolean.

        }
        return false;
    }

    /**
     * returns key in confirm URL Query
     * @return int
     */
    public function getModelPKFromRequestQuery()
    {
        $modelKey = $this->getModelUrlPkRequestKey();

        return $this->getHttpRequest()->query->get($modelKey);
    }

    /**
     * @return string
     */
    public function getModelUrlPkRequestKey()
    {
        $modelIdMethod = 'getPaymentsUrlPK';
        if (method_exists($this->getModelManager(), $modelIdMethod)) {
            return $this->getModelManager()->$modelIdMethod();

The expression return $this->getModelManager()->$modelIdMethod() returns the type Nip\Records\AbstractModels\RecordManager|Nip\Records\Collections\Collection|true which is incompatible with the documented return type string.

        }

        return 'id';
    }

    /**
     * @return \Symfony\Component\HttpFoundation\Request
     */
    public function getHttpRequest()
    {
        return $this->httpRequest;
    }

    /**
     * @param $field
     * @param $value
     * @return IsPurchasableModelTrait
     */
    protected function findModelByField($field, $value)
    {
        if ($field == 'id') {
            return $this->findModel($value);

The expression return $this->findModel($value) returns the type Nip\Records\AbstractModels\Record which is incompatible with the documented return type ByTIC\Payments\Models\Purchase\Traits\IsPurchasableModelTrait.

        }
        $method = 'findOneBy' . ucfirst($field);
        return $this->getModelManager()->$method($value);
    }

    /**
     * @param $model
     * @return $this
     */
    protected function setModel($model)
    {
        $this->setParameter('id', $model->id);
        $this->setParameter('model', $model);
        return $this;
    }

    /**
     * @param $idModel
     * @return bool
     */
    protected function setModelFromId($idModel)
    {
        $model = $this->findModel($idModel);
        if ($model) {

$model is of type Nip\Records\AbstractModels\Record, thus it always evaluated to true.

            $this->setModel($model);
            return true;
        }

        return false;
    }

    /**
     * @return mixed
     */
    protected function getModel()
    {
        return $this->getParameter('model');
    }

    /**
     * @inheritDoc
     */
    abstract protected function setParameter($key, $value);

    /**
     * @inheritDoc
     */
    abstract protected function getParameter($key);
}