UsersController::getById() - Code Metrics - bakaphp/canvas-core - Measure and Improve Code Quality continuously with Scrutinizer

UsersController::getById() A
last analyzed 2020-06-20 15:42 UTC

↳ Parent: UsersController

Complexity

Conditions	3
Paths	2

Size

Total Lines	21
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	8
c	1
b	0
f	0
nc	2
nop	1
dl	0
loc	21
ccs	0
cts	8
cp	0
crap	12
rs	10

<?php

declare(strict_types=1);

namespace Canvas\Api\Controllers;

use Baka\Auth\UsersController as BakaUsersController;
filter:
    dependency_paths: ["lib/*"]
use Canvas\Contracts\Controllers\ProcessOutputMapperTrait;
use Canvas\Dto\User as UserDto;
use Canvas\Http\Exception\InternalServerErrorException;
use Canvas\Mapper\UserMapper;
use Canvas\Models\Users;
use Canvas\Models\UsersAssociatedApps;
use Canvas\Validation as CanvasValidation;
use Phalcon\Http\Response;
filter:
    dependency_paths: ["lib/*"]
use Phalcon\Validation\Validator\PresenceOf;
filter:
    dependency_paths: ["lib/*"]

/**
 * Class UsersController.
 *
 * @package Canvas\Api\Controllers
 *
 * @property Users $userData
 * @property Request $request
 * @property Config $config
 * @property Apps $app
 */
class UsersController extends BakaUsersController
{
    use ProcessOutputMapperTrait;
    /*
     * fields we accept to create
     *
     * @var array
     */
    protected $createFields = [
        'name',
        'firstname',
        'lastname',
        'description',
        'displayname',
        'language',
        'country_id',
        'timezone',
        'email',
        'password',
        'roles_id',
        'created_at',
        'updated_at',
        'default_company',
        'default_company_branch',
        'family',
        'cell_phone_number',
        'country_id',
        'location'
    ];

    /*
     * fields we accept to create
     *
     * @var array
     */
    protected $updateFields = [
        'name',
        'firstname',
        'lastname',
        'description',
        'displayname',
        'language',
        'country_id',
        'timezone',
        'email',
        'password',
        'roles_id',
        'created_at',
        'updated_at',
        'default_company',
        'default_company_branch',
        'cell_phone_number',
        'country_id',
        'location',
        'user_active'
    ];

    /**
     * set objects.
     *
     * @return void
     */
    public function onConstruct()
    {
        $this->model = new Users();

        $this->dto = UserDto::class;
        $this->dtoMapper = new UserMapper();

        //if you are not a admin you cant see all the users
        if (!$this->userData->hasRole('Defaults.Admins')) {
            $this->additionalSearchFields = [

                ['id', ':', $this->userData->getId()],
            ];
        } else {
            //admin get all the users for this company
            $this->additionalSearchFields = [
                ['id', ':', implode('|', $this->userData->getDefaultCompany()->getAssociatedUsersByApp())],
            ];
        }
    }

    /**
     * Get Uer.
     *
     * @param mixed $id
     *
     * @method GET
     * @url /v1/users/{id}
     *
     * @return Response
     */
    public function getById($id) : Response
    {
        //none admin users can only edit themselves
        if (!$this->userData->hasRole('Default.Admins') || (int) $id === 0) {
            $id = $this->userData->getId();
        }

        $this->userData->can('SettingsMenu.company-settings');

        /**
         * @todo filter only by user from this app / company
         */
        $user = $this->model->findFirstOrFail([
            'id = ?0 AND is_deleted = 0',
            'bind' => [$id],
        ]);

        //get the results and append its relationships
        $user = $this->appendRelationshipsToResult($this->request, $user);

        return $this->response($this->processOutput($user));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }

