UserController::getSettings() - Code Metrics - Inspection of "Bug: reinstate deleted methods in user activity mo..." - satrun77/tinyissue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — develop (c3857f)

by Mohamed

created 2016-08-03 09:02 UTC

UserController::getSettings() A

↳ Parent: UserController

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	7
ccs	5
cts	5
cp	1
rs	9.4285
cc	1
eloc	4
nc	1
nop	1
crap	1

<?php

/*
 * This file is part of the Tinyissue package.
 *
 * (c) Mohamed Alsharaf <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Tinyissue\Http\Controllers;

use Tinyissue\Form\UserSetting as Form;
use Tinyissue\Form\UserMessagesSettings as MessagesForm;
use Tinyissue\Http\Requests\FormRequest;
use Tinyissue\Model\Project;
use Tinyissue\Model\User;

/**
 * UserController is the controller class for managing request related to logged in user account.
 *
 * @author Mohamed Alsharaf <[email protected]>
 */
class UserController extends Controller
{
    /**
     * Edit the user's settings.
     *
     * @param Form $form
     *
     * @return \Illuminate\View\View
     */
    public function getSettings(Form $form)
    {
        return view('user.settings', [

            'form'     => $form,
            'projects' => $this->auth->user()->projects()->get(),
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        ]);
    }

    /**
     * To update user settings.
     *
     * @param FormRequest\UserSetting $request
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function postSettings(FormRequest\UserSetting $request)
    {
        $this->auth->user()->updateSetting($request->all());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        return redirect('user/settings')->with('notice', trans('tinyissue.settings_updated'));
    }

    /**
     * Shows the user's assigned issues.
     *
     * @param string  $display
     * @param Project $project
     *
     * @return \Illuminate\View\View
     */
    public function getIssues($display = 'list', Project $project = null)
    {
        $view = $display === 'kanban' ? 'kanban' : 'list';
        $data = [];

        if ($display === 'kanban') {
            $data['columns'] = [];
            $data['issues']  = [];
            if ($project->id) {
                $data['columns'] = $project->getKanbanTagsForUser(auth()->user());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                $ids             = $data['columns']->lists('id')->all();
                $data['issues']  = $this->auth->user()->issuesGroupByTags($ids, $project->id);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            }

            $data['project']  = $project;
            $data['projects'] = $this->auth->user()->projects()->get();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        } else {
            $data['projects'] = $this->auth->user()->projectsWidthIssues(Project::STATUS_OPEN)->get();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }

        return view('user.issues-' . $view, $data);

    }

    /**
     * Edit the user's message settings.
     *
     * @param MessagesForm $form
     *
     * @return \Illuminate\View\View
     */
    public function getMessagesSettings(MessagesForm $form)
    {
        $projects = $this->auth->user()->projects()->with('projectUsers')->get();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $form->setProjects($projects);

        return view('user.messages-settings', [

            'form'     => $form,
            'projects' => $projects,
        ]);
    }

