UsersController::actionAssociationEditorHtml() - Code Metrics - Inspection of "pass type id" - flipboxfactory/organizations - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 0d3736...607e7f )

by Nate

created 2019-01-29 21:27 UTC

UsersController::actionAssociationEditorHtml() A

↳ Parent: UsersController

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	0
loc	30
ccs	0
cts	27
cp	0
rs	9.44
c	0
b	0
f	0
cc	3
nc	4
nop	2
crap	12

<?php

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

namespace flipbox\organizations\cp\controllers;

use Craft;
use craft\elements\User;
use craft\helpers\ArrayHelper;
use flipbox\organizations\actions\users\AssociateUserToOrganization;
use flipbox\organizations\actions\users\DissociateUserFromOrganization;
use flipbox\organizations\behaviors\UserTypesBehavior;
use flipbox\organizations\events\handlers\RegisterOrganizationUserElementDefaultTableAttributes;
use flipbox\organizations\events\handlers\RegisterOrganizationUserElementTableAttributes;
use flipbox\organizations\events\handlers\SetOrganizationUserElementTableAttributeHtml;
use flipbox\organizations\records\UserAssociation;
use flipbox\organizations\records\UserType;
use yii\base\Event;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 1.0.0
 */
class UsersController extends AbstractController
{
    /**
     * @return array
     */
    public function behaviors()
    {
        return ArrayHelper::merge(
            parent::behaviors(),
            [
                'error' => [
                    'default' => 'organization'
                ],
                'redirect' => [
                    'only' => ['associate', 'dissociate'],
                    'actions' => [
                        'associate' => [204],
                        'dissociate' => [204],
                    ]
                ],
                'flash' => [
                    'actions' => [
                        'associate' => [
                            204 => Craft::t('organizations', "Successfully associated user."),
                            401 => Craft::t('organizations', "Failed to associate user.")
                        ],
                        'dissociate' => [
                            204 => Craft::t('organizations', "Successfully dissociated user."),
                            401 => Craft::t('organizations', "Failed to dissociate user.")
                        ]
                    ]
                ]
            ]
        );
    }

    /**
     * @return array
     */
    protected function verbs(): array
    {
        return [
            'associate' => ['post']
        ];
    }

    /**
     * @param int|string|null $user
     * @param int|string|null $organization
     * @return mixed
     * @throws \yii\base\InvalidConfigException
     */
    public function actionAssociate($user = null, $organization = null)
    {
        if (null === $organization) {
            $organization = Craft::$app->getRequest()->getBodyParam('organization');
        }

        if (null === $user) {
            $user = Craft::$app->getRequest()->getBodyParam('user');
        }

        /** @var AssociateUserToOrganization $action */
        $action = Craft::createObject([
            'class' => AssociateUserToOrganization::class
        ], [
            'associate',
            $this
        ]);

        return $action->runWithParams([
            'organization' => $organization,
            'user' => $user
        ]);
    }

    /**
     * @param int|string|null $user
     * @param int|string|null $organization
     * @return mixed
     * @throws \yii\base\InvalidConfigException
     */
    public function actionDissociate($user = null, $organization = null)
    {
        if (null === $organization) {
            $organization = Craft::$app->getRequest()->getBodyParam('organization');
        }

        if (null === $user) {
            $user = Craft::$app->getRequest()->getBodyParam('user');
        }

        /** @var DissociateUserFromOrganization $action */
        $action = Craft::createObject([
            'class' => DissociateUserFromOrganization::class
        ], [
            'dissociate',
            $this
        ]);

        return $action->runWithParams([
            'organization' => $organization,
            'user' => $user
        ]);
    }

