OrganizerController::organizerBySlug() - Code Metrics - Inspection of "Merge branch 'master' of https://github.com/davide..." - davide-casiraghi/laravel-events-calendar - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ba992d...dc755b )

by Davide

created 2019-04-28 20:27 UTC

OrganizerController::organizerBySlug() A

↳ Parent: OrganizerController

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace App\Http\Controllers;

use App\User;
use Validator;
use App\Organizer;
use Illuminate\Support\Str;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Auth;

class OrganizerController extends Controller
{
    /* Restrict the access to this resource just to logged in users except show view */
    public function __construct()
    {
        $this->middleware('auth', ['except' => ['show', 'organizerBySlug']]);
    }

    /***************************************************************************/

    /**
     * Display a listing of the resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function index(Request $request)
    {
        // To show just the organizers created by the the user - If admin or super admin is set to null show all the organizers
        $authorUserId = ($this->getLoggedAuthorId()) ? $this->getLoggedAuthorId() : null; // if is 0 (super admin or admin) it's setted to null to avoid include it in the query

        $searchKeywords = $request->input('keywords');

        if ($searchKeywords) {
            $organizers = DB::table('organizers')
                ->when($authorUserId, function ($query, $authorUserId) {
                    return $query->where('created_by', $authorUserId);
                })
                ->when($searchKeywords, function ($query, $searchKeywords) {
                    return $query->where('name', $searchKeywords)->orWhere('name', 'like', '%'.$searchKeywords.'%');
                })
                ->paginate(20);
        } else {
            $organizers = DB::table('organizers')
            ->when($authorUserId, function ($query, $authorUserId) {
                return $query->where('created_by', $authorUserId);
            })
            ->paginate(20);
        }

        return view('organizers.index', compact('organizers'))
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->with('i', (request()->input('page', 1) - 1) * 20)
            ->with('searchKeywords', $searchKeywords);
    }

    /***************************************************************************/

    /**
     * Show the form for creating a new resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function create()
    {
        $users = User::pluck('name', 'id');
        $authorUserId = $this->getLoggedUser();

        return view('organizers.create')
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->with('users', $users)
            ->with('authorUserId', $authorUserId);
    }

    /***************************************************************************/

    /**
     * Store a newly created resource in storage.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\Response
     */
    public function store(Request $request)

    {
        // Validate form datas
        $validator = $this->organizersValidator($request);
        if ($validator->fails()) {
            return back()->withErrors($validator)->withInput();
        }

        $organizer = new Organizer();
        $this->saveOnDb($request, $organizer);

        return redirect()->route('organizers.index')
                        ->with('success', __('messages.organizer_added_successfully'));
    }

    /***************************************************************************/

    /**
     * Display the specified resource.
     *
     * @param  \App\Organizer  $organizer
     * @return \Illuminate\Http\Response
     */
    public function show(Organizer $organizer)
    {
        return view('organizers.show', compact('organizer'));
    }

    /***************************************************************************/

    /**
     * Show the form for editing the specified resource.
     *
     * @param  \App\Organizer  $organizer
     * @return \Illuminate\Http\Response
     */
    public function edit(Organizer $organizer)

