BaseModelController - Code Metrics - Inspection of "= more & more" - marcmascarell/laravel-artificer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — dev ( 81bde7...979e1f )

by Marc

created 2016-04-01 23:52 UTC

BaseModelController B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	309
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes	5
Bugs	0	Features	0

Metric	Value
wmc	41
c	5
b	0
f	0
lcom	1
cbo	8
dl	0
loc	309
rs	8.2769

16 Methods

Rating	Name	Size	Complexity
A	__construct()	15	4
A	checkPermissions()	13	1
A	handleData()	6	1
A	getFields()	16	2
A	getSort()	20	3
A	getRules()	12	3
A	getCurrentModelId()	4	2
A	filterInputData()	17	4
A	except()	10	2
B	handleFiles()	19	5
A	isFileInput()	4	2
A	uploadFile()	18	3
B	getRelatedFieldOutput()	22	4
A	redirect()	16	3
A	validator()	4	1
A	all()	8	1

How to fix Complexity

<?php namespace Mascame\Artificer\Http\Controllers;

use App;
use Auth;
use File;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Routing\Redirector;
use Illuminate\Routing\Router;
use Input;
use Mascame\Artificer\Fields\Field;
use Mascame\Artificer\Fields\FieldFactory;
use Mascame\Formality\Factory\Factory;
use Mascame\Formality\Parser\Parser;
use Mascame\Artificer\Permit\ModelPermit;
use Mascame\Formality\Manager\Manager;
use Redirect;
use Route;
use Session;
use Validator;
use View;


class BaseModelController extends BaseController
{

    /**
     * The Eloquent model instance
     * @var \Eloquent
     */
    protected $model;

    /**
     *
     */
    public function __construct()
    {
        parent::__construct();

        // Todo: Do Sth with this
        if (false) {
            if (! Auth::check() || ! ModelPermit::access()) {
                App::abort('403', 'Forbidden access');
            }
        }

        $this->model = $this->modelObject->model;

        $this->checkPermissions();
    }

    /**
     *
     */
    protected function checkPermissions()
    {
        $permit = array(
            'read' => ModelPermit::to('read'),
            'create' => ModelPermit::to('create'),
            'update' => ModelPermit::to('update'),
            'delete' => ModelPermit::to('delete'),
        );

        ModelPermit::routeAction(Route::currentRouteName());

        View::share('permit', $permit);
    }

    /**
     * @param $data
     */
    protected function handleData($data)
    {
        $this->data = $data;

        $this->getFields($data);
    }

    /**
     * @param $data
     * @return null
     */
    protected function getFields($data)

    {
        if ($this->fields) return $this->fields;

        /**
         * @var $data Collection
         */
        // Todo: try to avoid parsing all columns each time...

        $fieldFactory = new FieldFactory(new Parser(config('admin.fields.types')), $this->modelObject->columns, config('admin.fields.classmap'));
        $this->fields = $fieldFactory->makeFields();

        View::share('fields', $this->fields);

        return $this->fields;
    }

    // Prepares fields for factory
//    protected function prepareFields($data) {
//        $fields = [];
//
//        foreach ($data as $key => $item) {
//            foreach ($this->modelObject->columns as $column) {
//                $fields[$key][$column] = $item->$column;
//            }
//        }
//
//        return $fields;
//    }

    /**
     * @return array
     */
    protected function getSort()
    {
        $sort = array();

        if (Input::has('sort_by')) {
            $sort['column'] = Input::get('sort_by');
            $sort['direction'] = Input::get('direction');
        } else {

            if ($this->modelObject->schema->hasColumn('sort_id')) {
                $sort['column'] = 'sort_id';
            } else {
                $sort['column'] = 'id';
            }

            $sort['direction'] = 'asc';
        }

        return $sort;
    }

    /**
     * @return array
     */
    protected function getRules()
    {
        if (isset($this->options['rules'])) {
            return $this->options['rules'];
        } else {
            if (isset($this->model->rules)) {
                return $this->model->rules;
            }
        }

        return array();
    }

    /**
     * @param $items
     * @return null
     */
    public static function getCurrentModelId($items)
    {
        return (isset($items->id)) ? $items->id : null;
    }

