SaveActions - Code Metrics - Inspection of "fix: don't use save_and_new action if can't create" - Laravel-Backpack/CRUD - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1204)

by Alashov

created 2018-01-22 22:31 UTC

SaveActions A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	114
Duplicated Lines	7.02 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	8
loc	114
rs	10
wmc	21
lcom	1
cbo	2

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getSaveActionButtonName()	0	15	4
C	getSaveAction()	8	38	7
A	setSaveAction()	0	14	4
B	performSaveAction()	0	23	6

How to fix Duplicated Code

<?php

namespace Backpack\CRUD\app\Http\Controllers\CrudFeatures;

//save_and_back save_and_edit save_and_new
trait SaveActions
{
    /**
     * Get the save configured save action or the one stored in a session variable.
     * @return [type] [description]

     */
    public function getSaveAction()
    {
        $cantCreate = ! $this->crud->hasAccess('create');
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $saveAction = session('save_action', config('backpack.crud.default_save_action', 'save_and_back'));
        if ($saveAction == 'save_and_new' && $cantCreate) {
            $saveAction = 'save_and_back';
        }
        $saveOptions = [];
        $saveCurrent = [
            'value' => $saveAction,
            'label' => $this->getSaveActionButtonName($saveAction),
        ];

        switch ($saveAction) {
            case 'save_and_edit':
                $saveOptions['save_and_back'] = $this->getSaveActionButtonName('save_and_back');
                $saveOptions['save_and_new'] = $this->getSaveActionButtonName('save_and_new');
                break;
            case 'save_and_new':

                $saveOptions['save_and_back'] = $this->getSaveActionButtonName('save_and_back');
                $saveOptions['save_and_edit'] = $this->getSaveActionButtonName('save_and_edit');
                break;
            case 'save_and_back':
            default:

                $saveOptions['save_and_edit'] = $this->getSaveActionButtonName('save_and_edit');
                $saveOptions['save_and_new'] = $this->getSaveActionButtonName('save_and_new');
                break;
        }

        if ($cantCreate) {
            unset($saveOptions['save_and_new']);
        }

        return [
            'active' => $saveCurrent,
            'options' => $saveOptions,
        ];
    }

    /**
     * Change the session variable that remembers what to do after the "Save" action.
     * @param [type] $forceSaveAction [description]

     */
    public function setSaveAction($forceSaveAction = null)
    {
        if ($forceSaveAction) {
            $saveAction = $forceSaveAction;
        } else {
            $saveAction = \Request::input('save_action', config('backpack.crud.default_save_action', 'save_and_back'));
        }

        if (session('save_action', 'save_and_back') !== $saveAction && config('backpack.crud.show_save_action_change', true)) {

            \Alert::info(trans('backpack::crud.save_action_changed_notification'))->flash();
        }

        session(['save_action' => $saveAction]);
    }

    /**
     * Redirect to the correct URL, depending on which save action has been selected.
     * @param  [type] $itemId [description]

     * @return [type]         [description]

     */
    public function performSaveAction($itemId = null)
    {
        $saveAction = \Request::input('save_action', config('backpack.crud.default_save_action', 'save_and_back'));
        $itemId = $itemId ? $itemId : \Request::input('id');

        switch ($saveAction) {
            case 'save_and_new':
                $redirectUrl = $this->crud->route.'/create';
                break;
            case 'save_and_edit':
                $redirectUrl = $this->crud->route.'/'.$itemId.'/edit';
                if (\Request::has('locale')) {
                    $redirectUrl .= '?locale='.\Request::input('locale');
                }
                break;
            case 'save_and_back':
            default:
                $redirectUrl = $this->crud->route;
                break;
        }

        return \Redirect::to($redirectUrl);
    }

    /**
     * Get the translated text for the Save button.
     * @param  string $actionValue [description]
     * @return [type]              [description]

     */
    private function getSaveActionButtonName($actionValue = 'save_and_back')
    {
        switch ($actionValue) {
            case 'save_and_edit':
                return trans('backpack::crud.save_action_save_and_edit');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case 'save_and_new':
                return trans('backpack::crud.save_action_save_and_new');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case 'save_and_back':
            default:
                return trans('backpack::crud.save_action_save_and_back');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        }
    }
}


