ApiController - Code Metrics - taskforcedev/laravel-forum - Measure and Improve Code Quality continuously with Scrutinizer

ApiController B
last analyzed 2016-12-30 14:20 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	264
Duplicated Lines	40.15 %

Coupling/Cohesion

Components	2
Dependencies	9

Importance

Changes	7
Bugs	0	Features	0

Metric	Value
wmc	50
c	7
b	0
f	0
lcom	2
cbo	9
dl	106
loc	264
rs	8.6206

16 Methods

Rating	Name	Duplication	Size	Complexity
A	adminCheck()	0	6	2
A	sanitizeData()	0	12	2
A	forumCategoryStore()	0	21	3
A	forumStore()	0	22	3
A	lockPost()	15	15	4
A	unlockPost()	15	15	4
A	stickyPost()	15	15	4
A	unstickyPost()	15	15	4
A	postExists()	0	9	2
A	forumDelete()	16	16	4
A	forumExists()	0	9	2
A	forumCategoryDelete()	16	16	4
A	forumCategoryExists()	0	9	2
B	forumPostStore()	0	26	3
B	forumReplyStore()	0	26	3
A	postDelete()	14	14	4

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like ApiController often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use ApiController, and based on these observations, apply Extract Interface, too.

<?php namespace Taskforcedev\LaravelForum\Http\Controllers;

use \Auth;
use \Event;
use \Redirect;
use \Schema;

use Illuminate\Http\Request;

use Taskforcedev\LaravelForum\Events\PostCreated;
use Taskforcedev\LaravelForum\Events\PostReply;
use Taskforcedev\LaravelForum\Models\Forum;
use Taskforcedev\LaravelForum\Models\ForumCategory;
use Taskforcedev\LaravelForum\Models\ForumPost;
use Taskforcedev\LaravelForum\Models\ForumReply;

/**
 * Class ApiController
 * @package Taskforcedev\LaravelForum\Http\Controllers
 */
class ApiController extends BaseController
{
    public function forumCategoryStore(Request $request)
    {
        $data = [
            "name" => $request->input('name'),
        ];

        $response = $this->adminCheck();
        if (isset($response)) {
            return $response;
        }

        /* If data invalid return bad request */
        if (!ForumCategory::valid($data)) {
            return response('Bad Request', 400);
        }

        ForumCategory::create($data);

        /* After creating a category lets redirect back to the category list. */
        return redirect()->route('laravel-forum.admin.categories');
    }

    public function forumStore(Request $request)
    {
        $data = [
            "name" => $request->input('name'),
            "description" => $request->input('description'),
            "category_id" => $request->input('category'),
        ];

        $response = $this->adminCheck();
        if (isset($response)) {
            return $response;
        }

        if (!Forum::valid($data)) {
            return response('Bad Request', 400);
        }

        Forum::create($data);

        /* After creating a forum lets redirect back to the forum list. */
        return redirect()->route('laravel-forum.admin.forums');
    }

    public function forumPostStore(Request $request)
    {
        if (!Auth::check()) {
            return response('Unauthorized', 401);
        }

        $user = Auth::user();

        $forum_id = $request->input('forum_id');

        $data = [
            "author_id" => $user->id,
            "title" => $request->input('title'),
            "body" => $this->sanitizeData($request->input('body')),
            "forum_id" => $forum_id
        ];

        if (!ForumPost::valid($data)) {
            return response('Bad Request', 400);
        }

        $post = ForumPost::create($data);

        event(new PostCreated($post, $user));
        return redirect()->route('laravel-forum.view.post', [$forum_id , $post->id]);
    }

    public function forumReplyStore(Request $request)
    {
        if (!Auth::check()) {
            return response('Unauthorized', 401);
        }

        $user = Auth::user();

        $forum_id = $request->input('forum_id');
        $post_id = $request->input('post_id');

        $data = [
            'author_id' => $user->id,
            'body' => $this->sanitizeData($request->input('body')),
            'post_id' => $post_id,
        ];

        if (!ForumReply::valid($data)) {
            return redirect()->route('laravel-forum.view.post', [$forum_id, $post_id]);
        }

        $reply = ForumReply::create($data);

        event(new PostReply($reply, $user));
        return redirect()->route('laravel-forum.view.post', [$forum_id, $post_id]);
    }