    /**
     * @return array|mixed
     */
    protected function filterInputData()
    {
        if ($this->modelObject->hasGuarded()) {
            $input = Input::all();
            $filtered_input = array();

            foreach ($input as $key => $value) {
                if (in_array($key, $this->modelObject->columns)) {
                    $filtered_input[$key] = $value;
                }
            }

            return $this->except($this->modelObject->options['guarded'], $filtered_input);
        }

        return Input::except('id');
    }

    /**
     * @param $keys
     * @param $values
     * @return mixed
     */
    protected function except($keys, $values)
    {
        $keys = is_array($keys) ? $keys : func_get_args();

        $results = $values;

        array_forget($results, $keys);

        return $results;
    }

    /**
     * @param $data
     * @return array
     */
    protected function handleFiles($data)
    {
        $new_data = array();
        $fields = $this->getFields($data);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

        if (!is_null($fields)) {
            foreach ($fields as $field) {
                if ($this->isFileInput($field->type)) {
                    if (Input::hasFile($field->name)) {
                        $new_data[$field->name] = $this->uploadFile($field->name);
                    } else {
                        unset($data[$field->name]);
                    }
                }
            }
        }

        return array_merge($data, $new_data);
    }

    /**
     * @param $type
     * @return bool
     */
    protected function isFileInput($type)
    {
        return ($type == 'file' || $type == 'image');
    }

    /**
     * This is used for simple upload (no plugins)
     *
     * @param $fieldName
     * @param null $path
     * @return string
     */
    protected function uploadFile($fieldName, $path = null)
    {
        if (!$path) {
            $path = public_path() . '/uploads/';
        }

        $file = Input::file($fieldName);

        if (!file_exists($path)) {
            File::makeDirectory($path);
        }

        $name = uniqid() . '-' . Str::slug($file->getFilename()) . '.' . $file->guessExtension();

        $file->move($path, $name);

        return $name;
    }

    /**
     * @param $modelName
     * @param $id
     * @param $field
     * @return null
     */
    protected function getRelatedFieldOutput($modelName, $id, $field)

    {
        if ($id != 0) {
            $this->handleData($this->model->with($this->modelObject->getRelations())->findOrFail($id));
        } else {
            if (Session::has('_set_relation_on_create_' . $this->modelObject->name)) {
                $relateds = Session::get('_set_relation_on_create_' . $this->modelObject->name);
                $related_ids = array();
                foreach ($relateds as $related) {
                    $related_ids[] = $related['id'];
                }

                $data = $relateds[0]['modelClass']::whereIn('id', $related_ids)->get();

                $this->handleData($data);
            } else {
                return null;
            }
        }

        return $this->fields[$field]->output();
    }

    /**
     * @param $validator
     * @param string $route
     * @return $this
     */
    protected function redirect($validator, $route, $id = null)
    {
        if (Input::has('_standalone')) {
            $routeParams = array('slug' => Input::get('_standalone'));

            if ($id) {
                $routeParams['id'] = $id;
            }

            return Redirect::route($route, $routeParams)

                ->withErrors($validator)
                ->withInput();
        }

        return Redirect::back()->withErrors($validator)->withInput();

    }

    /**
     * @param $data
     * @return \Illuminate\Validation\Validator
     */
    protected function validator($data)
    {
        return Validator::make($data, $this->getRules());
    }

    /**
     * @param $modelName
     * @param null $data
     * @param $sort
     * @return $this
     */
    protected function all($modelName, $data = null, $sort)
    {
        $this->handleData($data);

        return View::make($this->getView('all'))
            ->with('items', $this->data)
            ->with('sort', $sort);
    }
}

