CommentController::sortBranchComments() - Code Metrics - Inspection of "Fixed tests" - emsa16/comment - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 3daffa...5c6602 )

by Emil

created 2018-05-10 18:27 UTC

CommentController::sortBranchComments() B

↳ Parent: CommentController

Complexity

Conditions	5
Paths	5

Size

Total Lines	22
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	5

Importance

Changes

Metric	Value
dl	0
loc	22
ccs	14
cts	14
cp	1
rs	8.6737
c	0
b	0
f	0
cc	5
eloc	16
nc	5
nop	2
crap	5

<?php

namespace Emsa\Comment;

use \Anax\DI\InjectionAwareInterface;
use \Anax\DI\InjectionAwareTrait;
use \LRC\Form\ModelForm as Modelform;

/**
 * A controller for the comment system.
 */
class CommentController implements InjectionAwareInterface
{
    use InjectionAwareTrait;



    /**
     * @var \LRC\Repository\SoftDbRepository  Comment repository.
     */
    private $comments;



    /**
     * Configuration.
     */
    public function init()
    {
        $commentRepository = $this->di->manager->createRepository(Comment::class, [
            'db' => $this->di->db,
            'type' => 'db-soft',
            'table' => 'rv1_Comment'
        ]);
        $this->comments = $commentRepository;
        return $commentRepository;
    }



    public function showComments($postid)
    {
        $loggedInUser = $this->di->userController->getLoggedInUserId();

        $newForm = new ModelForm('new-comment-form', Comment::class);

        if ($this->di->request->getMethod() == 'POST' && $loggedInUser) {
            $comment = $newForm->populateModel();
            $comment->user = $loggedInUser;
            $newForm->validate();
            if ($newForm->isValid()) {
                $this->comments->save($comment);
                $this->di->response->redirect("comment/$postid#{$comment->id}");
            }
        }

        $comments = $this->getComments($postid, $loggedInUser);
        $sortBy = $this->sortBy();

        $viewData = [
            "comments" => $this->buildCommentTree($comments, $sortBy),
            "textfilter" => $this->di->textfilter,
            "postid" => $postid,
            "action" => "",
            "actionID" => "",
            "newForm" => $newForm,
            "isLoggedIn" => $loggedInUser
        ];

        $this->di->view->add("comment/comment-section", $viewData, "main", 2);
    }



    public function replyComment($postid)
    {
        $loggedInUser = $this->di->userController->getLoggedInUserId();
        if (is_null($loggedInUser)) {
            $this->di->response->redirect("comment/$postid");
        }

        $actionID = (int)$this->di->request->getGet("id");
        if (!$this->comments->findSoft('id', $actionID)) {
            $this->di->response->redirect("comment/$postid");
        }

        $replyForm = new ModelForm('reply-comment-form', Comment::class);

        if ($this->di->request->getMethod() == 'POST') {
            $comment = $replyForm->populateModel();
            $comment->user = $loggedInUser;
            $replyForm->validate();
            if ($replyForm->isValid()) {
                $this->comments->save($comment);
                $this->di->response->redirect("comment/$postid#{$comment->id}");
            }
        }

        $comments = $this->getComments($postid, $loggedInUser);
        $sortBy = $this->sortBy();

        $viewData = [
            "comments" => $this->buildCommentTree($comments, $sortBy),
            "textfilter" => $this->di->textfilter,
            "postid" => $postid,
            "action" => "reply",
            "actionID" => $actionID,
            "newForm" => new ModelForm('new-comment-form', Comment::class),
            "replyForm" => $replyForm,
            "isLoggedIn" => $loggedInUser
        ];

        $this->di->view->add("comment/comment-section", $viewData, "main", 2);
    }



    public function editComment($postid)
    {
        $actionID = (int)$this->di->request->getGet("id");
        $currentComment = $this->comments->findSoft('id', $actionID);
        if (!$currentComment) {
            $this->di->response->redirect("comment/$postid");
        }

        $loggedInUser = $this->di->userController->getLoggedInUserId();
        if ($loggedInUser != $currentComment->user && !$this->di->session->has("admin")) {

            $this->di->response->redirect("comment/$postid");
        }

        $editForm = new ModelForm('edit-comment-form', $currentComment);

        if ($this->di->request->getMethod() == 'POST') {
            $comment = $editForm->populateModel(null, ['id', 'post_id', 'parent_id']);
            //Prevent edited column from being set to NULL
            unset($comment->edited);
            $editForm->validate();
            if ($editForm->isValid()) {
                $this->comments->save($comment);
                $this->di->response->redirect("comment/$postid#{$comment->id}");
            }
        }

        $comments = $this->getComments($postid, $loggedInUser);
        $sortBy = $this->sortBy();

        $viewData = [
            "comments" => $this->buildCommentTree($comments, $sortBy),
            "textfilter" => $this->di->textfilter,
            "postid" => $postid,
            "action" => "edit",
            "actionID" => $actionID,
            "newForm" => new ModelForm('new-comment-form', Comment::class),
            "editForm" => $editForm,
            "isLoggedIn" => $loggedInUser
        ];

        $this->di->view->add("comment/comment-section", $viewData, "main", 2);
    }