    /**
     * Update a User Info.
     *
     * @method PUT
     * @url /v1/users/{id}
     *
     * @return Response
     */
    public function edit($id) : Response
    {
        //none admin users can only edit themselves
        if (!$this->userData->hasRole('Default.Admins')) {
            $id = $this->userData->getId();
        }

        /**
         * @todo admin users should only be able to update user from their app level
         */
        $user = $this->model->findFirstOrFail($id);
        $request = $this->request->getPutData();

        if (empty($request)) {
            throw new InternalServerErrorException(_('No data to update this account with '));
        }

        //update password
        if (isset($request['new_password']) && (!empty($request['new_password']) && !empty($request['current_password']))) {
            //Ok let validate user password
            $validation = new CanvasValidation();
            $validation->add('new_password', new PresenceOf(['message' => 'The new_password is required.']));
            $validation->add('current_password', new PresenceOf(['message' => 'The current_password is required.']));
            $validation->add('confirm_new_password', new PresenceOf(['message' => 'The confirm_new_password is required.']));
            $validation->validate($request);

            $user->updatePassword($request['current_password'], $request['new_password'], $request['confirm_new_password']);
        } else {
            //remove on any actinon that doesn't involve password
            unset($request['password']);
        }

        //change my default company , the #teamfrontend is sending us the branch's instead of the company id
        //on this value so we use is as the branch
        if (isset($request['default_company']) && !isset($request['default_company_branch'])) {
            $user->switchDefaultCompanyByBranch((int) $request['default_company']);
            unset($request['default_company'], $request['default_company_branch']);
        } elseif (isset($request['default_company_branch'])) {
            $user->switchDefaultCompanyByBranch((int) $request['default_company_branch']);
            unset($request['default_company'], $request['default_company_branch']);
        }

        //update
        $user->updateOrFail($request, $this->updateFields);
        return $this->response($this->processOutput($user));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }

    /**
     * Add users notifications.
     *
     * @param int $id
     *
     * @method PUT
     *
     * @return Response
     */
    public function updateNotifications(int $id) : Response
    {
        //get the notification array
        //delete the current ones
        //iterate and save into users

        return $this->response(['OK' => $id]);
    }

    /**
     * Delete a Record.
     *
     * @throws Exception
     *
     * @return Response
     */
    public function delete($id) : Response
    {
        if ((int) $this->userData->getId() === (int) $id) {
            throw new InternalServerErrorException(
                'Cant delete your own user . If you want to close your account contact support or go to app settings'
            );
        }

        return parent::delete($id);
    }