1			<?php namespace Mascame\Artificer\Http\Controllers;
2
3			use App;
4			use Auth;
5			use File;
6			use Illuminate\Database\Eloquent\Collection;
7			use Illuminate\Routing\Redirector;
8			use Illuminate\Routing\Router;
9			use Input;
10			use Mascame\Artificer\Fields\Field;
11			use Mascame\Artificer\Fields\FieldFactory;
12			use Mascame\Formality\Factory\Factory;
13			use Mascame\Formality\Parser\Parser;
14			use Mascame\Artificer\Permit\ModelPermit;
15			use Mascame\Formality\Manager\Manager;
16			use Redirect;
17			use Route;
18			use Session;
19			use Validator;
20			use View;
21
22
23			class BaseModelController extends BaseController
24			{
25
26			/**
27			* The Eloquent model instance
28			* @var \Eloquent
29			*/
30			protected $model;
31
32			/**
33			*
34			*/
35			public function __construct()
36			{
37			parent::__construct();
38
39			// Todo: Do Sth with this
40			if (false) {
41			if (! Auth::check() \|\| ! ModelPermit::access()) {
42			App::abort('403', 'Forbidden access');
43			}
44			}
45
46			$this->model = $this->modelObject->model;
47
48			$this->checkPermissions();
49			}
50
51			/**
52			*
53			*/
54			protected function checkPermissions()
55			{
56			$permit = array(
57			'read' => ModelPermit::to('read'),
58			'create' => ModelPermit::to('create'),
59			'update' => ModelPermit::to('update'),
60			'delete' => ModelPermit::to('delete'),
61			);
62
63			ModelPermit::routeAction(Route::currentRouteName());
64
65			View::share('permit', $permit);
66			}
67
68			/**
69			* @param $data
70			*/
71			protected function handleData($data)
72			{
73			$this->data = $data;
74
75			$this->getFields($data);
76			}
77
78			/**
79			* @param $data
80			* @return null
81			*/
82			protected function getFields($data)
			0 ignored issues – show Unused Code introduced 2016-03-29 06:13 UTC by Report Bug Copy Issue Report The parameter `$data` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
83			{
84			if ($this->fields) return $this->fields;
85
86			/**
87			* @var $data Collection
88			*/
89			// Todo: try to avoid parsing all columns each time...
90
91			$fieldFactory = new FieldFactory(new Parser(config('admin.fields.types')), $this->modelObject->columns, config('admin.fields.classmap'));
92			$this->fields = $fieldFactory->makeFields();
93
94			View::share('fields', $this->fields);
95
96			return $this->fields;
97			}
98
99			// Prepares fields for factory
100			// protected function prepareFields($data) {
101			// $fields = [];
102			//
103			// foreach ($data as $key => $item) {
104			// foreach ($this->modelObject->columns as $column) {
105			// $fields[$key][$column] = $item->$column;
106			// }
107			// }
108			//
109			// return $fields;
110			// }
111
112			/**
113			* @return array
114			*/
115			protected function getSort()
116			{
117			$sort = array();
118
119			if (Input::has('sort_by')) {
120			$sort['column'] = Input::get('sort_by');
121			$sort['direction'] = Input::get('direction');
122			} else {
123
124			if ($this->modelObject->schema->hasColumn('sort_id')) {
125			$sort['column'] = 'sort_id';
126			} else {
127			$sort['column'] = 'id';
128			}
129
130			$sort['direction'] = 'asc';
131			}
132
133			return $sort;
134			}
135
136			/**
137			* @return array
138			*/
139			protected function getRules()
140			{
141			if (isset($this->options['rules'])) {
142			return $this->options['rules'];
143			} else {
144			if (isset($this->model->rules)) {
145			return $this->model->rules;
146			}
147			}
148
149			return array();
150			}
151
152			/**
153			* @param $items
154			* @return null
155			*/
156			public static function getCurrentModelId($items)
157			{
158			return (isset($items->id)) ? $items->id : null;
159			}
160
161			/**
162			* @return array\|mixed
163			*/
164			protected function filterInputData()
165			{
166			if ($this->modelObject->hasGuarded()) {
167			$input = Input::all();
168			$filtered_input = array();
169
170			foreach ($input as $key => $value) {
171			if (in_array($key, $this->modelObject->columns)) {
172			$filtered_input[$key] = $value;
173			}
174			}
175
176			return $this->except($this->modelObject->options['guarded'], $filtered_input);
177			}
178
179			return Input::except('id');
180			}
181
182			/**
183			* @param $keys
184			* @param $values
185			* @return mixed
186			*/
187			protected function except($keys, $values)
188			{
189			$keys = is_array($keys) ? $keys : func_get_args();
190
191			$results = $values;
192
193			array_forget($results, $keys);
194
195			return $results;
196			}
197
198			/**
199			* @param $data
200			* @return array
201			*/
202			protected function handleFiles($data)
203			{
204			$new_data = array();
205			$fields = $this->getFields($data);
			0 ignored issues – show Bug introduced 2016-02-25 21:36 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$fields` is correct as `$this->getFields($data)` (which targets `Mascame\Artificer\Http\C...Controller::getFields()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
206
207			if (!is_null($fields)) {
208			foreach ($fields as $field) {
209			if ($this->isFileInput($field->type)) {
210			if (Input::hasFile($field->name)) {
211			$new_data[$field->name] = $this->uploadFile($field->name);
212			} else {
213			unset($data[$field->name]);
214			}
215			}
216			}
217			}
218
219			return array_merge($data, $new_data);
220			}
221
222			/**
223			* @param $type
224			* @return bool
225			*/
226			protected function isFileInput($type)
227			{
228			return ($type == 'file' \|\| $type == 'image');
229			}
230
231			/**
232			* This is used for simple upload (no plugins)
233			*
234			* @param $fieldName
235			* @param null $path
236			* @return string
237			*/
238			protected function uploadFile($fieldName, $path = null)
239			{
240			if (!$path) {
241			$path = public_path() . '/uploads/';
242			}
243
244			$file = Input::file($fieldName);
245
246			if (!file_exists($path)) {
247			File::makeDirectory($path);
248			}
249
250			$name = uniqid() . '-' . Str::slug($file->getFilename()) . '.' . $file->guessExtension();
251
252			$file->move($path, $name);
253
254			return $name;
255			}
256
257			/**
258			* @param $modelName
259			* @param $id
260			* @param $field
261			* @return null
262			*/
263			protected function getRelatedFieldOutput($modelName, $id, $field)
			0 ignored issues – show Unused Code introduced 2016-02-25 21:36 UTC by Report Bug Copy Issue Report The parameter `$modelName` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
264			{
265			if ($id != 0) {
266			$this->handleData($this->model->with($this->modelObject->getRelations())->findOrFail($id));
267			} else {
268			if (Session::has('_set_relation_on_create_' . $this->modelObject->name)) {
269			$relateds = Session::get('_set_relation_on_create_' . $this->modelObject->name);
270			$related_ids = array();
271			foreach ($relateds as $related) {
272			$related_ids[] = $related['id'];
273			}
274
275			$data = $relateds[0]['modelClass']::whereIn('id', $related_ids)->get();
276
277			$this->handleData($data);
278			} else {
279			return null;
280			}
281			}
282
283			return $this->fields[$field]->output();
284			}
285
286			/**
287			* @param $validator
288			* @param string $route
289			* @return $this
290			*/
291			protected function redirect($validator, $route, $id = null)
292			{
293			if (Input::has('_standalone')) {
294			$routeParams = array('slug' => Input::get('_standalone'));
295
296			if ($id) {
297			$routeParams['id'] = $id;
298			}
299
300			return Redirect::route($route, $routeParams)
			0 ignored issues – show Bug introduced 2016-02-25 21:36 UTC by Report Bug Copy Issue Report The method `route()` does not seem to exist on `object<redirect>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
301			->withErrors($validator)
302			->withInput();
303			}
304
305			return Redirect::back()->withErrors($validator)->withInput();
			0 ignored issues – show Bug introduced 2016-02-25 21:36 UTC by Report Bug Copy Issue Report The method `back()` does not seem to exist on `object<redirect>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
306			}
307
308			/**
309			* @param $data
310			* @return \Illuminate\Validation\Validator
311			*/
312			protected function validator($data)
313			{
314			return Validator::make($data, $this->getRules());
315			}
316
317			/**
318			* @param $modelName
319			* @param null $data
320			* @param $sort
321			* @return $this
322			*/
323			protected function all($modelName, $data = null, $sort)
324			{
325			$this->handleData($data);
326
327			return View::make($this->getView('all'))
328			->with('items', $this->data)
329			->with('sort', $sort);
330			}
331			}

marcmascarell / laravel-artificer

Push — dev ( 81bde7...979e1f )

BaseModelController B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

16 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like