EditController::addRelation() - Code Metrics - Inspection of "Merge pull request #12 from uccellolabs/debug" - uccellolabs/uccello - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 961031...a503b2 )

by Jonathan

created 2019-01-16 15:27 UTC

EditController::addRelation() A

↳ Parent: Project

Complexity

Conditions	3
Paths	2

Size

Total Lines	26
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	14
nc	2
nop	3
dl	0
loc	26
rs	9.7998
c	0
b	0
f	0

<?php

namespace Uccello\Core\Http\Controllers\Core;

use Kris\LaravelFormBuilder\FormBuilder;
filter:
    dependency_paths: ["lib/*"]
use Illuminate\Http\Request;
use Uccello\Core\Forms\EditForm;
use Uccello\Core\Events\BeforeSaveEvent;
use Uccello\Core\Events\AfterSaveEvent;
use Uccello\Core\Models\Domain;
use Uccello\Core\Models\Module;
use Uccello\Core\Models\Relation;
use Uccello\Core\Models\Relatedlist;

class EditController extends Controller
{
    protected $viewName = 'edit.main';
    protected $formBuilder;

    /**
     * Check user permissions
     */
    protected function checkPermissions()
    {
        if (request()->has('id')) {
            $this->middleware('uccello.permissions:update');
        } else {
            $this->middleware('uccello.permissions:create');
        }
    }

    public function __construct(FormBuilder $formBuilder)
    {
        $this->formBuilder = $formBuilder;

        parent::__construct();
    }

    /**
     * {@inheritdoc}
     */
    public function process(?Domain $domain, Module $module, Request $request)
    {
        // Pre-process
        $this->preProcess($domain, $module, $request);

        // Retrieve record or get a new empty instance
        $record = $this->getRecordFromRequest();

        // Get form
        $form = $this->getForm($record);

        // Get mode
        $mode = !is_null($record->getKey()) ? 'edit' : 'create';

        return $this->autoView([
            'form' => $form,
            'record' => $record,
            'mode' => $mode
        ]);
    }

    /**
     * Create or update record into database
     *
     * @param Domain|null $domain
     * @param Module $module
     * @param boolean $redirect
     * @return void
     */
    public function save(?Domain $domain, Module $module, Request $request, bool $redirect = true)
    {
        // Pre-process
        $this->preProcess($domain, $module, $request);

        // Get model class used by the module
        $modelClass = $this->module->model_class;


        // Retrieve record or get a new empty instance
        $record = $this->getRecordFromRequest();

        // Get form
        $form = $this->getForm($record);

        // Redirect if form not valid (the record is made here)
        $form->redirectIfNotValid();

        $mode = $record->getKey() ? 'edit' : 'create';

        event(new BeforeSaveEvent($domain, $module, $request, $record, $mode));

        // Save record
        $form->getModel()->save();

        event(new AfterSaveEvent($domain, $module, $request, $record, $mode));

        // Save relation if necessary
        if ($request->input('relatedlist') && $request->input('src_id')) {
            $relatedlist = Relatedlist::findOrFail($request->input('relatedlist'));
            $sourceRecordId = $request->input('src_id');
            $tabId = $request->input('tab');

            $this->saveRelation($relatedlist, $sourceRecordId, $record->id);

            $redirectToSourceRecord = true;
        }

        // Redirect
        if ($redirect === true) {
            // Redirect to source record if a relation was made
            if (isset($relatedlist) && $redirectToSourceRecord === true) {

                $params = [ 'id' => $sourceRecordId ];


                // Add tab id if defined to select it automaticaly
                if ($tabId) {

                    $params[ 'tab' ] = $tabId;
                }
                // Add related list id to select the related tab automaticaly
                else {
                    $params[ 'relatedlist' ] = $relatedlist->id;
                }

                $route = ucroute('uccello.detail', $domain, $relatedlist->module, $params);
            }

            // Redirect to edit if the user want to create a new record
            elseif ($request->input('save_new_hdn') === '1') {
                $route = ucroute('uccello.edit', $domain, $module);

                // Notification
                ucnotify(uctrans('notification.record.created', $module), 'success');
            }
            // Else redirect to detail
            else {
                $route = ucroute('uccello.detail', $domain, $module, [ 'id' => $record->getKey() ]);
            }

            return redirect($route);

        }
        // Or return record
        else {
            return $form->getModel();
        }
    }

