UserQueryParamHandler::userState() - Code Metrics - flipboxfactory/organizations - Measure and Improve Code Quality continuously with Scrutinizer

UserQueryParamHandler::userState() A
last analyzed 2020-10-27 19:36 UTC

↳ Parent: UserQueryParamHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?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 <[email protected]>
 * @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);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        $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
            )
        );
    }
}


1			<?php
2
3			/**
4			* @copyright Copyright (c) Flipbox Digital Limited
5			* @license https://flipboxfactory.com/software/organization/license
6			* @link https://www.flipboxfactory.com/software/organization/
7			*/
8
9			namespace flipbox\organizations\queries;
10
11			use craft\db\QueryAbortedException;
12			use craft\elements\db\UserQuery;
13			use craft\helpers\Db;
14			use flipbox\organizations\records\UserAssociation as OrganizationUsersRecord;
15			use flipbox\organizations\records\UserTypeAssociation as UserCollectionUsersRecord;
16			use yii\base\BaseObject;
17			use yii\db\Query;
18
19			/**
20			* @author Flipbox Factory <[email protected]>
21			* @since 1.0.0
22			*/
23			class UserQueryParamHandler extends BaseObject
24			{
25			use OrganizationAttributeTrait,
26			OrganizationTypeAttributeTrait,
27			UserTypeAttributeTrait {
28			setUserType as parentSetUserType;
29			}
30
31			/**
32			* @var OrganizationAttributesToUserQueryBehavior
33			*/
34			private $owner;
35
36			/**
37			* @var string\|string[]\|null
38			*/
39			public $userState;
40
41			/**
42			* @param string\|string[]\|null $value
43			* @return UserQuery
44			*/
45			public function setUserState($value): UserQuery
46			{
47			$this->userState = $value;
48			return $this->owner->owner;
49			}
50
51			/**
52			* @param string\|string[]\|null $value
53			* @return UserQuery
54			*/
55			public function userState($value): UserQuery
56			{
57			return $this->setUserState($value);
58			}
59
60			/**
61			* @inheritdoc
62			* @param OrganizationAttributesToUserQueryBehavior $owner
63			*/
64			public function __construct(OrganizationAttributesToUserQueryBehavior $owner, array $config = [])
65			{
66			$this->owner = $owner;
67			parent::__construct($config);
68			}
69
70			/**
71			* @inheritdoc
72			*/
73			public function setUserType($value): UserQuery
74			{
75			$this->parentSetUserType($value);
76			return $this->owner->owner;
77			}
78
79			/**
80			* @param UserQuery $query
81			* @throws QueryAbortedException
82			*/
83			public function applyParams(UserQuery $query)
84			{
85			if ($query->subQuery === null \|\|
86			(
87			$this->organization === null &&
88			$this->organizationType === null &&
89			$this->userType === null &&
90			$this->userState === null
91			)
92			) {
93			return;
94			}
95
96			$this->joinOrganizationUserTable($query);
97
98			$this->applyOrganizationParam(
99			$query,
100			$this->organization
101			);
102
103			$this->applyUserTypeParam(
104			$query,
105			$this->userType
106			);
107
108			$this->applyUserStateParam(
109			$query,
110			$this->userState
111			);
112			}
113
114			/************************************************************
115			* JOIN TABLES
116			************************************************************/
117
118			/**
119			* @inheritdoc
120			*/
121			protected function joinOrganizationUserTable(UserQuery $query)
122			{
123			$alias = OrganizationUsersRecord::tableAlias();
124
125			$query->subQuery->leftJoin(
126			OrganizationUsersRecord::tableName() . ' ' . $alias,
127			'[[' . $alias . '.userId]] = [[elements.id]]'
128			);
129
130			// Check if we're ordering by one of the association table's order columns
131			if (is_array($query->orderBy)) {
132			$columns = ['userOrder' => 'userOrder', 'organizationOrder' => 'organizationOrder'];
133			$matches = array_intersect_key($columns, $query->orderBy);
134
135			foreach ($matches as $param => $select) {
136			$query->subQuery->addSelect([$alias . '.' . $select]);
137			}
138			}
139
140			return $alias;
141			}
142
143			/**
144			* @inheritdoc
145			*/
146			protected function joinOrganizationUserTypeTable(Query $query)
147			{
148			$alias = UserCollectionUsersRecord::tableAlias();
149			$query->leftJoin(
150			UserCollectionUsersRecord::tableName() . ' ' . $alias,
151			'[[' . $alias . '.userId]] = [[' . OrganizationUsersRecord::tableAlias() . '.id]]'
152			);
153			}
154
155
156			/************************************************************
157			* ORGANIZATION
158			************************************************************/
159
160			/**
161			* @param UserQuery $query
162			* @param $organization
163			*
164			* @throws QueryAbortedException
165			*/
166			protected function applyOrganizationParam(UserQuery $query, $organization)
167			{
168			// Is the query already doomed?
169			if ($organization !== null && empty($organization)) {
170			throw new QueryAbortedException();
171			}
172
173			if (empty($organization)) {
174			return;
175			}
176
177			$query->subQuery->andWhere(
178			Db::parseParam(
179			OrganizationUsersRecord::tableAlias() . '.organizationId',
180			$this->parseOrganizationValue($organization)
181			)
182			);
183			}
184
185
186			/************************************************************
187			* USER TYPE
188			************************************************************/
189
190			/**
191			* @param UserQuery $query
192			* @param $type
193			*
194			* @throws QueryAbortedException
195			*/
196			protected function applyUserTypeParam(UserQuery $query, $type)
197			{
198			// Is the query already doomed?
199			if ($type !== null && empty($type)) {
200			throw new QueryAbortedException();
201			}
202
203			if (empty($type)) {
204			return;
205			}
206
207			$this->joinOrganizationUserTypeTable($query->subQuery);
			0 ignored issues – show Bug introduced 2019-01-10 20:11 UTC by Report Bug Copy Issue Report It seems like `$query->subQuery` can be `null`; however, `joinOrganizationUserTypeTable()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
208			$query->subQuery
209			->andWhere(
210			Db::parseParam(
211			UserCollectionUsersRecord::tableAlias() . '.typeId',
212			$this->parseUserTypeValue($type)
213			)
214			);
215			}
216
217
218			/************************************************************
219			* USER STATE
220			************************************************************/
221
222			/**
223			* @param UserQuery $query
224			* @param $state
225			*
226			* @throws QueryAbortedException
227			*/
228			protected function applyUserStateParam(UserQuery $query, $state)
229			{
230			// Is the query already doomed?
231			if ($state !== null && empty($state)) {
232			throw new QueryAbortedException();
233			}
234
235			if (empty($state)) {
236			return;
237			}
238
239			$query->subQuery->andWhere(
240			Db::parseParam(
241			OrganizationUsersRecord::tableAlias() . '.state',
242			$state
243			)
244			);
245			}
246			}
247

flipboxfactory / organizations

UserQueryParamHandler::userState() A last analyzed 2020-10-27 19:36 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

UserQueryParamHandler::userState() A
last analyzed 2020-10-27 19:36 UTC