solutosoft\multitenant\MultiTenantRecord

Complexity

Total Complexity

11

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Test Coverage

Coverage

95.65%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	find()	0	3	1
A	beforeApplyTenant()	0	3	1
A	afterApplyTenant()	0	2	1
A	beforeSave()	0	14	6
A	resolveFields()	0	9	2

<?php

namespace solutosoft\multitenant;

use Yii;
use yii\base\NotSupportedException;

trait MultiTenantRecord
{
    /**
     *@inheritdoc
     */
    public function beforeSave($insert)
    {
        if (!Yii::$app->user->isGuest) {
            $identity = Yii::$app->user->identity;
            if ($identity instanceof TenantInterface) {
                if ($insert && $this->beforeApplyTenant() && $this->{TenantInterface::ATTRIBUTE_NAME} === null) {
                    $this->{TenantInterface::ATTRIBUTE_NAME} = $identity->getTenantId();
                    $this->afterApplyTenant();
                }
            } else {
                throw new NotSupportedException("Identity does not implements TenantInteface");
            }
        }
        return parent::beforeSave($insert);
    }

    /**
     * {@inheritdoc}
     */
    public static function find()
    {
        return Yii::createObject(MultiTenantQuery::class, [get_called_class()]);
    }

    /**
     * {@inheritdoc}
     */
    protected function resolveFields(array $fields, array $expand)
    {
        $fields = parent::resolveFields($fields, $expand);

        if ($this->hasAttribute(TenantInterface::ATTRIBUTE_NAME)) {

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

            unset($fields[TenantInterface::ATTRIBUTE_NAME]);
        }

        return $fields;
    }



    /**
     * This method is invoked before assign the attribute tenant id
     * You may override this method to do preliminary checks before apply tenant id.
     * @return boolean whether the tenant id should be assigned. Defaults to true.
     */
    protected function beforeApplyTenant()
    {
        return true;
    }

    /**
     * This method is invoked after assign the attribute tenant id
     * You may override this method to do postprocessing after apply tenant id.
     */
    protected function afterApplyTenant()
    {

    }
}