1		<?php
2
3		namespace Backpack\CRUD\app\Http\Controllers\CrudFeatures;
4
5		//save_and_back save_and_edit save_and_new
6		trait SaveActions
7		{
8		/**
9		* Get the save configured save action or the one stored in a session variable.
10		* @return [type] [description]
		0 ignored issues – show Documentation introduced 2016-10-21 10:57 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
11		*/
12		public function getSaveAction()
13		{
14		$cantCreate = ! $this->crud->hasAccess('create');
		0 ignored issues – show Bug introduced 2018-01-22 22:34 UTC by Report Bug Copy Issue Report The property `crud` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
15		$saveAction = session('save_action', config('backpack.crud.default_save_action', 'save_and_back'));
16		if ($saveAction == 'save_and_new' && $cantCreate) {
17		$saveAction = 'save_and_back';
18		}
19		$saveOptions = [];
20		$saveCurrent = [
21		'value' => $saveAction,
22		'label' => $this->getSaveActionButtonName($saveAction),
23		];
24
25		switch ($saveAction) {
26		case 'save_and_edit':
27		$saveOptions['save_and_back'] = $this->getSaveActionButtonName('save_and_back');
28		$saveOptions['save_and_new'] = $this->getSaveActionButtonName('save_and_new');
29		break;
30	View Code Duplication	case 'save_and_new':
		0 ignored issues – show Duplication introduced 2016-10-17 20:56 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
31		$saveOptions['save_and_back'] = $this->getSaveActionButtonName('save_and_back');
32		$saveOptions['save_and_edit'] = $this->getSaveActionButtonName('save_and_edit');
33		break;
34		case 'save_and_back':
35	View Code Duplication	default:
		0 ignored issues – show Duplication introduced 2016-10-17 20:56 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
36		$saveOptions['save_and_edit'] = $this->getSaveActionButtonName('save_and_edit');
37		$saveOptions['save_and_new'] = $this->getSaveActionButtonName('save_and_new');
38		break;
39		}
40
41		if ($cantCreate) {
42		unset($saveOptions['save_and_new']);
43		}
44
45		return [
46		'active' => $saveCurrent,
47		'options' => $saveOptions,
48		];
49		}
50
51		/**
52		* Change the session variable that remembers what to do after the "Save" action.
53		* @param [type] $forceSaveAction [description]
		0 ignored issues – show Documentation introduced 2016-10-21 10:57 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
54		*/
55		public function setSaveAction($forceSaveAction = null)
56		{
57		if ($forceSaveAction) {
58		$saveAction = $forceSaveAction;
59		} else {
60		$saveAction = \Request::input('save_action', config('backpack.crud.default_save_action', 'save_and_back'));
61		}
62
63		if (session('save_action', 'save_and_back') !== $saveAction && config('backpack.crud.show_save_action_change', true)) {
		0 ignored issues – show Coding Style introduced 2017-10-16 00:33 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 127 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
64		\Alert::info(trans('backpack::crud.save_action_changed_notification'))->flash();
65		}
66
67		session(['save_action' => $saveAction]);
68		}
69
70		/**
71		* Redirect to the correct URL, depending on which save action has been selected.
72		* @param [type] $itemId [description]
		0 ignored issues – show Documentation introduced 2016-10-21 10:57 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
73		* @return [type] [description]
		0 ignored issues – show Documentation introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
74		*/
75		public function performSaveAction($itemId = null)
76		{
77		$saveAction = \Request::input('save_action', config('backpack.crud.default_save_action', 'save_and_back'));
78		$itemId = $itemId ? $itemId : \Request::input('id');
79
80		switch ($saveAction) {
81		case 'save_and_new':
82		$redirectUrl = $this->crud->route.'/create';
83		break;
84		case 'save_and_edit':
85		$redirectUrl = $this->crud->route.'/'.$itemId.'/edit';
86		if (\Request::has('locale')) {
87		$redirectUrl .= '?locale='.\Request::input('locale');
88		}
89		break;
90		case 'save_and_back':
91		default:
92		$redirectUrl = $this->crud->route;
93		break;
94		}
95
96		return \Redirect::to($redirectUrl);
97		}
98
99		/**
100		* Get the translated text for the Save button.
101		* @param string $actionValue [description]
102		* @return [type] [description]
		0 ignored issues – show Documentation introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
103		*/
104		private function getSaveActionButtonName($actionValue = 'save_and_back')
105		{
106		switch ($actionValue) {
107		case 'save_and_edit':
108		return trans('backpack::crud.save_action_save_and_edit');
109		break;
		0 ignored issues – show Unused Code introduced 2017-03-28 07:32 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
110		case 'save_and_new':
111		return trans('backpack::crud.save_action_save_and_new');
112		break;
		0 ignored issues – show Unused Code introduced 2016-10-17 20:56 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
113		case 'save_and_back':
114		default:
115		return trans('backpack::crud.save_action_save_and_back');
116		break;
		0 ignored issues – show Unused Code introduced 2017-02-13 15:30 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
117		}
118		}
119		}
120

Laravel-Backpack / CRUD

Scrutinizer GitHub App not installed

Pull Request — master (#1204)

SaveActions A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like