FeedbackAdminController::getTranslator() - Code Metrics - Inspection of "Feature/improve translations" - he8us/FeedbackBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#1)

by Cedric

created 2016-10-23 20:23 UTC

FeedbackAdminController::getTranslator() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php
/**
 * This file is part of the he8us/feedback package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace He8us\FeedbackBundle\Controller;

use He8us\FeedbackBundle\Entity\Feedback;
use He8us\FeedbackBundle\Service\FeedbackService;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Session\Session;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\Translation\DataCollectorTranslator;
use Symfony\Component\Translation\TranslatorInterface;

/**
 * Class FeedbackAdminController
 *
 * @package He8us\FeedbackBundle\Controller
 * @author Cedric Michaux <[email protected]>
 */
class FeedbackAdminController extends Controller
{
    /**
     * @param string $status
     *
     * @return Response
     */
    public function indexAction(string $status): Response
    {
        if ($status !== Feedback::STATUS_DONE && $status !== Feedback::STATUS_READ) {
            $status = Feedback::STATUS_NONE;
        }

        return $this->render("He8usFeedbackBundle:FeedbackAdmin:index.html.twig", [
            'status'    => $status,
            'feedbacks' => $this->getFeedbackService()->findByStatus($status),
        ]);
    }

    /**
     * @return FeedbackService
     */
    private function getFeedbackService():FeedbackService
    {
        return $this->get('he8us_feedback.feedback_service');
    }

    /**
     * @param Request $request
     * @param         $id
     *
     * @return JsonResponse
     */
    public function deleteAction(Request $request, $id): JsonResponse
    {
        $feedback = $this->getFeedback($request, $id);

        $this->getFeedbackService()->delete($feedback);

        return JsonResponse::create(['status' => true]);
    }

    /**
     * @param Request $request
     * @param         $id
     *
     * @return Feedback
     */
    private function getFeedback(Request $request, $id): Feedback
    {
        $this->validateRequest($request);

        $feedback = $this->getFeedbackService()->findById($id);

        $this->validateFeedback($feedback);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        return $feedback;
    }

    /**
     * @param Request $request
     *
     * @throws NotFoundHttpException
     */
    private function validateRequest(Request $request)
    {
        if (!$request->isXmlHttpRequest()) {
            throw new NotFoundHttpException($this->getTranslator()->trans('page.not_found'));
        }
    }

    /**
     * @param $feedback
     *
     * @throws NotFoundHttpException
     */
    private function validateFeedback(Feedback $feedback = null)
    {
        if (!$feedback) {
            throw new NotFoundHttpException($this->getTranslator()->trans('feedback.not_found'));
        }
    }

    /**
     * @param Request $request
     * @param         $id
     * @param string  $type
     *
     * @return JsonResponse
     */
    public function markAsAction(Request $request, $id, string $type = "read"): JsonResponse
    {
        $feedback = $this->getFeedback($request, $id);

        $feedback->setStatus($this->getStatus($type));

        $this->getFeedbackService()->save($feedback);

        return JsonResponse::create(['status' => true]);
    }

    /**
     * @param $type
     *
     * @return int
     */
    private function getStatus(string $type)
    {
        if ($type == 'read') {
            return Feedback::STATUS_READ;
        }

        if ($type == 'done') {
            return Feedback::STATUS_DONE;
        }

        return Feedback::STATUS_NONE;
    }

    /**
     * @param Request  $request
     * @param Feedback $id
     *
     * @return Response
     */
    public function replyAction(Request $request, Feedback $id): Response
    {
        $data = [];
        $data['message'] = $id;
        $data['toemail'] = $this->container->getParameter('system_email');

        if ($request->isMethod('POST')) {
            $this->sendMessage($request, $id);
        }
        return $this->render('He8usFeedbackBundle:FeedbackAdmin:reply.html.twig', $data);
    }

    /**
     * @param Request  $request
     * @param Feedback $feedback
     */
    public function sendMessage(Request $request, Feedback $feedback): void
    {
        $form = $request->get('message');
        $mailer = $this->container->get('mailer');
        $message = $mailer->createMessage()
            ->setSubject($form['subject'])
            ->setFrom($this->container->getParameter('system_email'))
            ->setTo($feedback->getEmail())
            ->setBody(
                $this->container->get('twig')->render($this->container->getParameter('feedback_reply_mail_layout'),
                    ['form' => $form, 'feedback' => $feedback])
            )
            ->setContentType('text/html');
        $mailer->send($message);

        /** @var Session $session */
        $session = $this->container->get('session');
        $session->getFlashBag()->add('success', $this->getTranslator()->trans("feedback.message.sent_success"));

        return true;
    }

    /**
     * @return TranslatorInterface
     */
    private function getTranslator():TranslatorInterface
    {
        return $this->get('translator');
    }
}