    private function adminCheck()
    {
        if (!$this->canCreateForums()) {
            return response('Unauthorised', 401);
        }
    }

    private function sanitizeData($data)
    {
        /* Sanitize post input */
        $removals = [
            '/<script\b[^>]*>/',
            '/<\/script\b[^>]*>/'
        ];
        foreach ($removals as $r) {
            $data = preg_replace($r, '', $data);
        }
        return $data;
    }

    public function lockPost(Request $request, $id)
    {
        if (!$this->canAdministrate() && !$this->canModerate()) {
            return response('Unauthorised', 401);
        }

        $post = $this->postExists($id);
        if (!$post) {
            return response('Post not found', 404);
        }

        $post->locked = 1;
        $post->save();
        return response('Post Locked', 200);
    }

    public function unlockPost(Request $request, $id)
    {
        if (!$this->canAdministrate() && !$this->canModerate()) {
            return response('Unauthorised', 401);
        }

        $post = $this->postExists($id);
        if (!$post) {
            return response('Post not found', 404);
        }

        $post->locked = 0;
        $post->save();
        return response('Post Unlocked', 200);
    }

    public function stickyPost(Request $request, $id)
    {
        if (!$this->canAdministrate() && !$this->canModerate()) {
            return response('Unauthorised', 401);
        }

        $post = $this->postExists($id);
        if (!$post) {
            return response('Post not found', 404);
        }

        $post->sticky = 1;
        $post->save();
        return response('Post Unlocked', 200);
    }

    public function unstickyPost(Request $request, $id)
    {
        if (!$this->canAdministrate() && !$this->canModerate()) {
            return response('Unauthorised', 401);
        }

        $post = $this->postExists($id);
        if (!$post) {
            return response('Post not found', 404);
        }

        $post->sticky = 0;
        $post->save();
        return response('Post Unlocked', 200);
    }

    private function postExists($post_id)
    {
        try {
            $post = ForumPost::where('id', $post_id)->firstOrFail();
            return $post;
        } catch (\Exception $e) {
            return false;
        }
    }

    public function postDelete($forum_id, $post_id)
    {
        if (!$this->canAdministrate() && !$this->canModerate()) {
            return response('Unauthorised', 401);
        }

        $post = $this->postExists($post_id);
        if (!$post) {
            return response('Post not found', 404);
        }

        $post->delete();
        return response('Post Deleted', 200);
    }

    public function forumDelete(Request $request)
    {
        if (!$this->canAdministrate() && !$this->canModerate()) {
            return response('Unauthorised', 401);
        }

        $forum_id = $request->input('forum_id');

        $forum = $this->forumExists($forum_id);
        if (!$forum) {
            return response('Forum not found', 404);
        }

        $forum->delete();
        return response('Forum Deleted', 200);
    }

    private function forumExists($id)
    {
        try {
            $forum = Forum::where('id', $id)->firstOrFail();
            return $forum;
        } catch (\Exception $e) {
            return false;
        }
    }

    public function forumCategoryDelete(Request $request)
    {
        if (!$this->canAdministrate() && !$this->canModerate()) {
            return response('Unauthorised', 401);
        }

        $cat_id = $request->input('category_id');

        $cat = $this->forumCategoryExists($cat_id);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        if (!$cat) {
            return response('Forum Category not found', 404);
        }

        $cat->delete();
        return response('Forum Category Deleted', 200);
    }

    private function forumCategoryExists(Request $request, $id)
    {
        try {
            $cat = ForumCategory::where('id', $id)->firstOrFail();
            return $cat;
        } catch (\Exception $e) {
            return false;
        }
    }
}