    {
        if (Auth::user()->id == $organizer->created_by || Auth::user()->isSuperAdmin() || Auth::user()->isAdmin()) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            $authorUserId = $this->getLoggedAuthorId();
            $users = User::pluck('name', 'id');

            return view('organizers.edit', compact('organizer'))
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                ->with('users', $users)
                ->with('authorUserId', $authorUserId);
        } else {
            return redirect()->route('home')->with('message', __('auth.not_allowed_to_access'));
        }
    }

    /***************************************************************************/

    /**
     * Update the specified resource in storage.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \App\Organizer  $organizer
     * @return \Illuminate\Http\Response
     */
    public function update(Request $request, Organizer $organizer)
    {
        // Validate form datas
        $validator = $this->organizersValidator($request);
        if ($validator->fails()) {
            return back()->withErrors($validator)->withInput();
        }

        $this->saveOnDb($request, $organizer);

        return redirect()->route('organizers.index')
                        ->with('success', __('messages.organizer_updated_successfully'));
    }

    /***************************************************************************/

    /**
     * Remove the specified resource from storage.
     *
     * @param  \App\Organizer  $organizer
     * @return \Illuminate\Http\Response
     */
    public function destroy(Organizer $organizer)
    {
        $organizer->delete();

        return redirect()->route('organizers.index')
                        ->with('success', __('messages.organizer_deleted_successfully'));
    }

    /***************************************************************************/

    /**
     * Save the record on DB.
     * @param  \Illuminate\Http\Request  $request
     * @param  \App\Organizer  $organizer
     * @return void
     */
    public function saveOnDb($request, $organizer)
    {
        $organizer->name = $request->get('name');
        $organizer->description = clean($request->get('description'));
        $organizer->website = $request->get('website');
        $organizer->email = $request->get('email');
        $organizer->phone = $request->get('phone');

        $organizer->created_by = \Auth::user()->id;
        if (! $organizer->slug) {
            $organizer->slug = Str::slug($organizer->name, '-').'-'.rand(10000, 100000);
        }

        $organizer->save();
    }

    /***************************************************************************/

    /**
     * Open a modal in the event view when create organizer is clicked.
     *
     * @return view
     */
    public function modal()
    {
        return view('organizers.modal');
    }

    /***************************************************************************/

    /**
     * Store a newly created organizer from the create event view modal in storage.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\Response
     */
    public function storeFromModal(Request $request)

    {
        $organizer = new Organizer();
        request()->validate([
            'name' => 'required',
        ]);

        $this->saveOnDb($request, $organizer);

        return redirect()->back()->with('message', 'Organizer created');
        //return redirect()->back()->with('message', __('auth.successfully_registered'));
        //return true;
    }

    /***************************************************************************/

    /**
     * Return the organizer by SLUG. (eg. http://websitename.com/organizer/xxxxx).
     *
     * @param  string $slug
     * @return \Illuminate\Http\Response
     */
    public function organizerBySlug($slug)
    {
        $organizer = Organizer::
                where('slug', $slug)
                ->first();

        return $this->show($organizer);
    }

    /***************************************************************************/

    /**
     * Return the validator with all the defined constraint.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Validation\Validator
     */
    public function organizersValidator($request)

    {
        $rules = [
            'name' => 'required',
            'email' => 'required|email',
            'website' => 'nullable|url',
        ];
        $messages = [
            'website.url' => 'The website link is invalid. It should start with https://',
        ];

        $validator = Validator::make($request->all(), $rules, $messages);

        return $validator;
    }
}


Push — master ( ba992d...dc755b )