    public function deleteComment($postid)
    {
        $actionID = (int)$this->di->request->getGet("id");
        $currentComment = $this->comments->findSoft('id', $actionID);
        if (!$currentComment) {
            $this->di->response->redirect("comment/$postid");
        }

        $loggedInUser = $this->di->userController->getLoggedInUserId();
        if ($loggedInUser != $currentComment->user && !$this->di->session->has("admin")) {

            $this->di->response->redirect("comment/$postid");
        }

        if ($this->di->request->getMethod() == 'POST') {
            if ($this->di->request->getPost('delete') == 'delete') {
                $this->comments->deleteSoft($currentComment);
            }
            $this->di->response->redirect("comment/$postid#{$currentComment->id}");
        }

        $comments = $this->getComments($postid, $loggedInUser);
        $sortBy = $this->sortBy();

        $viewData = [
            "comments" => $this->buildCommentTree($comments, $sortBy),
            "textfilter" => $this->di->textfilter,
            "postid" => $postid,
            "action" => "delete",
            "actionID" => $actionID,
            "newForm" => new ModelForm('new-comment-form', Comment::class),
            "isLoggedIn" => $loggedInUser
        ];

        $this->di->view->add("comment/comment-section", $viewData, "main", 2);
    }



    public function voteComment($postid)
    {
        if (is_null($this->di->userController->getLoggedInUserId())) {
            $this->di->response->redirect("comment/$postid");
        }

        $actionID = (int)$this->di->request->getGet("id");
        $currentComment = $this->comments->findSoft('id', $actionID);
        if (!$currentComment) {
            $this->di->response->redirect("comment/$postid");
        }

        if ($this->di->request->getPost("upvote")) {
            $currentComment->upvote += 1;
        } elseif ($this->di->request->getPost("downvote")) {
            $currentComment->downvote += 1;
        }
        $this->comments->save($currentComment);
        $this->di->response->redirect("comment/$postid#{$currentComment->id}");
    }



    public function getComments($postid, $loggedInUser)
    {
        $comments = $this->comments->getAll('post_id = ?', [$postid]);

        foreach ($comments as $comment) {
            $comment->isUserOwner = ($loggedInUser == $comment->userObject->id);
            $comment->isUserAdmin = $this->di->session->has("admin");
        }

        return $comments;
    }



    public function sortBy()
    {
        $sortRequest = $this->di->request->getGet("sort");
        $sortRules = ["best", "old", "new"];
        return in_array($sortRequest, $sortRules) ? $sortRequest : "best";
    }



    public function buildCommentTree(array &$elements, $sortBy, $parentId = 0)
    {
        $branch = array();

        foreach ($elements as $element) {
            if ($element->parent_id == $parentId) {
                $element->children = $this->buildCommentTree($elements, $sortBy, $element->id);
                // $children = $this->buildCommentTree($elements, $sortBy, $element->id);
                // if (!empty($children)) {
                //     $element->children = $children;
                // }
                $branch[$element->id] = $element;
            }
        }
        return $this->sortBranchComments($branch, $sortBy);
    }



    public function sortBranchComments(array &$branch, $sortBy = "best")
    {
        $sortOrder = SORT_DESC;
        $sortArray = array();
        foreach ($branch as $key => $comment) {
            switch ($sortBy) {
                case 'old':
                    $sortOrder = SORT_ASC;
                    //Intentional fall through
                case 'new':
                    $sortArray[$key] = $comment->created;
                    break;
                case 'best':
                    //Intentional fall through
                default:
                    $sortArray[$key] = ($comment->upvote - $comment->downvote);
                    break;
            }
        }
        array_multisort($sortArray, $sortOrder, $branch);
        return $branch;
    }
}