    /**
     * Change User's active status for in current app.
     *
     * @param int $id
     * @param int $appsId
     *
     * @throws Exception
     *
     * @return Response
     */
    public function changeAppUserActiveStatus(int $id, int $appsId) : Response
    {
        $userAssociatedToApp = UsersAssociatedApps::findFirstOrFail([
            'conditions' => 'users_id = ?0 and apps_id = ?1 and companies_id = ?2 and is_deleted = 0',
            'bind' => [$id, $this->app->getId(), $this->userData->getDefaultCompany()->getId()]
        ]);

        $userAssociatedToApp->user_active = $userAssociatedToApp->user_active ? 0 : 1;
        $userAssociatedToApp->updateOrFail();
        return $this->response($userAssociatedToApp);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Canvas\Api\Controllers;
6
7			use Baka\Auth\UsersController as BakaUsersController;
			0 ignored issues – show Bug introduced 2020-04-02 15:50 UTC by Report Bug Copy Issue Report The type `Baka\Auth\UsersController` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
8			use Canvas\Contracts\Controllers\ProcessOutputMapperTrait;
9			use Canvas\Dto\User as UserDto;
10			use Canvas\Http\Exception\InternalServerErrorException;
11			use Canvas\Mapper\UserMapper;
12			use Canvas\Models\Users;
13			use Canvas\Models\UsersAssociatedApps;
14			use Canvas\Validation as CanvasValidation;
15			use Phalcon\Http\Response;
			0 ignored issues – show Bug introduced 2020-04-02 15:50 UTC by Report Bug Copy Issue Report The type `Phalcon\Http\Response` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
16			use Phalcon\Validation\Validator\PresenceOf;
			0 ignored issues – show Bug introduced 2019-06-06 18:47 UTC by Report Bug Copy Issue Report The type `Phalcon\Validation\Validator\PresenceOf` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
17
18			/**
19			* Class UsersController.
20			*
21			* @package Canvas\Api\Controllers
22			*
23			* @property Users $userData
24			* @property Request $request
25			* @property Config $config
26			* @property Apps $app
27			*/
28			class UsersController extends BakaUsersController
29			{
30			use ProcessOutputMapperTrait;
31			/*
32			* fields we accept to create
33			*
34			* @var array
35			*/
36			protected $createFields = [
37			'name',
38			'firstname',
39			'lastname',
40			'description',
41			'displayname',
42			'language',
43			'country_id',
44			'timezone',
45			'email',
46			'password',
47			'roles_id',
48			'created_at',
49			'updated_at',
50			'default_company',
51			'default_company_branch',
52			'family',
53			'cell_phone_number',
54			'country_id',
55			'location'
56			];
57
58			/*
59			* fields we accept to create
60			*
61			* @var array
62			*/
63			protected $updateFields = [
64			'name',
65			'firstname',
66			'lastname',
67			'description',
68			'displayname',
69			'language',
70			'country_id',
71			'timezone',
72			'email',
73			'password',
74			'roles_id',
75			'created_at',
76			'updated_at',
77			'default_company',
78			'default_company_branch',
79			'cell_phone_number',
80			'country_id',
81			'location',
82			'user_active'
83			];
84
85			/**
86			* set objects.
87			*
88			* @return void
89			*/
90			public function onConstruct()
91			{
92			$this->model = new Users();
			0 ignored issues – show Bug Best Practice introduced 2020-04-02 15:50 UTC by Report Bug Copy Issue Report The property `model` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
93			$this->dto = UserDto::class;
94			$this->dtoMapper = new UserMapper();
95
96			//if you are not a admin you cant see all the users
97			if (!$this->userData->hasRole('Defaults.Admins')) {
98			$this->additionalSearchFields = [
			0 ignored issues – show Bug Best Practice introduced 2020-04-02 15:50 UTC by Report Bug Copy Issue Report The property `additionalSearchFields` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
99			['id', ':', $this->userData->getId()],
100			];
101			} else {
102			//admin get all the users for this company
103			$this->additionalSearchFields = [
104			['id', ':', implode('\|', $this->userData->getDefaultCompany()->getAssociatedUsersByApp())],
105			];
106			}
107			}
108
109			/**
110			* Get Uer.
111			*
112			* @param mixed $id
113			*
114			* @method GET
115			* @url /v1/users/{id}
116			*
117			* @return Response
118			*/
119			public function getById($id) : Response
120			{
121			//none admin users can only edit themselves
122			if (!$this->userData->hasRole('Default.Admins') \|\| (int) $id === 0) {
123			$id = $this->userData->getId();
124			}
125
126			$this->userData->can('SettingsMenu.company-settings');
127
128			/**
129			* @todo filter only by user from this app / company
130			*/
131			$user = $this->model->findFirstOrFail([
132			'id = ?0 AND is_deleted = 0',
133			'bind' => [$id],
134			]);
135
136			//get the results and append its relationships
137			$user = $this->appendRelationshipsToResult($this->request, $user);
138
139			return $this->response($this->processOutput($user));
			0 ignored issues – show Bug introduced 2019-06-06 18:47 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->processOutput($user)` targeting `Canvas\Api\Controllers\U...roller::processOutput()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
140			}
141
142			/**
143			* Update a User Info.
144			*
145			* @method PUT
146			* @url /v1/users/{id}
147			*
148			* @return Response
149			*/
150			public function edit($id) : Response
151			{
152			//none admin users can only edit themselves
153			if (!$this->userData->hasRole('Default.Admins')) {
154			$id = $this->userData->getId();
155			}
156
157			/**
158			* @todo admin users should only be able to update user from their app level
159			*/
160			$user = $this->model->findFirstOrFail($id);
161			$request = $this->request->getPutData();
162
163			if (empty($request)) {
164			throw new InternalServerErrorException(_('No data to update this account with '));
165			}
166
167			//update password
168			if (isset($request['new_password']) && (!empty($request['new_password']) && !empty($request['current_password']))) {
169			//Ok let validate user password
170			$validation = new CanvasValidation();
171			$validation->add('new_password', new PresenceOf(['message' => 'The new_password is required.']));
172			$validation->add('current_password', new PresenceOf(['message' => 'The current_password is required.']));
173			$validation->add('confirm_new_password', new PresenceOf(['message' => 'The confirm_new_password is required.']));
174			$validation->validate($request);
175
176			$user->updatePassword($request['current_password'], $request['new_password'], $request['confirm_new_password']);
177			} else {
178			//remove on any actinon that doesn't involve password
179			unset($request['password']);
180			}
181
182			//change my default company , the #teamfrontend is sending us the branch's instead of the company id
183			//on this value so we use is as the branch
184			if (isset($request['default_company']) && !isset($request['default_company_branch'])) {
185			$user->switchDefaultCompanyByBranch((int) $request['default_company']);
186			unset($request['default_company'], $request['default_company_branch']);
187			} elseif (isset($request['default_company_branch'])) {
188			$user->switchDefaultCompanyByBranch((int) $request['default_company_branch']);
189			unset($request['default_company'], $request['default_company_branch']);
190			}
191
192			//update
193			$user->updateOrFail($request, $this->updateFields);
194			return $this->response($this->processOutput($user));
			0 ignored issues – show Bug introduced 2019-06-06 18:47 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->processOutput($user)` targeting `Canvas\Api\Controllers\U...roller::processOutput()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
195			}
196
197			/**
198			* Add users notifications.
199			*
200			* @param int $id
201			*
202			* @method PUT
203			*
204			* @return Response
205			*/
206			public function updateNotifications(int $id) : Response
207			{
208			//get the notification array
209			//delete the current ones
210			//iterate and save into users
211
212			return $this->response(['OK' => $id]);
213			}
214
215			/**
216			* Delete a Record.
217			*
218			* @throws Exception
219			*
220			* @return Response
221			*/
222			public function delete($id) : Response
223			{
224			if ((int) $this->userData->getId() === (int) $id) {
225			throw new InternalServerErrorException(
226			'Cant delete your own user . If you want to close your account contact support or go to app settings'
227			);
228			}
229
230			return parent::delete($id);
231			}
232
233			/**
234			* Change User's active status for in current app.
235			*
236			* @param int $id
237			* @param int $appsId
238			*
239			* @throws Exception
240			*
241			* @return Response
242			*/
243			public function changeAppUserActiveStatus(int $id, int $appsId) : Response
244			{
245			$userAssociatedToApp = UsersAssociatedApps::findFirstOrFail([
246			'conditions' => 'users_id = ?0 and apps_id = ?1 and companies_id = ?2 and is_deleted = 0',
247			'bind' => [$id, $this->app->getId(), $this->userData->getDefaultCompany()->getId()]
248			]);
249
250			$userAssociatedToApp->user_active = $userAssociatedToApp->user_active ? 0 : 1;
251			$userAssociatedToApp->updateOrFail();
252			return $this->response($userAssociatedToApp);
253			}
254			}
255

bakaphp / canvas-core

UsersController::getById() A last analyzed 2020-06-20 15:42 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

UsersController::getById() A
last analyzed 2020-06-20 15:42 UTC