OrganizerController::organizerBySlug() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1		<?php
2
3		namespace App\Http\Controllers;
4
5		use App\User;
6		use Validator;
7		use App\Organizer;
8		use Illuminate\Support\Str;
9		use Illuminate\Http\Request;
10		use Illuminate\Support\Facades\DB;
11		use Illuminate\Support\Facades\Auth;
12
13		class OrganizerController extends Controller
14		{
15		/* Restrict the access to this resource just to logged in users except show view */
16		public function __construct()
17		{
18		$this->middleware('auth', ['except' => ['show', 'organizerBySlug']]);
19		}
20
21		/***************************************************************************/
22
23		/**
24		* Display a listing of the resource.
25		*
26		* @return \Illuminate\Http\Response
27		*/
28		public function index(Request $request)
29		{
30		// To show just the organizers created by the the user - If admin or super admin is set to null show all the organizers
31		$authorUserId = ($this->getLoggedAuthorId()) ? $this->getLoggedAuthorId() : null; // if is 0 (super admin or admin) it's setted to null to avoid include it in the query
32
33		$searchKeywords = $request->input('keywords');
34
35		if ($searchKeywords) {
36		$organizers = DB::table('organizers')
37		->when($authorUserId, function ($query, $authorUserId) {
38		return $query->where('created_by', $authorUserId);
39		})
40		->when($searchKeywords, function ($query, $searchKeywords) {
41		return $query->where('name', $searchKeywords)->orWhere('name', 'like', '%'.$searchKeywords.'%');
42		})
43		->paginate(20);
44		} else {
45		$organizers = DB::table('organizers')
46		->when($authorUserId, function ($query, $authorUserId) {
47		return $query->where('created_by', $authorUserId);
48		})
49		->paginate(20);
50		}
51
52		return view('organizers.index', compact('organizers'))
		0 ignored issues – show Bug introduced 2019-04-28 20:34 UTC by Report Bug Copy Issue Report The method `with` does only exist in `Illuminate\View\View`, but not in `Illuminate\Contracts\View\Factory`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
53		->with('i', (request()->input('page', 1) - 1) * 20)
54		->with('searchKeywords', $searchKeywords);
55		}
56
57		/***************************************************************************/
58
59		/**
60		* Show the form for creating a new resource.
61		*
62		* @return \Illuminate\Http\Response
63		*/
64		public function create()
65		{
66		$users = User::pluck('name', 'id');
67		$authorUserId = $this->getLoggedUser();
68
69		return view('organizers.create')
		0 ignored issues – show Bug introduced 2019-04-28 20:34 UTC by Report Bug Copy Issue Report The method `with` does only exist in `Illuminate\View\View`, but not in `Illuminate\Contracts\View\Factory`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
70		->with('users', $users)
71		->with('authorUserId', $authorUserId);
72		}
73
74		/***************************************************************************/
75
76		/**
77		* Store a newly created resource in storage.
78		*
79		* @param \Illuminate\Http\Request $request
80		* @return \Illuminate\Http\Response
81		*/
82	View Code Duplication	public function store(Request $request)
		0 ignored issues – show Duplication introduced 2019-04-28 20:34 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
83		{
84		// Validate form datas
85		$validator = $this->organizersValidator($request);
86		if ($validator->fails()) {
87		return back()->withErrors($validator)->withInput();
88		}
89
90		$organizer = new Organizer();
91		$this->saveOnDb($request, $organizer);
92
93		return redirect()->route('organizers.index')
94		->with('success', __('messages.organizer_added_successfully'));
95		}
96
97		/***************************************************************************/
98
99		/**
100		* Display the specified resource.
101		*
102		* @param \App\Organizer $organizer
103		* @return \Illuminate\Http\Response
104		*/
105		public function show(Organizer $organizer)
106		{
107		return view('organizers.show', compact('organizer'));
108		}
109
110		/***************************************************************************/
111
112		/**
113		* Show the form for editing the specified resource.
114		*
115		* @param \App\Organizer $organizer
116		* @return \Illuminate\Http\Response
117		*/
118	View Code Duplication	public function edit(Organizer $organizer)
		0 ignored issues – show Duplication introduced 2019-04-28 20:34 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
119		{
120		if (Auth::user()->id == $organizer->created_by \|\| Auth::user()->isSuperAdmin() \|\| Auth::user()->isAdmin()) {
		0 ignored issues – show Bug introduced 2019-04-28 20:34 UTC by Report Bug Copy Issue Report Accessing `id` on the interface `Illuminate\Contracts\Auth\Authenticatable` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history... Bug introduced 2019-04-28 20:34 UTC by Report Bug Copy Issue Report The method `isSuperAdmin()` does not seem to exist on `object<Illuminate\Contracts\Auth\Authenticatable>`. 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... Bug introduced 2019-04-28 20:34 UTC by Report Bug Copy Issue Report The method `isAdmin()` does not seem to exist on `object<Illuminate\Contracts\Auth\Authenticatable>`. 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...
121		$authorUserId = $this->getLoggedAuthorId();
122		$users = User::pluck('name', 'id');
123
124		return view('organizers.edit', compact('organizer'))
		0 ignored issues – show Bug introduced 2019-04-28 20:34 UTC by Report Bug Copy Issue Report The method `with` does only exist in `Illuminate\View\View`, but not in `Illuminate\Contracts\View\Factory`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
125		->with('users', $users)
126		->with('authorUserId', $authorUserId);
127		} else {
128		return redirect()->route('home')->with('message', __('auth.not_allowed_to_access'));
129		}
130		}
131
132		/***************************************************************************/
133
134		/**
135		* Update the specified resource in storage.
136		*
137		* @param \Illuminate\Http\Request $request
138		* @param \App\Organizer $organizer
139		* @return \Illuminate\Http\Response
140		*/
141		public function update(Request $request, Organizer $organizer)
142		{
143		// Validate form datas
144		$validator = $this->organizersValidator($request);
145		if ($validator->fails()) {
146		return back()->withErrors($validator)->withInput();
147		}
148
149		$this->saveOnDb($request, $organizer);
150
151		return redirect()->route('organizers.index')
152		->with('success', __('messages.organizer_updated_successfully'));
153		}
154
155		/***************************************************************************/
156
157		/**
158		* Remove the specified resource from storage.
159		*
160		* @param \App\Organizer $organizer
161		* @return \Illuminate\Http\Response
162		*/
163		public function destroy(Organizer $organizer)
164		{
165		$organizer->delete();
166
167		return redirect()->route('organizers.index')
168		->with('success', __('messages.organizer_deleted_successfully'));
169		}
170
171		/***************************************************************************/
172
173		/**
174		* Save the record on DB.
175		* @param \Illuminate\Http\Request $request
176		* @param \App\Organizer $organizer
177		* @return void
178		*/
179		public function saveOnDb($request, $organizer)
180		{
181		$organizer->name = $request->get('name');
182		$organizer->description = clean($request->get('description'));
183		$organizer->website = $request->get('website');
184		$organizer->email = $request->get('email');
185		$organizer->phone = $request->get('phone');
186
187		$organizer->created_by = \Auth::user()->id;
188		if (! $organizer->slug) {
189		$organizer->slug = Str::slug($organizer->name, '-').'-'.rand(10000, 100000);
190		}
191
192		$organizer->save();
193		}
194
195		/***************************************************************************/
196
197		/**
198		* Open a modal in the event view when create organizer is clicked.
199		*
200		* @return view
201		*/
202		public function modal()
203		{
204		return view('organizers.modal');
205		}
206
207		/***************************************************************************/
208
209		/**
210		* Store a newly created organizer from the create event view modal in storage.
211		*
212		* @param \Illuminate\Http\Request $request
213		* @return \Illuminate\Http\Response
214		*/
215	View Code Duplication	public function storeFromModal(Request $request)
		0 ignored issues – show Duplication introduced 2019-04-28 20:34 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
216		{
217		$organizer = new Organizer();
218		request()->validate([
219		'name' => 'required',
220		]);
221
222		$this->saveOnDb($request, $organizer);
223
224		return redirect()->back()->with('message', 'Organizer created');
225		//return redirect()->back()->with('message', __('auth.successfully_registered'));
226		//return true;
227		}
228
229		/***************************************************************************/
230
231		/**
232		* Return the organizer by SLUG. (eg. http://websitename.com/organizer/xxxxx).
233		*
234		* @param string $slug
235		* @return \Illuminate\Http\Response
236		*/
237		public function organizerBySlug($slug)
238		{
239		$organizer = Organizer::
240		where('slug', $slug)
241		->first();
242
243		return $this->show($organizer);
244		}
245
246		/***************************************************************************/
247
248		/**
249		* Return the validator with all the defined constraint.
250		*
251		* @param \Illuminate\Http\Request $request
252		* @return \Illuminate\Validation\Validator
253		*/
254	View Code Duplication	public function organizersValidator($request)
		0 ignored issues – show Duplication introduced 2019-04-28 20:34 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
255		{
256		$rules = [
257		'name' => 'required',
258		'email' => 'required\|email',
259		'website' => 'nullable\|url',
260		];
261		$messages = [
262		'website.url' => 'The website link is invalid. It should start with https://',
263		];
264
265		$validator = Validator::make($request->all(), $rules, $messages);
266
267		return $validator;
268		}
269		}
270

davide-casiraghi / laravel-events-calendar

Push — master ( ba992d...dc755b )

OrganizerController::organizerBySlug() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like