flipbox\organizations\queries\UserTypeQuery

Complexity

Total Complexity

28

Size/Duplication

Total Lines	252
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

0%

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	id()	0	5	1
A	setId()	0	4	1
A	handle()	0	5	1
A	setHandle()	0	4	1
A	name()	0	5	1
A	setName()	0	4	1
A	init()	0	13	3
A	prepare()	0	8	1
A	prepareAttributes()	0	10	3
A	prepareRelationsParams()	0	11	3
A	joinUserTypeAssociationsTable()	0	15	2
A	joinOrganizationUserAssociationTable()	0	16	2
A	applyUserParam()	0	15	4
A	applyOrganizationParam()	0	15	4

<?php

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

namespace flipbox\organizations\queries;

use craft\db\QueryAbortedException;
use craft\helpers\Db;
use flipbox\craft\ember\queries\AuditAttributesTrait;
use flipbox\craft\ember\queries\CacheableActiveQuery;
use flipbox\craft\ember\queries\UserAttributeTrait;
use flipbox\organizations\records\UserAssociation as OrganizationUsersRecord;
use flipbox\organizations\records\UserType as UserTypeRecord;
use flipbox\organizations\records\UserTypeAssociation as UserTypeAssociationsRecord;

/**
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 1.0.0
 *
 * @method UserTypeRecord one($db = null)
 * @method UserTypeRecord[] all($db = null)
 * @method UserTypeRecord[] getCachedResult($db = null)
 */
class UserTypeQuery extends CacheableActiveQuery
{
    use OrganizationAttributeTrait,
        UserAttributeTrait,
        AuditAttributesTrait;

    /**
     * @inheritdoc
     */
    public $orderBy = ['name' => SORT_ASC];

    /**
     * @var int|int[]|null
     */
    public $id;

    /**
     * @var string|string[]|null
     */
    public $handle;

    /**
     * @var string|string[]|null
     */
    public $name;

    /**
     * @param $id
     * @return static
     */
    public function id($id)
    {
        $this->id = $id;
        return $this;
    }

    /**
     * @param $id
     * @return static
     */
    public function setId($id)
    {
        return $this->id($id);
    }


    /**
     * @param $handle
     * @return static
     */
    public function handle($handle)
    {
        $this->handle = $handle;
        return $this;
    }

    /**
     * @param $handle
     * @return static
     */
    public function setHandle($handle)
    {
        return $this->handle($handle);
    }

    /**
     * @param $name
     * @return static
     */
    public function name($name)
    {
        $this->name = $name;
        return $this;
    }

    /**
     * @param $name
     * @return static
     */
    public function setName($name)
    {
        return $this->name($name);
    }

    /**
     * Flag if the table is already joined (to prevent subsequent joins)
     *
     * @var bool
     */
    private $typeAssociationTableJoined = false;

    /**
     * Flag if the table is already joined (to prevent subsequent joins)
     *
     * @var bool
     */
    private $userAssociationTableJoined = false;

    /**
     * @inheritdoc
     */
    public function init()
    {
        if ($this->select === null) {
            $this->select = [UserTypeRecord::tableAlias() . '.*'];
        }

        // Set table name
        if ($this->from === null) {
            $this->from([UserTypeRecord::tableName() . ' ' . UserTypeRecord::tableAlias()]);
        }

        parent::init();
    }

    /**
     * @inheritdoc
     * @throws QueryAbortedException
     */
    public function prepare($builder)
    {
        $this->applyAuditAttributeConditions();
        $this->prepareRelationsParams();
        $this->prepareAttributes();

        return parent::prepare($builder);
    }

    /**
     * Prepares simple attributes
     */
    protected function prepareAttributes()
    {
        $attributes = ['id', 'handle', 'name'];

        foreach ($attributes as $attribute) {
            if (null !== ($value = $this->{$attribute})) {
                $this->andWhere(Db::parseParam(UserTypeRecord::tableAlias() . '.' . $attribute, $value));
            }
        }
    }

    /**
     * Prepares relation params
     * @throws QueryAbortedException
     */
    protected function prepareRelationsParams()
    {
        if (empty($this->user) && empty($this->organization)) {
            return;
        }

        $alias = $this->joinOrganizationUserAssociationTable();

        $this->applyUserParam($alias);
        $this->applyOrganizationParam($alias);
    }


    /************************************************************
     * JOIN TABLES
     ************************************************************/

    /**
     * @return string
     */
    protected function joinUserTypeAssociationsTable(): string
    {
        $alias = UserTypeAssociationsRecord::tableAlias();

        if ($this->typeAssociationTableJoined === false) {
            $this->leftJoin(
                UserTypeAssociationsRecord::tableName() . ' ' . $alias,
                '[[' . UserTypeRecord::tableAlias() . '.id]]=[[' . $alias . '.typeId]]'
            );

            $this->typeAssociationTableJoined = true;
        }

        return $alias;
    }

    /**
     * @return string
     */
    protected function joinOrganizationUserAssociationTable(): string
    {
        $userAlias = OrganizationUsersRecord::tableAlias();

        if ($this->userAssociationTableJoined === false) {
            $typeAlias = $this->joinUserTypeAssociationsTable();
            $this->leftJoin(
                OrganizationUsersRecord::tableName() . ' ' . $userAlias,
                '[[' . $userAlias . '.id]] = [[' . $typeAlias . '.userId]]'
            );

            $this->userAssociationTableJoined = true;
        }

        return $userAlias;
    }


    /************************************************************
     * USER
     ************************************************************/

    /**
     * @param string $alias
     * @throws QueryAbortedException
     */
    protected function applyUserParam(string $alias)
    {
        // Is the query already doomed?
        if ($this->user !== null && empty($this->user)) {
            throw new QueryAbortedException();
        }

        if (empty($this->user)) {
            return;
        }

        $this->andWhere(
            Db::parseParam($alias . '.userId', $this->parseUserValue($this->user))
        );
    }


    /************************************************************
     * ORGANIZATION
     ************************************************************/

    /**
     * @param string $alias
     * @throws QueryAbortedException
     */
    protected function applyOrganizationParam(string $alias)
    {
        // Is the query already doomed?
        if ($this->organization !== null && empty($this->organization)) {
            throw new QueryAbortedException();
        }

        if (empty($this->organization)) {
            return;
        }

        $this->andWhere(
            Db::parseParam($alias . '.organizationId', $this->parseOrganizationValue($this->organization))
        );
    }
}