    /**
     * @param null $user
     * @param null $organization
     * @return \yii\web\Response
     * @throws \Throwable
     * @throws \yii\db\StaleObjectException
     */
    public function actionSaveAssociation($user = null, $organization = null)
    {
        if (null === $organization) {
            $organization = Craft::$app->getRequest()->getBodyParam('organization');
        }

        if (null === $user) {
            $user = Craft::$app->getRequest()->getBodyParam(
                'user',
                Craft::$app->getRequest()->getBodyParam('elementId')
            );
        }

        $userAssociation = UserAssociation::findOne([
            'user' => $user,
            'organization' => $organization
        ]);

        $success = true;

        $userAssociation->state = Craft::$app->getRequest()->getBodyParam('state', $userAssociation->state);

        if (!$userAssociation->save(true, ['state'])) {
            $success = false;
        }

        $user = $userAssociation->getUser();

        if (null !== ($types = Craft::$app->getRequest()->getBodyParam('types'))) {
            $query = UserType::find()->id(empty($types) ? ':empty:' : $types);

            $query->setCachedResult(
                $query->all()
            );

            /** @var UserTypesBehavior|User $user */
            if (!$user->saveUserTypes($query, $userAssociation->getOrganization())) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                $success = false;

                $userAssociation->addError('types', 'Unable to save types.');
            }
        }

        $response = [
            'success' => $success,
            'id' => $user->getId(),
            'newTitle' => (string)$user,
            'cpEditUrl' => $user->getCpEditUrl(),
        ];

        // Should we be including table attributes too?
        $sourceKey = Craft::$app->getRequest()->getBodyParam('includeTableAttributesForSource');

        if ($sourceKey) {
            Event::on(
                User::class,
                User::EVENT_REGISTER_DEFAULT_TABLE_ATTRIBUTES,
                [
                    RegisterOrganizationUserElementDefaultTableAttributes::class,
                    'handle'
                ]
            );

            // Add attributes the user index
            Event::on(
                User::class,
                User::EVENT_REGISTER_TABLE_ATTRIBUTES,
                [
                    RegisterOrganizationUserElementTableAttributes::class,
                    'handle'
                ]
            );

            // Add 'organizations' on the user html element
            Event::on(
                User::class,
                User::EVENT_SET_TABLE_ATTRIBUTE_HTML,
                [
                    SetOrganizationUserElementTableAttributeHtml::class,
                    'handle'
                ]
            );

            $attributes = Craft::$app->getElementIndexes()->getTableAttributes(get_class($user), $sourceKey);

            // Drop the first one
            array_shift($attributes);

            foreach ($attributes as $attribute) {
                $response['tableAttributes'][$attribute[0]] = $user->getTableAttributeHtml($attribute[0]);
            }

            Event::off(
                User::class,
                User::EVENT_REGISTER_DEFAULT_TABLE_ATTRIBUTES,
                [
                    RegisterOrganizationUserElementDefaultTableAttributes::class,
                    'handle'
                ]
            );

            // Add attributes the user index
            Event::off(
                User::class,
                User::EVENT_REGISTER_TABLE_ATTRIBUTES,
                [
                    RegisterOrganizationUserElementTableAttributes::class,
                    'handle'
                ]
            );

            // Add 'organizations' on the user html element
            Event::off(
                User::class,
                User::EVENT_SET_TABLE_ATTRIBUTE_HTML,
                [
                    SetOrganizationUserElementTableAttributeHtml::class,
                    'handle'
                ]
            );
        }

