flipbox\patron\records\traits\InstanceMutator

Complexity

Total Complexity

24

Size/Duplication

Total Lines	163
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	setInstanceId()	0	5	1
A	getInstanceId()	0	10	3
A	setInstance()	0	13	2
A	getInstance()	0	18	4
A	resolveInstance()	0	12	3
A	resolveInstanceFromRelation()	0	13	3
A	resolveInstanceFromId()	0	8	2
A	internalResolveInstance()	0	23	5
A	getInstanceRecord()	0	7	1

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://flipboxfactory.com/software/patron/license
 * @link       https://www.flipboxfactory.com/software/patron/
 */

namespace flipbox\patron\records\traits;

use Craft;
use flipbox\ember\helpers\ObjectHelper;
use flipbox\patron\records\ProviderInstance;
use yii\db\ActiveQueryInterface;

/**
 * @property int|null $instanceId
 * @property ProviderInstance|null $instance
 * @property ActiveQueryInterface $instanceRecord
 *
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 1.0.0
 */
trait InstanceMutator
{
    /**
     * @var ProviderInstance|null
     */
    private $instance;

    /**
     * Set associated instanceId
     *
     * @param $id
     * @return $this
     */
    public function setInstanceId(int $id)
    {
        $this->instanceId = $id;
        return $this;
    }

    /**
     * Get associated instanceId
     *
     * @return int|null
     */
    public function getInstanceId()
    {
        $id = $this->getAttribute('instanceId');

It seems like getAttribute() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        if (null === $id && null !== $this->instance) {
            $id = $this->instance->id;
            $this->setAttribute('instanceId', $id);

It seems like setAttribute() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        return $id;
    }

    /**
     * Associate a instance
     *
     * @param mixed $instance
     * @return $this
     */
    public function setInstance($instance = null)
    {
        $this->instance = null;

        if (null === ($instance = $this->internalResolveInstance($instance))) {
            $this->instance = $this->instanceId = null;
        } else {
            $this->instanceId = $instance->id;
            $this->instance = $instance;

It seems like $instance of type object<yii\db\ActiveRecordInterface> or array is incompatible with the declared type object<flipbox\patron\records\ProviderInstance>|null of property $instance.

        }

        return $this;
    }

    /**
     * @return ProviderInstance|null
     */
    public function getInstance()
    {
        if ($this->instance === null) {
            $instance = $this->resolveInstance();
            $this->setInstance($instance);
            return $instance;
        }

        $instanceId = $this->instanceId;
        if ($instanceId !== null &&
            $instanceId !== $this->instance->id
        ) {
            $this->instance = null;
            return $this->getInstance();
        }

        return $this->instance;
    }

    /**
     * @return ProviderInstance|null
     */
    protected function resolveInstance()
    {
        if (null !== ($model = $this->resolveInstanceFromRelation())) {
            return $model;
        }

        if (null !== ($model = $this->resolveInstanceFromId())) {
            return $model;
        }

        return null;
    }

    /**
     * @return ProviderInstance|null
     */
    private function resolveInstanceFromRelation()
    {
        if (false === $this->isRelationPopulated('instanceRecord')) {

It seems like isRelationPopulated() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return null;
        }

        /** @var ProviderInstance $record */
        if (null === ($record = $this->getRelation('instanceRecord'))) {

It seems like getRelation() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return null;
        }

        return $record;
    }

    /**
     * @return ProviderInstance|null
     */
    private function resolveInstanceFromId()
    {
        if (null === $this->instanceId) {
            return null;
        }

        return ProviderInstance::findOne($this->instanceId);
    }

    /**
     * @param $instance
     * @return ProviderInstance|null
     */
    protected function internalResolveInstance($instance = null)
    {
        if ($instance instanceof ProviderInstance) {
            return $instance;
        }

        if (is_numeric($instance) || is_string($instance)) {
            return ProviderInstance::findOne($instance);
        }

        try {
            $object = Craft::createObject(ProviderInstance::class, [$instance]);
        } catch (\Exception $e) {
            $object = new ProviderInstance();
            ObjectHelper::populate(
                $object,
                $instance
            );
        }

        /** @var ProviderInstance $object */
        return $object;
    }

    /**
     * Returns the associated instance record.
     *
     * @return ActiveQueryInterface
     */
    protected function getInstanceRecord(): ActiveQueryInterface
    {
        return $this->hasOne(

It seems like hasOne() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            ProviderInstance::class,
            ['id' => 'instanceId']
        );
    }
}