    /**
     * Add a relation between two records
     *
     * @param Domain|null $domain
     * @param Module $module
     * @param Request $request
     * @return integer|null
     */
    public function addRelation(?Domain $domain, Module $module, Request $request)
    {
        // Pre-process
        $this->preProcess($domain, $module, $request);

        // Retrieve record or get a new empty instance
        $record = $this->getRecordFromRequest();

        if ($request->input('relatedlist') && $request->input('related_id')) {
            $relatedlist = Relatedlist::findOrFail($request->input('relatedlist'));
            $relatedRecordId = $request->input('related_id');

            $relationId = $this->saveRelation($relatedlist, $record->id, $relatedRecordId);

            $response = [
                'success' => true,
                'data' => $relationId
            ];
        } else {
            $response = [
                'success' => false,
                'message' => uctrans('error.mandatory.fields', $module)
            ];
        }

        return $response;
    }

    public function getForm($record = null)
    {
        return $this->formBuilder->create(EditForm::class, [
            'model' => $record,
            'data' => [
                'domain' => $this->domain,
                'module' => $this->module,
                'request' => $this->request
            ]
        ]);
    }

    /**
     * Save relation between two records
     *
     * @param Relatedlist $relatedList
     * @param integer $recordId
     * @param integer $relatedRecordId
     * @return integer
     */
    protected function saveRelation(Relatedlist $relatedList, int $recordId, int $relatedRecordId) : int
    {
        $relation = Relation::firstOrCreate([
            'module_id' => $relatedList->module_id,

            'related_module_id' => $relatedList->related_module_id,

            'record_id' => $recordId,
            'related_record_id' => $relatedRecordId,
            'relatedlist_id' => $relatedList->id
        ]);

        return $relation->id;
    }
}


1			<?php
2
3			namespace Uccello\Core\Http\Controllers\Core;
4
5			use Kris\LaravelFormBuilder\FormBuilder;
			0 ignored issues – show Bug introduced 2018-12-30 00:12 UTC by Report Bug Copy Issue Report The type `Kris\LaravelFormBuilder\FormBuilder` 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...