1			<?php
2
3			namespace Emsa\Comment;
4
5			use \Anax\DI\InjectionAwareInterface;
6			use \Anax\DI\InjectionAwareTrait;
7			use \LRC\Form\ModelForm as Modelform;
8
9			/**
10			* A controller for the comment system.
11			*/
12			class CommentController implements InjectionAwareInterface
13			{
14			use InjectionAwareTrait;
15
16
17
18			/**
19			* @var \LRC\Repository\SoftDbRepository Comment repository.
20			*/
21			private $comments;
22
23
24
25			/**
26			* Configuration.
27			*/
28	2		public function init()
29			{
30	2		$commentRepository = $this->di->manager->createRepository(Comment::class, [
31	2		'db' => $this->di->db,
32	2		'type' => 'db-soft',
33	2		'table' => 'rv1_Comment'
34			]);
35	2		$this->comments = $commentRepository;
36	2		return $commentRepository;
37			}
38
39
40
41			public function showComments($postid)
42			{
43			$loggedInUser = $this->di->userController->getLoggedInUserId();
44
45			$newForm = new ModelForm('new-comment-form', Comment::class);
46
47			if ($this->di->request->getMethod() == 'POST' && $loggedInUser) {
48			$comment = $newForm->populateModel();
49			$comment->user = $loggedInUser;
50			$newForm->validate();
51			if ($newForm->isValid()) {
52			$this->comments->save($comment);
53			$this->di->response->redirect("comment/$postid#{$comment->id}");
54			}
55			}
56
57			$comments = $this->getComments($postid, $loggedInUser);
58			$sortBy = $this->sortBy();
59
60			$viewData = [
61			"comments" => $this->buildCommentTree($comments, $sortBy),
62			"textfilter" => $this->di->textfilter,
63			"postid" => $postid,
64			"action" => "",
65			"actionID" => "",
66			"newForm" => $newForm,
67			"isLoggedIn" => $loggedInUser
68			];
69
70			$this->di->view->add("comment/comment-section", $viewData, "main", 2);
71			}
72
73
74
75			public function replyComment($postid)
76			{
77			$loggedInUser = $this->di->userController->getLoggedInUserId();
78			if (is_null($loggedInUser)) {
79			$this->di->response->redirect("comment/$postid");
80			}
81
82			$actionID = (int)$this->di->request->getGet("id");
83			if (!$this->comments->findSoft('id', $actionID)) {
84			$this->di->response->redirect("comment/$postid");
85			}
86
87			$replyForm = new ModelForm('reply-comment-form', Comment::class);
88
89			if ($this->di->request->getMethod() == 'POST') {
90			$comment = $replyForm->populateModel();
91			$comment->user = $loggedInUser;
92			$replyForm->validate();
93			if ($replyForm->isValid()) {
94			$this->comments->save($comment);
95			$this->di->response->redirect("comment/$postid#{$comment->id}");
96			}
97			}
98
99			$comments = $this->getComments($postid, $loggedInUser);
100			$sortBy = $this->sortBy();
101
102			$viewData = [
103			"comments" => $this->buildCommentTree($comments, $sortBy),
104			"textfilter" => $this->di->textfilter,
105			"postid" => $postid,
106			"action" => "reply",
107			"actionID" => $actionID,
108			"newForm" => new ModelForm('new-comment-form', Comment::class),
109			"replyForm" => $replyForm,
110			"isLoggedIn" => $loggedInUser
111			];
112
113			$this->di->view->add("comment/comment-section", $viewData, "main", 2);
114			}
115
116
117
118			public function editComment($postid)
119			{
120			$actionID = (int)$this->di->request->getGet("id");
121			$currentComment = $this->comments->findSoft('id', $actionID);
122			if (!$currentComment) {
123			$this->di->response->redirect("comment/$postid");
124			}
125
126			$loggedInUser = $this->di->userController->getLoggedInUserId();
127		View Code Duplication	if ($loggedInUser != $currentComment->user && !$this->di->session->has("admin")) {
			0 ignored issues – show Duplication introduced 2018-04-26 15:42 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...
128			$this->di->response->redirect("comment/$postid");
129			}
130
131			$editForm = new ModelForm('edit-comment-form', $currentComment);
132
133			if ($this->di->request->getMethod() == 'POST') {
134			$comment = $editForm->populateModel(null, ['id', 'post_id', 'parent_id']);
135			//Prevent edited column from being set to NULL
136			unset($comment->edited);
137			$editForm->validate();
138			if ($editForm->isValid()) {
139			$this->comments->save($comment);
140			$this->di->response->redirect("comment/$postid#{$comment->id}");
141			}
142			}
143
144			$comments = $this->getComments($postid, $loggedInUser);
145			$sortBy = $this->sortBy();
146
147			$viewData = [
148			"comments" => $this->buildCommentTree($comments, $sortBy),
149			"textfilter" => $this->di->textfilter,
150			"postid" => $postid,
151			"action" => "edit",
152			"actionID" => $actionID,
153			"newForm" => new ModelForm('new-comment-form', Comment::class),
154			"editForm" => $editForm,
155			"isLoggedIn" => $loggedInUser
156			];
157
158			$this->di->view->add("comment/comment-section", $viewData, "main", 2);
159			}
160
161
162
163			public function deleteComment($postid)
164			{
165			$actionID = (int)$this->di->request->getGet("id");
166			$currentComment = $this->comments->findSoft('id', $actionID);
167			if (!$currentComment) {
168			$this->di->response->redirect("comment/$postid");
169			}
170
171			$loggedInUser = $this->di->userController->getLoggedInUserId();
172		View Code Duplication	if ($loggedInUser != $currentComment->user && !$this->di->session->has("admin")) {
			0 ignored issues – show Duplication introduced 2018-04-26 15:42 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...
173			$this->di->response->redirect("comment/$postid");
174			}
175
176			if ($this->di->request->getMethod() == 'POST') {
177			if ($this->di->request->getPost('delete') == 'delete') {
178			$this->comments->deleteSoft($currentComment);
179			}
180			$this->di->response->redirect("comment/$postid#{$currentComment->id}");
181			}
182
183			$comments = $this->getComments($postid, $loggedInUser);
184			$sortBy = $this->sortBy();
185
186			$viewData = [
187			"comments" => $this->buildCommentTree($comments, $sortBy),
188			"textfilter" => $this->di->textfilter,
189			"postid" => $postid,
190			"action" => "delete",
191			"actionID" => $actionID,
192			"newForm" => new ModelForm('new-comment-form', Comment::class),
193			"isLoggedIn" => $loggedInUser
194			];
195
196			$this->di->view->add("comment/comment-section", $viewData, "main", 2);
197			}
198
199
200
201			public function voteComment($postid)
202			{
203			if (is_null($this->di->userController->getLoggedInUserId())) {
204			$this->di->response->redirect("comment/$postid");
205			}
206
207			$actionID = (int)$this->di->request->getGet("id");
208			$currentComment = $this->comments->findSoft('id', $actionID);
209			if (!$currentComment) {
210			$this->di->response->redirect("comment/$postid");
211			}
212
213			if ($this->di->request->getPost("upvote")) {
214			$currentComment->upvote += 1;
215			} elseif ($this->di->request->getPost("downvote")) {
216			$currentComment->downvote += 1;
217			}
218			$this->comments->save($currentComment);
219			$this->di->response->redirect("comment/$postid#{$currentComment->id}");
220			}
221
222
223
224	1		public function getComments($postid, $loggedInUser)
225			{
226	1		$comments = $this->comments->getAll('post_id = ?', [$postid]);
227
228	1		foreach ($comments as $comment) {
229	1		$comment->isUserOwner = ($loggedInUser == $comment->userObject->id);
230	1		$comment->isUserAdmin = $this->di->session->has("admin");
231			}
232
233	1		return $comments;
234			}
235
236
237
238	1		public function sortBy()
239			{
240	1		$sortRequest = $this->di->request->getGet("sort");
241	1		$sortRules = ["best", "old", "new"];
242	1		return in_array($sortRequest, $sortRules) ? $sortRequest : "best";
243			}
244
245
246
247	1		public function buildCommentTree(array &$elements, $sortBy, $parentId = 0)
248			{
249	1		$branch = array();
250
251	1		foreach ($elements as $element) {
252	1		if ($element->parent_id == $parentId) {
253	1		$element->children = $this->buildCommentTree($elements, $sortBy, $element->id);
254			// $children = $this->buildCommentTree($elements, $sortBy, $element->id);
255			// if (!empty($children)) {
256			// $element->children = $children;
257			// }
258	1		$branch[$element->id] = $element;
259			}
260			}
261	1		return $this->sortBranchComments($branch, $sortBy);
262			}
263
264
265
266	2		public function sortBranchComments(array &$branch, $sortBy = "best")
267			{
268	2		$sortOrder = SORT_DESC;
269	2		$sortArray = array();
270	2		foreach ($branch as $key => $comment) {
271			switch ($sortBy) {
272	2		case 'old':
273	1		$sortOrder = SORT_ASC;
274			//Intentional fall through
275	2		case 'new':
276	1		$sortArray[$key] = $comment->created;
277	1		break;
278	2		case 'best':
279			//Intentional fall through
280			default:
281	2		$sortArray[$key] = ($comment->upvote - $comment->downvote);
282	2		break;
283			}
284			}
285	2		array_multisort($sortArray, $sortOrder, $branch);
286	2		return $branch;
287			}
288			}
289

emsa16 / comment

Push — master ( 3daffa...5c6602 )

CommentController::sortBranchComments() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like