        return $this->asJson($response);
    }

    /**
     * @param null $user
     * @param null $organization
     * @return \yii\web\Response
     * @throws \Twig_Error_Loader
     * @throws \yii\base\Exception
     */
    public function actionAssociationEditorHtml($user = null, $organization = null)
    {
        if (null === $organization) {
            $organization = Craft::$app->getRequest()->getBodyParam('organization');
        }

        if (null === $user) {
            $user = Craft::$app->getRequest()->getBodyParam(
                'user',
                Craft::$app->getRequest()->getBodyParam('elementId')
            );
        }

        $userAssociation = UserAssociation::findOne([
            'user' => $user,
            'organization' => $organization
        ]);

        $view = Craft::$app->getView();
        return $this->asJson([
            'html' => Craft::$app->getView()->renderTemplate(
                "organizations/_cp/_components/userAssociationEditorHtml",
                [
                    'association' => $userAssociation
                ]
            ),
            'headHtml' => $view->getHeadHtml(),
            'footHtml' => $view->getBodyHtml()
        ]);
    }
}


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\cp\controllers;
10
11			use Craft;
12			use craft\elements\User;
13			use craft\helpers\ArrayHelper;
14			use flipbox\organizations\actions\users\AssociateUserToOrganization;
15			use flipbox\organizations\actions\users\DissociateUserFromOrganization;
16			use flipbox\organizations\behaviors\UserTypesBehavior;
17			use flipbox\organizations\events\handlers\RegisterOrganizationUserElementDefaultTableAttributes;
18			use flipbox\organizations\events\handlers\RegisterOrganizationUserElementTableAttributes;
19			use flipbox\organizations\events\handlers\SetOrganizationUserElementTableAttributeHtml;
20			use flipbox\organizations\records\UserAssociation;
21			use flipbox\organizations\records\UserType;
22			use yii\base\Event;
23
24			/**
25			* @author Flipbox Factory <[email protected]>
26			* @since 1.0.0
27			*/
28			class UsersController extends AbstractController
29			{
30			/**
31			* @return array
32			*/
33			public function behaviors()
34			{
35			return ArrayHelper::merge(
36			parent::behaviors(),
37			[
38			'error' => [
39			'default' => 'organization'
40			],
41			'redirect' => [
42			'only' => ['associate', 'dissociate'],
43			'actions' => [
44			'associate' => [204],
45			'dissociate' => [204],
46			]
47			],
48			'flash' => [
49			'actions' => [
50			'associate' => [
51			204 => Craft::t('organizations', "Successfully associated user."),
52			401 => Craft::t('organizations', "Failed to associate user.")
53			],
54			'dissociate' => [
55			204 => Craft::t('organizations', "Successfully dissociated user."),
56			401 => Craft::t('organizations', "Failed to dissociate user.")
57			]
58			]
59			]
60			]
61			);
62			}
63
64			/**
65			* @return array
66			*/
67			protected function verbs(): array
68			{
69			return [
70			'associate' => ['post']
71			];
72			}
73
74			/**
75			* @param int\|string\|null $user
76			* @param int\|string\|null $organization
77			* @return mixed
78			* @throws \yii\base\InvalidConfigException
79			*/
80			public function actionAssociate($user = null, $organization = null)
81			{
82			if (null === $organization) {
83			$organization = Craft::$app->getRequest()->getBodyParam('organization');
84			}
85
86			if (null === $user) {
87			$user = Craft::$app->getRequest()->getBodyParam('user');
88			}
89
90			/** @var AssociateUserToOrganization $action */
91			$action = Craft::createObject([
92			'class' => AssociateUserToOrganization::class
93			], [
94			'associate',
95			$this
96			]);
97
98			return $action->runWithParams([
99			'organization' => $organization,
100			'user' => $user
101			]);
102			}
103
104			/**
105			* @param int\|string\|null $user
106			* @param int\|string\|null $organization
107			* @return mixed
108			* @throws \yii\base\InvalidConfigException
109			*/
110			public function actionDissociate($user = null, $organization = null)
111			{
112			if (null === $organization) {
113			$organization = Craft::$app->getRequest()->getBodyParam('organization');
114			}
115
116			if (null === $user) {
117			$user = Craft::$app->getRequest()->getBodyParam('user');
118			}
119
120			/** @var DissociateUserFromOrganization $action */
121			$action = Craft::createObject([
122			'class' => DissociateUserFromOrganization::class
123			], [
124			'dissociate',
125			$this
126			]);
127
128			return $action->runWithParams([
129			'organization' => $organization,
130			'user' => $user
131			]);
132			}
133
134			/**
135			* @param null $user
136			* @param null $organization
137			* @return \yii\web\Response
138			* @throws \Throwable
139			* @throws \yii\db\StaleObjectException
140			*/
141			public function actionSaveAssociation($user = null, $organization = null)
142			{
143			if (null === $organization) {
144			$organization = Craft::$app->getRequest()->getBodyParam('organization');
145			}
146
147			if (null === $user) {
148			$user = Craft::$app->getRequest()->getBodyParam(
149			'user',
150			Craft::$app->getRequest()->getBodyParam('elementId')
151			);
152			}
153
154			$userAssociation = UserAssociation::findOne([
155			'user' => $user,
156			'organization' => $organization
157			]);
158
159			$success = true;
160
161			$userAssociation->state = Craft::$app->getRequest()->getBodyParam('state', $userAssociation->state);
162
163			if (!$userAssociation->save(true, ['state'])) {
164			$success = false;
165			}
166
167			$user = $userAssociation->getUser();
168
169			if (null !== ($types = Craft::$app->getRequest()->getBodyParam('types'))) {
170			$query = UserType::find()->id(empty($types) ? ':empty:' : $types);
171
172			$query->setCachedResult(
173			$query->all()
174			);
175
176			/** @var UserTypesBehavior\|User $user */
177			if (!$user->saveUserTypes($query, $userAssociation->getOrganization())) {
			0 ignored issues – show Bug introduced 2019-01-29 21:37 UTC by Report Bug Copy Issue Report The method `saveUserTypes` does only exist in `flipbox\organizations\behaviors\UserTypesBehavior`, but not in `craft\elements\User`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
178			$success = false;
179
180			$userAssociation->addError('types', 'Unable to save types.');
181			}
182			}
183
184			$response = [
185			'success' => $success,
186			'id' => $user->getId(),
187			'newTitle' => (string)$user,
188			'cpEditUrl' => $user->getCpEditUrl(),
189			];
190
191			// Should we be including table attributes too?
192			$sourceKey = Craft::$app->getRequest()->getBodyParam('includeTableAttributesForSource');
193
194			if ($sourceKey) {
195			Event::on(
196			User::class,
197			User::EVENT_REGISTER_DEFAULT_TABLE_ATTRIBUTES,
198			[
199			RegisterOrganizationUserElementDefaultTableAttributes::class,
200			'handle'
201			]
202			);
203
204			// Add attributes the user index
205			Event::on(
206			User::class,
207			User::EVENT_REGISTER_TABLE_ATTRIBUTES,
208			[
209			RegisterOrganizationUserElementTableAttributes::class,
210			'handle'
211			]
212			);
213
214			// Add 'organizations' on the user html element
215			Event::on(
216			User::class,
217			User::EVENT_SET_TABLE_ATTRIBUTE_HTML,
218			[
219			SetOrganizationUserElementTableAttributeHtml::class,
220			'handle'
221			]
222			);
223
224			$attributes = Craft::$app->getElementIndexes()->getTableAttributes(get_class($user), $sourceKey);
225
226			// Drop the first one
227			array_shift($attributes);
228
229			foreach ($attributes as $attribute) {
230			$response['tableAttributes'][$attribute[0]] = $user->getTableAttributeHtml($attribute[0]);
231			}
232
233			Event::off(
234			User::class,
235			User::EVENT_REGISTER_DEFAULT_TABLE_ATTRIBUTES,
236			[
237			RegisterOrganizationUserElementDefaultTableAttributes::class,
238			'handle'
239			]
240			);
241
242			// Add attributes the user index
243			Event::off(
244			User::class,
245			User::EVENT_REGISTER_TABLE_ATTRIBUTES,
246			[
247			RegisterOrganizationUserElementTableAttributes::class,
248			'handle'
249			]
250			);
251
252			// Add 'organizations' on the user html element
253			Event::off(
254			User::class,
255			User::EVENT_SET_TABLE_ATTRIBUTE_HTML,
256			[
257			SetOrganizationUserElementTableAttributeHtml::class,
258			'handle'
259			]
260			);
261			}
262
263			return $this->asJson($response);
264			}
265
266			/**
267			* @param null $user
268			* @param null $organization
269			* @return \yii\web\Response
270			* @throws \Twig_Error_Loader
271			* @throws \yii\base\Exception
272			*/
273			public function actionAssociationEditorHtml($user = null, $organization = null)
274			{
275			if (null === $organization) {
276			$organization = Craft::$app->getRequest()->getBodyParam('organization');
277			}
278
279			if (null === $user) {
280			$user = Craft::$app->getRequest()->getBodyParam(
281			'user',
282			Craft::$app->getRequest()->getBodyParam('elementId')
283			);
284			}
285
286			$userAssociation = UserAssociation::findOne([
287			'user' => $user,
288			'organization' => $organization
289			]);
290
291			$view = Craft::$app->getView();
292			return $this->asJson([
293			'html' => Craft::$app->getView()->renderTemplate(
294			"organizations/_cp/_components/userAssociationEditorHtml",
295			[
296			'association' => $userAssociation
297			]
298			),
299			'headHtml' => $view->getHeadHtml(),
300			'footHtml' => $view->getBodyHtml()
301			]);
302			}
303			}
304

flipboxfactory / organizations

Push — develop ( 0d3736...607e7f )

UsersController::actionAssociationEditorHtml() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like