flipbox\organizations\queries\UserQueryParamHandler

Complexity

Total Complexity

26

Size/Duplication

Total Lines	224
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	11

Test Coverage

Coverage

0%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	setUserState()	0	5	1
A	userState()	0	4	1
A	__construct()	0	5	1
A	setUserType()	0	5	1
B	applyParams()	0	30	6
A	joinOrganizationUserTable()	0	21	3
A	joinOrganizationUserTypeTable()	0	8	1
A	applyOrganizationParam()	0	18	4
A	applyUserTypeParam()	0	20	4
A	applyUserStateParam()	0	18	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\elements\db\UserQuery;
use craft\helpers\Db;
use flipbox\organizations\records\UserAssociation as OrganizationUsersRecord;
use flipbox\organizations\records\UserTypeAssociation as UserCollectionUsersRecord;
use yii\base\BaseObject;
use yii\db\Query;

/**
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 1.0.0
 */
class UserQueryParamHandler extends BaseObject
{
    use OrganizationAttributeTrait,
        OrganizationTypeAttributeTrait,
        UserTypeAttributeTrait {
        setUserType as parentSetUserType;
    }

    /**
     * @var OrganizationAttributesToUserQueryBehavior
     */
    private $owner;

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

    /**
     * @param string|string[]|null $value
     * @return UserQuery
     */
    public function setUserState($value): UserQuery
    {
        $this->userState = $value;
        return $this->owner->owner;
    }

    /**
     * @param string|string[]|null $value
     * @return UserQuery
     */
    public function userState($value): UserQuery
    {
        return $this->setUserState($value);
    }

    /**
     * @inheritdoc
     * @param OrganizationAttributesToUserQueryBehavior $owner
     */
    public function __construct(OrganizationAttributesToUserQueryBehavior $owner, array $config = [])
    {
        $this->owner = $owner;
        parent::__construct($config);
    }

    /**
     * @inheritdoc
     */
    public function setUserType($value): UserQuery
    {
        $this->parentSetUserType($value);
        return $this->owner->owner;
    }

    /**
     * @param UserQuery $query
     * @throws QueryAbortedException
     */
    public function applyParams(UserQuery $query)
    {
        if ($query->subQuery === null ||
            (
                $this->organization === null &&
                $this->organizationType === null &&
                $this->userType === null &&
                $this->userState === null
            )
        ) {
            return;
        }

        $this->joinOrganizationUserTable($query);

        $this->applyOrganizationParam(
            $query,
            $this->organization
        );

        $this->applyUserTypeParam(
            $query,
            $this->userType
        );

        $this->applyUserStateParam(
            $query,
            $this->userState
        );
    }

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

    /**
     * @inheritdoc
     */
    protected function joinOrganizationUserTable(UserQuery $query)
    {
        $alias = OrganizationUsersRecord::tableAlias();

        $query->subQuery->leftJoin(
            OrganizationUsersRecord::tableName() . ' ' . $alias,
            '[[' . $alias . '.userId]] = [[elements.id]]'
        );

        // Check if we're ordering by one of the association table's order columns
        if (is_array($query->orderBy)) {
            $columns = ['userOrder' => 'userOrder', 'organizationOrder' => 'organizationOrder'];
            $matches = array_intersect_key($columns, $query->orderBy);

            foreach ($matches as $param => $select) {
                $query->subQuery->addSelect([$alias . '.' . $select]);
            }
        }

        return $alias;
    }

    /**
     * @inheritdoc
     */
    protected function joinOrganizationUserTypeTable(Query $query)
    {
        $alias = UserCollectionUsersRecord::tableAlias();
        $query->leftJoin(
            UserCollectionUsersRecord::tableName() . ' ' . $alias,
            '[[' . $alias . '.userId]] = [[' . OrganizationUsersRecord::tableAlias() . '.id]]'
        );
    }


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

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

        if (empty($organization)) {
            return;
        }

        $query->subQuery->andWhere(
            Db::parseParam(
                OrganizationUsersRecord::tableAlias() . '.organizationId',
                $this->parseOrganizationValue($organization)
            )
        );
    }


    /************************************************************
     * USER TYPE
     ************************************************************/

    /**
     * @param UserQuery $query
     * @param $type
     *
     * @throws QueryAbortedException
     */
    protected function applyUserTypeParam(UserQuery $query, $type)
    {
        // Is the query already doomed?
        if ($type !== null && empty($type)) {
            throw new QueryAbortedException();
        }

        if (empty($type)) {
            return;
        }

        $this->joinOrganizationUserTypeTable($query->subQuery);

It seems like $query->subQuery can be null; however, joinOrganizationUserTypeTable() does not accept null, maybe add an additional type check?

        $query->subQuery
            ->andWhere(
                Db::parseParam(
                    UserCollectionUsersRecord::tableAlias() . '.typeId',
                    $this->parseUserTypeValue($type)
                )
            );
    }


    /************************************************************
     * USER STATE
     ************************************************************/

    /**
     * @param UserQuery $query
     * @param $state
     *
     * @throws QueryAbortedException
     */
    protected function applyUserStateParam(UserQuery $query, $state)
    {
        // Is the query already doomed?
        if ($state !== null && empty($state)) {
            throw new QueryAbortedException();
        }

        if (empty($state)) {
            return;
        }

        $query->subQuery->andWhere(
            Db::parseParam(
                OrganizationUsersRecord::tableAlias() . '.state',
                $state
            )
        );
    }
}