6			use Illuminate\Http\Request;
7			use Uccello\Core\Forms\EditForm;
8			use Uccello\Core\Events\BeforeSaveEvent;
9			use Uccello\Core\Events\AfterSaveEvent;
10			use Uccello\Core\Models\Domain;
11			use Uccello\Core\Models\Module;
12			use Uccello\Core\Models\Relation;
13			use Uccello\Core\Models\Relatedlist;
14
15			class EditController extends Controller
16			{
17			protected $viewName = 'edit.main';
18			protected $formBuilder;
19
20			/**
21			* Check user permissions
22			*/
23			protected function checkPermissions()
24			{
25			if (request()->has('id')) {
26			$this->middleware('uccello.permissions:update');
27			} else {
28			$this->middleware('uccello.permissions:create');
29			}
30			}
31
32			public function __construct(FormBuilder $formBuilder)
33			{
34			$this->formBuilder = $formBuilder;
35
36			parent::__construct();
37			}
38
39			/**
40			* {@inheritdoc}
41			*/
42			public function process(?Domain $domain, Module $module, Request $request)
43			{
44			// Pre-process
45			$this->preProcess($domain, $module, $request);
46
47			// Retrieve record or get a new empty instance
48			$record = $this->getRecordFromRequest();
49
50			// Get form
51			$form = $this->getForm($record);
52
53			// Get mode
54			$mode = !is_null($record->getKey()) ? 'edit' : 'create';
55
56			return $this->autoView([
57			'form' => $form,
58			'record' => $record,
59			'mode' => $mode
60			]);
61			}
62
63			/**
64			* Create or update record into database
65			*
66			* @param Domain\|null $domain
67			* @param Module $module
68			* @param boolean $redirect
69			* @return void
70			*/
71			public function save(?Domain $domain, Module $module, Request $request, bool $redirect = true)
72			{
73			// Pre-process
74			$this->preProcess($domain, $module, $request);
75
76			// Get model class used by the module
77			$modelClass = $this->module->model_class;
			0 ignored issues – show Unused Code introduced 2018-12-30 00:12 UTC by Report Bug Copy Issue Report The assignment to `$modelClass` is dead and can be removed. Loading history... Bug introduced 2018-12-30 00:12 UTC by Report Bug Copy Issue Report The property `model_class` does not seem to exist on `Uccello\Core\Models\Module`. Are you sure there is no database migration missing? Checks if undeclared accessed properties appear in database migrations and if the creating migration is correct. Loading history...
78
79			// Retrieve record or get a new empty instance
80			$record = $this->getRecordFromRequest();
81
82			// Get form
83			$form = $this->getForm($record);
84
85			// Redirect if form not valid (the record is made here)
86			$form->redirectIfNotValid();
87
88			$mode = $record->getKey() ? 'edit' : 'create';
89
90			event(new BeforeSaveEvent($domain, $module, $request, $record, $mode));
91
92			// Save record
93			$form->getModel()->save();
94
95			event(new AfterSaveEvent($domain, $module, $request, $record, $mode));
96
97			// Save relation if necessary
98			if ($request->input('relatedlist') && $request->input('src_id')) {
99			$relatedlist = Relatedlist::findOrFail($request->input('relatedlist'));
100			$sourceRecordId = $request->input('src_id');
101			$tabId = $request->input('tab');
102
103			$this->saveRelation($relatedlist, $sourceRecordId, $record->id);
104
105			$redirectToSourceRecord = true;
106			}
107
108			// Redirect
109			if ($redirect === true) {
110			// Redirect to source record if a relation was made
111			if (isset($relatedlist) && $redirectToSourceRecord === true) {
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-12-30 00:12 UTC by Report Bug Copy Issue Report The variable `$redirectToSourceRecord` does not seem to be defined for all execution paths leading up to this point. Loading history...
112			$params = [ 'id' => $sourceRecordId ];
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-12-30 00:12 UTC by Report Bug Copy Issue Report The variable `$sourceRecordId` does not seem to be defined for all execution paths leading up to this point. Loading history...
113
114			// Add tab id if defined to select it automaticaly
115			if ($tabId) {
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-12-30 00:12 UTC by Report Bug Copy Issue Report The variable `$tabId` does not seem to be defined for all execution paths leading up to this point. Loading history...
116			$params[ 'tab' ] = $tabId;
117			}
118			// Add related list id to select the related tab automaticaly
119			else {
120			$params[ 'relatedlist' ] = $relatedlist->id;
121			}
122
123			$route = ucroute('uccello.detail', $domain, $relatedlist->module, $params);
124			}
125
126			// Redirect to edit if the user want to create a new record
127			elseif ($request->input('save_new_hdn') === '1') {
128			$route = ucroute('uccello.edit', $domain, $module);
129
130			// Notification
131			ucnotify(uctrans('notification.record.created', $module), 'success');
132			}
133			// Else redirect to detail
134			else {
135			$route = ucroute('uccello.detail', $domain, $module, [ 'id' => $record->getKey() ]);
136			}
137
138			return redirect($route);
			0 ignored issues – show Bug Best Practice introduced 2018-12-30 00:12 UTC by Report Bug Copy Issue Report The expression `return redirect($route)` returns the type `Illuminate\Http\RedirectResponse` which is incompatible with the documented return type `void`. Loading history...
139			}
140			// Or return record
141			else {
142			return $form->getModel();
143			}
144			}
145
146			/**
147			* Add a relation between two records
148			*
149			* @param Domain\|null $domain
150			* @param Module $module
151			* @param Request $request
152			* @return integer\|null
153			*/
154			public function addRelation(?Domain $domain, Module $module, Request $request)
155			{
156			// Pre-process
157			$this->preProcess($domain, $module, $request);
158
159			// Retrieve record or get a new empty instance
160			$record = $this->getRecordFromRequest();
161
162			if ($request->input('relatedlist') && $request->input('related_id')) {
163			$relatedlist = Relatedlist::findOrFail($request->input('relatedlist'));
164			$relatedRecordId = $request->input('related_id');
165
166			$relationId = $this->saveRelation($relatedlist, $record->id, $relatedRecordId);
167
168			$response = [
169			'success' => true,
170			'data' => $relationId
171			];
172			} else {
173			$response = [
174			'success' => false,
175			'message' => uctrans('error.mandatory.fields', $module)
176			];
177			}
178
179			return $response;
180			}
181
182			public function getForm($record = null)
183			{
184			return $this->formBuilder->create(EditForm::class, [
185			'model' => $record,
186			'data' => [
187			'domain' => $this->domain,
188			'module' => $this->module,
189			'request' => $this->request
190			]
191			]);
192			}
193
194			/**
195			* Save relation between two records
196			*
197			* @param Relatedlist $relatedList
198			* @param integer $recordId
199			* @param integer $relatedRecordId
200			* @return integer
201			*/
202			protected function saveRelation(Relatedlist $relatedList, int $recordId, int $relatedRecordId) : int
203			{
204			$relation = Relation::firstOrCreate([
205			'module_id' => $relatedList->module_id,
			0 ignored issues – show Bug introduced 2018-12-30 00:12 UTC by Report Bug Copy Issue Report The property `module_id` does not exist on `Uccello\Core\Models\Relatedlist`. Did you mean `module`? Loading history...
206			'related_module_id' => $relatedList->related_module_id,
			0 ignored issues – show Bug introduced 2018-12-30 00:12 UTC by Report Bug Copy Issue Report The property `related_module_id` does not exist on `Uccello\Core\Models\Relatedlist`. Did you mean `module`? Loading history...
207			'record_id' => $recordId,
208			'related_record_id' => $relatedRecordId,
209			'relatedlist_id' => $relatedList->id
210			]);
211
212			return $relation->id;
213			}
214			}
215

uccellolabs / uccello

Push — master ( 961031...a503b2 )

EditController::addRelation() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like