flipbox\craft\ember\records\SiteAttributeTrait

Complexity

Total Complexity

11

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	siteAttributes()	0	6	1
A	siteAttributeLabels()	0	6	1
A	internalSetSiteId()	0	5	1
A	internalGetSiteId()	0	7	2
A	resolveSite()	0	8	2
A	resolveSiteFromRelation()	0	14	3
A	getSiteRecord()	0	7	1

<?php

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

namespace flipbox\craft\ember\records;

use Craft;
use craft\models\Site as SiteModel;
use craft\records\Site as SiteRecord;
use flipbox\craft\ember\models\SiteRulesTrait;
use flipbox\craft\ember\objects\SiteMutatorTrait;
use yii\db\ActiveQueryInterface;

/**
 * Intended to be used on an ActiveRecord, this class provides `$this->siteId` attribute along with 'getters'
 * and 'setters' to ensure continuity between the Id and Object.  A site object is lazy loaded when called.
 * In addition, ActiveRecord rules are available.
 *
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 2.0.0
 *
 * @property SiteRecord $siteRecord
 */
trait SiteAttributeTrait
{
    use ActiveRecordTrait,
        SiteRulesTrait,
        SiteMutatorTrait;

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

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

    /**
     * @inheritDoc
     */
    protected function internalSetSiteId(int $id = null)
    {
        $this->setAttribute('siteId', $id);
        return $this;
    }

    /**
     * @inheritDoc
     */
    protected function internalGetSiteId()
    {
        if (null === ($id = $this->getAttribute('siteId'))) {
            return null;
        }
        return (int)$id;
    }

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

        return $this->resolveSiteFromId();
    }

    /**
     * @return SiteModel|null
     */
    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);
    }

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