flipbox\craft\element\lists\records\SourceSiteAttributeTrait

Complexity

Total Complexity

26

Size/Duplication

Total Lines	229
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	sourceSiteRules()	0	30	1
A	sourceSiteAttributes()	0	6	1
A	sourceSiteAttributeLabels()	0	6	1
A	setSiteId()	0	4	1
A	getSiteId()	0	4	1
A	setSite()	0	4	1
A	getSite()	0	4	1
A	setSourceSiteId()	0	5	1
A	getSourceSiteId()	0	9	3
A	setSourceSite()	0	13	2
A	getSourceSite()	0	18	4
A	resolveSite()	0	12	3
A	resolveSiteFromRelation()	0	14	3
A	resolveSiteFromId()	0	8	2
A	getSiteRecord()	0	7	1

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://github.com/flipboxfactory/craft-element-lists/LICENSE
 * @link       https://github.com/flipboxfactory/craft-element-lists/
 */

namespace flipbox\craft\element\lists\records;

use Craft;
use craft\models\Site as SiteModel;
use craft\records\Site as SiteRecord;
use craft\validators\SiteIdValidator;
use flipbox\craft\ember\helpers\ModelHelper;
use flipbox\craft\ember\helpers\SiteHelper;
use flipbox\craft\ember\records\ActiveRecordTrait;
use yii\db\ActiveQueryInterface;

/**
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 2.0.0
 *
 * @property int|null $sourceSiteId
 *
 * @method SiteModel parentResolveSite()
 */
trait SourceSiteAttributeTrait
{
    use ActiveRecordTrait;

    /**
     * @var SiteModel|null
     */
    private $site;

    /**
     * @return array
     */
    protected function sourceSiteRules(): array
    {
        return [
            [
                [
                    'sourceSiteId'
                ],
                'number',
                'integerOnly' => true
            ],
            [
                [
                    'sourceSiteId'
                ],
                SiteIdValidator::class
            ],
            [
                [
                    'sourceSiteId',
                    'sourceSite',
                    'siteId',
                    'site'
                ],
                'safe',
                'on' => [
                    ModelHelper::SCENARIO_DEFAULT

The constant flipbox\craft\ember\helpers\ModelHelper::SCENARIO_DEFAULT has been deprecated with message: Use `yii\base\Model::SCENARIO_DEFAULT`

                ]
            ]
        ];
    }

    /**
     * @inheritdoc
     */
    public function sourceSiteAttributes(): array
    {
        return [
            'sourceSiteId'
        ];
    }

    /**
     * @inheritdoc
     */
    public function sourceSiteAttributeLabels(): array
    {
        return [
            'sourceSiteId' => Craft::t('app', 'Site Id')
        ];
    }

    /**
     * @param int|null $id
     * @return SourceSiteAttributeTrait

The return type SourceSiteAttributeTrait is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting?

     */
    public function setSiteId(int $id = null)
    {
        return $this->setSourceSiteId($id);
    }

    /**
     * @return int|null
     */
    public function getSiteId()
    {
        return $this->getSourceSiteId();
    }

    /**
     * Associate a site
     *
     * @param mixed $site
     * @return $this
     */
    public function setSite($site = null)
    {
        return $this->setSourceSite($site);
    }

    /**
     * @return SiteModel|null
     */
    public function getSite()
    {
        return $this->getSourceSite();
    }

    /**
     * Set associated sourceSiteId
     *
     * @param int|null $id
     * @return $this
     */
    public function setSourceSiteId(int $id = null)
    {
        $this->sourceSiteId = $id;
        return $this;
    }

    /**
     * Get associated sourceSiteId
     *
     * @return int|null
     */
    public function getSourceSiteId()
    {
        $siteId = $this->getAttribute('sourceSiteId');
        if (null === $siteId && null !== $this->site) {
            $siteId = $this->sourceSiteId = $this->site->id;
        }

        return $siteId;
    }

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

        if (($site = SiteHelper::resolve($site)) === null) {
            $this->site = $this->sourceSiteId = null;
        } else {
            $this->sourceSiteId = $site->id;
            $this->site = $site;
        }

        return $this;
    }

    /**
     * @return SiteModel|null
     */
    public function getSourceSite()
    {
        if ($this->site === null) {
            $site = $this->resolveSite();
            $this->setSourceSite($site);
            return $site;
        }

        $sourceSiteId = $this->sourceSiteId;
        if ($sourceSiteId !== null &&
            $sourceSiteId !== $this->site->id
        ) {
            $this->site = null;
            return $this->getSite();
        }

        return $this->site;
    }

    /**
     * @return SiteModel|null
     * @throws \yii\base\InvalidArgumentException
     */
    protected function resolveSite()
    {
        if ($site = $this->resolveSiteFromRelation()) {
            return $site;
        }

        if ($site = $this->resolveSiteFromId()) {
            return $site;
        }

        return null;
    }

    /**
     * @return SiteModel|null
     * @throws \yii\base\InvalidArgumentException
     */
    private function resolveSiteFromRelation()
    {
        if (false === $this->isRelationPopulated('siteRecord')) {
            return null;
        }

        if (null === ($record = $this->getRelation('siteRecord'))) {
            return null;
        }

        /** @var SiteRecord $record */

        return Craft::$app->getSites()->getSiteById($record->id);
    }

    /**
     * @return SiteModel|null
     */
    private function resolveSiteFromId()
    {
        if (null === $this->sourceSiteId) {
            return null;
        }

        return Craft::$app->getSites()->getSiteById($this->sourceSiteId);
    }

    /**
     * Get the associated Site
     *
     * @return ActiveQueryInterface
     */
    public function getSiteRecord()
    {
        return $this->hasOne(
            SiteRecord::class,
            ['sourceSiteId' => 'id']
        );
    }
}