1		<?php namespace Taskforcedev\LaravelForum\Http\Controllers;
2
3		use \Auth;
4		use \Event;
5		use \Redirect;
6		use \Schema;
7
8		use Illuminate\Http\Request;
9
10		use Taskforcedev\LaravelForum\Events\PostCreated;
11		use Taskforcedev\LaravelForum\Events\PostReply;
12		use Taskforcedev\LaravelForum\Models\Forum;
13		use Taskforcedev\LaravelForum\Models\ForumCategory;
14		use Taskforcedev\LaravelForum\Models\ForumPost;
15		use Taskforcedev\LaravelForum\Models\ForumReply;
16
17		/**
18		* Class ApiController
19		* @package Taskforcedev\LaravelForum\Http\Controllers
20		*/
21		class ApiController extends BaseController
22		{
23		public function forumCategoryStore(Request $request)
24		{
25		$data = [
26		"name" => $request->input('name'),
27		];
28
29		$response = $this->adminCheck();
30		if (isset($response)) {
31		return $response;
32		}
33
34		/* If data invalid return bad request */
35		if (!ForumCategory::valid($data)) {
36		return response('Bad Request', 400);
37		}
38
39		ForumCategory::create($data);
40
41		/* After creating a category lets redirect back to the category list. */
42		return redirect()->route('laravel-forum.admin.categories');
43		}
44
45		public function forumStore(Request $request)
46		{
47		$data = [
48		"name" => $request->input('name'),
49		"description" => $request->input('description'),
50		"category_id" => $request->input('category'),
51		];
52
53		$response = $this->adminCheck();
54		if (isset($response)) {
55		return $response;
56		}
57
58		if (!Forum::valid($data)) {
59		return response('Bad Request', 400);
60		}
61
62		Forum::create($data);
63
64		/* After creating a forum lets redirect back to the forum list. */
65		return redirect()->route('laravel-forum.admin.forums');
66		}
67
68		public function forumPostStore(Request $request)
69		{
70		if (!Auth::check()) {
71		return response('Unauthorized', 401);
72		}
73
74		$user = Auth::user();
75
76		$forum_id = $request->input('forum_id');
77
78		$data = [
79		"author_id" => $user->id,
80		"title" => $request->input('title'),
81		"body" => $this->sanitizeData($request->input('body')),
82		"forum_id" => $forum_id
83		];
84
85		if (!ForumPost::valid($data)) {
86		return response('Bad Request', 400);
87		}
88
89		$post = ForumPost::create($data);
90
91		event(new PostCreated($post, $user));
92		return redirect()->route('laravel-forum.view.post', [$forum_id , $post->id]);
93		}
94
95		public function forumReplyStore(Request $request)
96		{
97		if (!Auth::check()) {
98		return response('Unauthorized', 401);
99		}
100
101		$user = Auth::user();
102
103		$forum_id = $request->input('forum_id');
104		$post_id = $request->input('post_id');
105
106		$data = [
107		'author_id' => $user->id,
108		'body' => $this->sanitizeData($request->input('body')),
109		'post_id' => $post_id,
110		];
111
112		if (!ForumReply::valid($data)) {
113		return redirect()->route('laravel-forum.view.post', [$forum_id, $post_id]);
114		}
115
116		$reply = ForumReply::create($data);
117
118		event(new PostReply($reply, $user));
119		return redirect()->route('laravel-forum.view.post', [$forum_id, $post_id]);
120		}
121
122		private function adminCheck()
123		{
124		if (!$this->canCreateForums()) {
125		return response('Unauthorised', 401);
126		}
127		}
128
129		private function sanitizeData($data)
130		{
131		/* Sanitize post input */
132		$removals = [
133		'/<script\b[^>]*>/',
134		'/<\/script\b[^>]*>/'
135		];
136		foreach ($removals as $r) {
137		$data = preg_replace($r, '', $data);
138		}
139		return $data;
140		}
141
142	View Code Duplication	public function lockPost(Request $request, $id)
143		{
144		if (!$this->canAdministrate() && !$this->canModerate()) {
145		return response('Unauthorised', 401);
146		}
147
148		$post = $this->postExists($id);
149		if (!$post) {
150		return response('Post not found', 404);
151		}
152
153		$post->locked = 1;
154		$post->save();
155		return response('Post Locked', 200);
156		}
157
158	View Code Duplication	public function unlockPost(Request $request, $id)
159		{
160		if (!$this->canAdministrate() && !$this->canModerate()) {
161		return response('Unauthorised', 401);
162		}
163
164		$post = $this->postExists($id);
165		if (!$post) {
166		return response('Post not found', 404);
167		}
168
169		$post->locked = 0;
170		$post->save();
171		return response('Post Unlocked', 200);
172		}
173
174	View Code Duplication	public function stickyPost(Request $request, $id)
175		{
176		if (!$this->canAdministrate() && !$this->canModerate()) {
177		return response('Unauthorised', 401);
178		}
179
180		$post = $this->postExists($id);
181		if (!$post) {
182		return response('Post not found', 404);
183		}
184
185		$post->sticky = 1;
186		$post->save();
187		return response('Post Unlocked', 200);
188		}
189
190	View Code Duplication	public function unstickyPost(Request $request, $id)
191		{
192		if (!$this->canAdministrate() && !$this->canModerate()) {
193		return response('Unauthorised', 401);
194		}
195
196		$post = $this->postExists($id);
197		if (!$post) {
198		return response('Post not found', 404);
199		}
200
201		$post->sticky = 0;
202		$post->save();
203		return response('Post Unlocked', 200);
204		}
205
206		private function postExists($post_id)
207		{
208		try {
209		$post = ForumPost::where('id', $post_id)->firstOrFail();
210		return $post;
211		} catch (\Exception $e) {
212		return false;
213		}
214		}
215
216	View Code Duplication	public function postDelete($forum_id, $post_id)
217		{
218		if (!$this->canAdministrate() && !$this->canModerate()) {
219		return response('Unauthorised', 401);
220		}
221
222		$post = $this->postExists($post_id);
223		if (!$post) {
224		return response('Post not found', 404);
225		}
226
227		$post->delete();
228		return response('Post Deleted', 200);
229		}
230
231	View Code Duplication	public function forumDelete(Request $request)
232		{
233		if (!$this->canAdministrate() && !$this->canModerate()) {
234		return response('Unauthorised', 401);
235		}
236
237		$forum_id = $request->input('forum_id');
238
239		$forum = $this->forumExists($forum_id);
240		if (!$forum) {
241		return response('Forum not found', 404);
242		}
243
244		$forum->delete();
245		return response('Forum Deleted', 200);
246		}
247
248		private function forumExists($id)
249		{
250		try {
251		$forum = Forum::where('id', $id)->firstOrFail();
252		return $forum;
253		} catch (\Exception $e) {
254		return false;
255		}
256		}
257
258	View Code Duplication	public function forumCategoryDelete(Request $request)
259		{
260		if (!$this->canAdministrate() && !$this->canModerate()) {
261		return response('Unauthorised', 401);
262		}
263
264		$cat_id = $request->input('category_id');
265
266		$cat = $this->forumCategoryExists($cat_id);
		0 ignored issues – show Bug introduced 2016-12-28 09:35 UTC by Report Bug Copy Issue Report The call to `forumCategoryExists()` misses a required argument `$id`. This check looks for function calls that miss required arguments. Loading history... Documentation introduced 2016-12-28 09:35 UTC by Report Bug Copy Issue Report `$cat_id` is of type `string\|array`, but the function expects a `object<Illuminate\Http\Request>`. 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...
267		if (!$cat) {
268		return response('Forum Category not found', 404);
269		}
270
271		$cat->delete();
272		return response('Forum Category Deleted', 200);
273		}
274
275		private function forumCategoryExists(Request $request, $id)
276		{
277		try {
278		$cat = ForumCategory::where('id', $id)->firstOrFail();
279		return $cat;
280		} catch (\Exception $e) {
281		return false;
282		}
283		}
284		}
285

taskforcedev / laravel-forum

ApiController B last analyzed 2016-12-30 14:20 UTC