    /**
     * To update user settings.
     *
     * @param FormRequest\UserMessagesSettings $request
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function postMessagesSettings(FormRequest\UserMessagesSettings $request)
    {
        $this->auth->user()->updateMessagesSettings($request->input('projects', []));
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        return redirect('user/settings/messages')->with('notice', trans('tinyissue.messages_settings_updated'));
    }
}


1		<?php
2
3		/*
4		* This file is part of the Tinyissue package.
5		*
6		* (c) Mohamed Alsharaf <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Tinyissue\Http\Controllers;
13
14		use Tinyissue\Form\UserSetting as Form;
15		use Tinyissue\Form\UserMessagesSettings as MessagesForm;
16		use Tinyissue\Http\Requests\FormRequest;
17		use Tinyissue\Model\Project;
18		use Tinyissue\Model\User;
19
20		/**
21		* UserController is the controller class for managing request related to logged in user account.
22		*
23		* @author Mohamed Alsharaf <[email protected]>
24		*/
25		class UserController extends Controller
26		{
27		/**
28		* Edit the user's settings.
29		*
30		* @param Form $form
31		*
32		* @return \Illuminate\View\View
33		*/
34	4	public function getSettings(Form $form)
35		{
36	4	return view('user.settings', [
		0 ignored issues – show Bug Compatibility introduced 2016-02-06 09:03 UTC by Report Bug Copy Issue Report The expression `view('user.settings', ar...)->projects()->get()));` of type `Illuminate\View\View\|Ill...\Contracts\View\Factory` adds the type `Illuminate\Contracts\View\Factory` to the return on line 36 which is incompatible with the return type documented by `Tinyissue\Http\Controlle...Controller::getSettings` of type `Illuminate\View\View`. Loading history...
37	4	'form' => $form,
38	4	'projects' => $this->auth->user()->projects()->get(),
		0 ignored issues – show Bug introduced 2015-12-15 16:27 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Auth\Authenticatable` as the method `projects()` does only exist in the following implementations of said interface: `Tinyissue\Model\User`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
39	4	]);
40		}
41
42		/**
43		* To update user settings.
44		*
45		* @param FormRequest\UserSetting $request
46		*
47		* @return \Illuminate\Http\RedirectResponse
48		*/
49	3	public function postSettings(FormRequest\UserSetting $request)
50		{
51	3	$this->auth->user()->updateSetting($request->all());
		0 ignored issues – show Bug introduced 2015-12-15 16:27 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Auth\Authenticatable` as the method `updateSetting()` does only exist in the following implementations of said interface: `Tinyissue\Model\User`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
52
53	3	return redirect('user/settings')->with('notice', trans('tinyissue.settings_updated'));
54		}
55
56		/**
57		* Shows the user's assigned issues.
58		*
59		* @param string $display
60		* @param Project $project
61		*
62		* @return \Illuminate\View\View
63		*/
64	2	public function getIssues($display = 'list', Project $project = null)
65		{
66	2	$view = $display === 'kanban' ? 'kanban' : 'list';
67	2	$data = [];
68
69	2	if ($display === 'kanban') {
70	1	$data['columns'] = [];
71	1	$data['issues'] = [];
72	1	if ($project->id) {
73	1	$data['columns'] = $project->getKanbanTagsForUser(auth()->user());
		0 ignored issues – show Documentation introduced 2016-05-02 10:04 UTC by Report Bug Copy Issue Report `auth()->user()` is of type `object<Illuminate\Contra...h\Authenticatable>\|null`, but the function expects a `object<Tinyissue\Model\User>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
74	1	$ids = $data['columns']->lists('id')->all();
75	1	$data['issues'] = $this->auth->user()->issuesGroupByTags($ids, $project->id);
		0 ignored issues – show Bug introduced 2016-07-02 18:29 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Auth\Authenticatable` as the method `issuesGroupByTags()` does only exist in the following implementations of said interface: `Tinyissue\Model\User`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
76	1	}
77
78	1	$data['project'] = $project;
79	1	$data['projects'] = $this->auth->user()->projects()->get();
		0 ignored issues – show Bug introduced 2016-02-02 10:13 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Auth\Authenticatable` as the method `projects()` does only exist in the following implementations of said interface: `Tinyissue\Model\User`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
80	1	} else {
81	1	$data['projects'] = $this->auth->user()->projectsWidthIssues(Project::STATUS_OPEN)->get();
		0 ignored issues – show Bug introduced 2015-12-15 16:27 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Auth\Authenticatable` as the method `projectsWidthIssues()` does only exist in the following implementations of said interface: `Tinyissue\Model\User`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
82		}
83
84	2	return view('user.issues-' . $view, $data);
		0 ignored issues – show Bug Compatibility introduced 2016-02-06 09:03 UTC by Report Bug Copy Issue Report The expression `view('user.issues-' . $view, $data);` of type `Illuminate\View\View\|Ill...\Contracts\View\Factory` adds the type `Illuminate\Contracts\View\Factory` to the return on line 84 which is incompatible with the return type documented by `Tinyissue\Http\Controlle...erController::getIssues` of type `Illuminate\View\View`. Loading history...
85		}
86
87		/**
88		* Edit the user's message settings.
89		*
90		* @param MessagesForm $form
91		*
92		* @return \Illuminate\View\View
93		*/
94	1	public function getMessagesSettings(MessagesForm $form)
95		{
96	1	$projects = $this->auth->user()->projects()->with('projectUsers')->get();
		0 ignored issues – show Bug introduced 2016-06-06 00:05 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Auth\Authenticatable` as the method `projects()` does only exist in the following implementations of said interface: `Tinyissue\Model\User`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
97	1	$form->setProjects($projects);
98
99	1	return view('user.messages-settings', [
		0 ignored issues – show Bug Compatibility introduced 2016-06-06 00:05 UTC by Report Bug Copy Issue Report The expression `view('user.messages-sett...ojects' => $projects));` of type `Illuminate\View\View\|Ill...\Contracts\View\Factory` adds the type `Illuminate\Contracts\View\Factory` to the return on line 99 which is incompatible with the return type documented by `Tinyissue\Http\Controlle...er::getMessagesSettings` of type `Illuminate\View\View`. Loading history...
100	1	'form' => $form,
101	1	'projects' => $projects,
102	1	]);
103		}
104
105		/**
106		* To update user settings.
107		*
108		* @param FormRequest\UserMessagesSettings $request
109		*
110		* @return \Illuminate\Http\RedirectResponse
111		*/
112	1	public function postMessagesSettings(FormRequest\UserMessagesSettings $request)
113		{
114	1	$this->auth->user()->updateMessagesSettings($request->input('projects', []));
		0 ignored issues – show Bug introduced 2016-06-06 00:05 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Auth\Authenticatable` as the method `updateMessagesSettings()` does only exist in the following implementations of said interface: `Tinyissue\Model\User`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
115
116	1	return redirect('user/settings/messages')->with('notice', trans('tinyissue.messages_settings_updated'));
117		}
118		}
119

satrun77 / tinyissue

Branch — develop (c3857f)

UserController::getSettings() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like