1			<?php
2			/**
3			* This file is part of the he8us/feedback package.
4			*
5			* For the full copyright and license information, please view the LICENSE
6			* file that was distributed with this source code.
7			*/
8
9			namespace He8us\FeedbackBundle\Controller;
10
11			use He8us\FeedbackBundle\Entity\Feedback;
12			use He8us\FeedbackBundle\Service\FeedbackService;
13			use Symfony\Bundle\FrameworkBundle\Controller\Controller;
14			use Symfony\Component\HttpFoundation\JsonResponse;
15			use Symfony\Component\HttpFoundation\Request;
16			use Symfony\Component\HttpFoundation\Response;
17			use Symfony\Component\HttpFoundation\Session\Session;
18			use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
19			use Symfony\Component\Translation\DataCollectorTranslator;
20			use Symfony\Component\Translation\TranslatorInterface;
21
22			/**
23			* Class FeedbackAdminController
24			*
25			* @package He8us\FeedbackBundle\Controller
26			* @author Cedric Michaux <[email protected]>
27			*/
28			class FeedbackAdminController extends Controller
29			{
30			/**
31			* @param string $status
32			*
33			* @return Response
34			*/
35			public function indexAction(string $status): Response
36			{
37			if ($status !== Feedback::STATUS_DONE && $status !== Feedback::STATUS_READ) {
38			$status = Feedback::STATUS_NONE;
39			}
40
41			return $this->render("He8usFeedbackBundle:FeedbackAdmin:index.html.twig", [
42			'status' => $status,
43			'feedbacks' => $this->getFeedbackService()->findByStatus($status),
44			]);
45			}
46
47			/**
48			* @return FeedbackService
49			*/
50			private function getFeedbackService():FeedbackService
51			{
52			return $this->get('he8us_feedback.feedback_service');
53			}
54
55			/**
56			* @param Request $request
57			* @param $id
58			*
59			* @return JsonResponse
60			*/
61			public function deleteAction(Request $request, $id): JsonResponse
62			{
63			$feedback = $this->getFeedback($request, $id);
64
65			$this->getFeedbackService()->delete($feedback);
66
67			return JsonResponse::create(['status' => true]);
68			}
69
70			/**
71			* @param Request $request
72			* @param $id
73			*
74			* @return Feedback
75			*/
76			private function getFeedback(Request $request, $id): Feedback
77			{
78			$this->validateRequest($request);
79
80			$feedback = $this->getFeedbackService()->findById($id);
81
82			$this->validateFeedback($feedback);
			1 ignored issue – show Bug introduced 2016-10-23 20:22 UTC by Report Bug Copy Issue Report It seems like `$feedback` defined by `$this->getFeedbackService()->findById($id)` on line `80` can also be of type `object`; however, `He8us\FeedbackBundle\Con...ler::validateFeedback()` does only seem to accept `null\|object<He8us\FeedbackBundle\Entity\Feedback>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
83
84			return $feedback;
85			}
86
87			/**
88			* @param Request $request
89			*
90			* @throws NotFoundHttpException
91			*/
92			private function validateRequest(Request $request)
93			{
94			if (!$request->isXmlHttpRequest()) {
95			throw new NotFoundHttpException($this->getTranslator()->trans('page.not_found'));
96			}
97			}
98
99			/**
100			* @param $feedback
101			*
102			* @throws NotFoundHttpException
103			*/
104			private function validateFeedback(Feedback $feedback = null)
105			{
106			if (!$feedback) {
107			throw new NotFoundHttpException($this->getTranslator()->trans('feedback.not_found'));
108			}
109			}
110
111			/**
112			* @param Request $request
113			* @param $id
114			* @param string $type
115			*
116			* @return JsonResponse
117			*/
118			public function markAsAction(Request $request, $id, string $type = "read"): JsonResponse
119			{
120			$feedback = $this->getFeedback($request, $id);
121
122			$feedback->setStatus($this->getStatus($type));
123
124			$this->getFeedbackService()->save($feedback);
125
126			return JsonResponse::create(['status' => true]);
127			}
128
129			/**
130			* @param $type
131			*
132			* @return int
133			*/
134			private function getStatus(string $type)
135			{
136			if ($type == 'read') {
137			return Feedback::STATUS_READ;
138			}
139
140			if ($type == 'done') {
141			return Feedback::STATUS_DONE;
142			}
143
144			return Feedback::STATUS_NONE;
145			}
146
147			/**
148			* @param Request $request
149			* @param Feedback $id
150			*
151			* @return Response
152			*/
153			public function replyAction(Request $request, Feedback $id): Response
154			{
155			$data = [];
156			$data['message'] = $id;
157			$data['toemail'] = $this->container->getParameter('system_email');
158
159			if ($request->isMethod('POST')) {
160			$this->sendMessage($request, $id);
161			}
162			return $this->render('He8usFeedbackBundle:FeedbackAdmin:reply.html.twig', $data);
163			}
164
165			/**
166			* @param Request $request
167			* @param Feedback $feedback
168			*/
169			public function sendMessage(Request $request, Feedback $feedback): void
170			{
171			$form = $request->get('message');
172			$mailer = $this->container->get('mailer');
173			$message = $mailer->createMessage()
174			->setSubject($form['subject'])
175			->setFrom($this->container->getParameter('system_email'))
176			->setTo($feedback->getEmail())
177			->setBody(
178			$this->container->get('twig')->render($this->container->getParameter('feedback_reply_mail_layout'),
179			['form' => $form, 'feedback' => $feedback])
180			)
181			->setContentType('text/html');
182			$mailer->send($message);
183
184			/** @var Session $session */
185			$session = $this->container->get('session');
186			$session->getFlashBag()->add('success', $this->getTranslator()->trans("feedback.message.sent_success"));
187
188			return true;
189			}
190
191			/**
192			* @return TranslatorInterface
193			*/
194			private function getTranslator():TranslatorInterface
195			{
196			return $this->get('translator');
197			}
198			}
199

he8us / FeedbackBundle

GitHub Access Token became invalid

Pull Request — master (#1)

FeedbackAdminController::getTranslator() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like