FormTrait::getCurrentStep() - Code Metrics - PiedWeb/Conversation - Measure and Improve Code Quality continuously with Scrutinizer

FormTrait::getCurrentStep() A
last analyzed 2020-12-09 18:34 UTC

↳ Parent: FormTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace PiedWeb\ConversationBundle\Form;

use Doctrine\Bundle\DoctrineBundle\Registry;
use PiedWeb\ConversationBundle\Entity\MessageInterface as Message;
use Symfony\Bundle\FrameworkBundle\Routing\Router;
use Symfony\Component\Form\Extension\Core\Type\FormType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\FormFactory;
use Symfony\Component\HttpFoundation\IpUtils;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
use Symfony\Component\Security\Core\Security;
use Symfony\Component\Validator\Constraints\Email;
use Symfony\Component\Validator\Constraints\Length;
use Symfony\Component\Validator\Constraints\NotBlank;
use Symfony\Contracts\Translation\TranslatorInterface;
use Twig\Environment as Twig;

trait FormTrait
{
    /**
     * Permit to convert integer step to text string for a better readability.
     *
     * @var array
     */
    protected static $step = [
        1 => 'One',
        2 => 'Two',
        3 => 'Three',
        4 => 'Four',
    ];

    /** @var string */
    protected $successMessage = 'conversation.send.success';

    /** @var Request */
    protected $request;

    /** @var \Doctrine\Bundle\DoctrineBundle\Registry */
    protected $doctrine;

    /** @var Twig */
    protected $twig;

    /** @var TokenStorageInterface */
    protected $security;

    /** @var FormFactory */
    protected $formFactory;

    /** @var TranslatorInterface */
    protected $translator;

    /** @var Router */
    protected $router;

    /** @var int */
    protected $currentStep;

    /** @var int */
    protected $messageId;

    /** @var string */
    protected $messageEntity;

    /** @var Message */
    protected $message;

    public function __construct(
        string $messageEntity,
        Request $request,
        Registry $doctrine,
        TokenStorageInterface $security,
        FormFactory $formFactory,
        Twig $twig,
        Router $router,
        TranslatorInterface $translator
    ) {
        $this->request = $request;
        $this->doctrine = $doctrine;
        $this->security = $security;
        $this->formFactory = $formFactory;
        $this->twig = $twig;
        $this->router = $router;
        $this->translator = $translator;
        $this->messageEntity = $messageEntity;
    }

    /**
     * Initiate Message Entity (or load data from previous message)
     * and return form builder instance.
     */
    protected function initForm(): FormBuilderInterface
    {
        if (1 === $this->getStep()) {
            $this->message = new $this->messageEntity(); // todo, permit to configure it
            $this->message->setAuthorIpRaw($this->request->getClientIp() ?? '');
            $this->message->setReferring($this->getReferring());
        } else {
            $this->message = $this->doctrine->getRepository($this->messageEntity)->find($this->getId());
            if (!$this->message) {
                throw new NotFoundHttpException('An error occured during the validation ('.$this->getId().')');
            }
            // add a security check ? Comparing current IP and previous one
            // IPUtils::checkIp($request->getClientIp()), $this->message->getAuthorIpRaw())
            // sinon, passer l'id dans la session plutôt que dans la requête
        }

        $form = $this->formFactory->createBuilder(FormType::class, $this->message, ['csrf_protection' => false]);

        $form->setAction($this->router->generate('piedweb_cms_conversation', [
            'type' => $this->getType(),
            'referring' => $this->getReferring(),
            'id' => $this->getId(),
            'step' => $this->getStep(),
        ], UrlGeneratorInterface::ABSOLUTE_URL));

        return $form;
    }

    public function getCurrentStep(): FormBuilderInterface
    {
        $currentStepMethod = 'getStep'.self::$step[$this->getStep()];

        return $this->$currentStepMethod();
    }

    abstract protected function getStepOne(): FormBuilderInterface;

    /**
     * Return rendered response (success or error).
     */
    public function validCurrentStep($form): string
    {
        $currentStepMethod = 'valid'.self::$step[$this->getStep()];
        if (method_exists($this, $currentStepMethod)) {
            return  $this->$currentStepMethod($form);
        }

        return $this->defaultStepValidator($form);
    }

    protected function validStepOne($form)
    {
        return $this->defaultStepValidator($form);
    }

    protected function defaultStepValidator($form): string
    {
        if ($form->isValid()) {
            $this->sanitizeConversation();
            $this->getDoctrine()->getManager()->persist($this->message);
            $this->getDoctrine()->getManager()->flush();
            $this->messageId = $this->message->getId();

            if (false !== $this->getNextStepFunctionName()) {
                $this->incrementStep();

                return $this->showForm($this->getCurrentStep()->getForm());
                /*
                return $this->redirectToRoute('piedweb_cms_conversation', [
                    'type' => $this->getType(),
                    'id' => $this->message->getId(),
                    'step' => $this->getStep() + 1,
                ]);*/
            }
            //$form = $form->createView();

            return $this->showSuccess();
        }

        // return the form with errors highlighted
        return $this->showForm($form);
    }

    public function getShowFormTemplate()
    {
        $template = '@PiedWebConversation/_'
            .$this->getType().$this->getReferring().'Step'.$this->getStep().'.html.twig';

        if (!$this->twig->getLoader()->exists($template)) {
            $template = '@PiedWebConversation/_'.$this->getType().'Step'.$this->getStep().'.html.twig';
        }

        if (!$this->twig->getLoader()->exists($template)) {
            $template = '@PiedWebConversation/_conversation.html.twig';
        }

        return $template;
    }

    public function showForm($form): string
    {
        return $this->twig->render($this->getShowFormTemplate(), [
            'conversation' => $form->createView(),
        ]);
    }

    protected function showSuccess(): string
    {
        return $this->twig->render('@PiedWebConversation/_alert.html.twig', [
            'message' => $this->translator->trans($this->successMessage),
            'context' => 'success',
        ]);
    }

    protected function getNextStepFunctionName()
    {
        $getFormMethod = 'getStep'.self::$step[$this->getNextStep()];
        if (!method_exists($this, $getFormMethod)) {
            return false;
        }

        return $getFormMethod;
    }

    protected function getNextStep()
    {
        return $this->getStep() + 1;
    }

    protected function sanitizeConversation()
    {
        $this->message->setContent(
            htmlspecialchars($this->message->getContent())
        );
    }

    protected function getStep()
    {
        if (null !== $this->currentStep) {
            return $this->currentStep;
        }

        return $this->currentStep = $this->request->query->getInt('step', 1);
    }

    protected function incrementStep()
    {
        //$this->request->set('step', $this->getStep()+1)
        ++$this->currentStep;
    }

    protected function getId()
    {
        return $this->messageId ?? $this->request->query->getInt('id', 0);
    }

    protected function getReferring()
    {
        return $this->request->get('referring');
    }

    protected function getType()
    {
        return $this->request->get('type');
    }

    protected function getDoctrine()
    {
        return $this->doctrine;
    }

    protected function getAuthorNameConstraints()
    {
        return [
            new NotBlank(),
            new Length([
                'max' => 100,
                'maxMessage' => 'conversation.name.long',
            ]),
        ];
    }

    protected function getAuthorEmailConstraints()
    {
        return [
            new NotBlank(),
            new Email([
                'message' => 'user.email.invalid',
                'mode' => 'strict',
            ]),
        ];
    }
}


1			<?php
2
3			namespace PiedWeb\ConversationBundle\Form;
4
5			use Doctrine\Bundle\DoctrineBundle\Registry;
6			use PiedWeb\ConversationBundle\Entity\MessageInterface as Message;
7			use Symfony\Bundle\FrameworkBundle\Routing\Router;
8			use Symfony\Component\Form\Extension\Core\Type\FormType;
9			use Symfony\Component\Form\FormBuilderInterface;
10			use Symfony\Component\Form\FormFactory;
11			use Symfony\Component\HttpFoundation\IpUtils;
12			use Symfony\Component\HttpFoundation\Request;
13			use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
14			use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
15			use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
16			use Symfony\Component\Security\Core\Security;
17			use Symfony\Component\Validator\Constraints\Email;
18			use Symfony\Component\Validator\Constraints\Length;
19			use Symfony\Component\Validator\Constraints\NotBlank;
20			use Symfony\Contracts\Translation\TranslatorInterface;
21			use Twig\Environment as Twig;
22
23			trait FormTrait
24			{
25			/**
26			* Permit to convert integer step to text string for a better readability.
27			*
28			* @var array
29			*/
30			protected static $step = [
31			1 => 'One',
32			2 => 'Two',
33			3 => 'Three',
34			4 => 'Four',
35			];
36
37			/** @var string */
38			protected $successMessage = 'conversation.send.success';
39
40			/** @var Request */
41			protected $request;
42
43			/** @var \Doctrine\Bundle\DoctrineBundle\Registry */
44			protected $doctrine;
45
46			/** @var Twig */
47			protected $twig;
48
49			/** @var TokenStorageInterface */
50			protected $security;
51
52			/** @var FormFactory */
53			protected $formFactory;
54
55			/** @var TranslatorInterface */
56			protected $translator;
57
58			/** @var Router */
59			protected $router;
60
61			/** @var int */
62			protected $currentStep;
63
64			/** @var int */
65			protected $messageId;
66
67			/** @var string */
68			protected $messageEntity;
69
70			/** @var Message */
71			protected $message;
72
73			public function __construct(
74			string $messageEntity,
75			Request $request,
76			Registry $doctrine,
77			TokenStorageInterface $security,
78			FormFactory $formFactory,
79			Twig $twig,
80			Router $router,
81			TranslatorInterface $translator
82			) {
83			$this->request = $request;
84			$this->doctrine = $doctrine;
85			$this->security = $security;
86			$this->formFactory = $formFactory;
87			$this->twig = $twig;
88			$this->router = $router;
89			$this->translator = $translator;
90			$this->messageEntity = $messageEntity;
91			}
92
93			/**
94			* Initiate Message Entity (or load data from previous message)
95			* and return form builder instance.
96			*/
97			protected function initForm(): FormBuilderInterface
98			{
99			if (1 === $this->getStep()) {
100			$this->message = new $this->messageEntity(); // todo, permit to configure it
101			$this->message->setAuthorIpRaw($this->request->getClientIp() ?? '');
102			$this->message->setReferring($this->getReferring());
103			} else {
104			$this->message = $this->doctrine->getRepository($this->messageEntity)->find($this->getId());
105			if (!$this->message) {
106			throw new NotFoundHttpException('An error occured during the validation ('.$this->getId().')');
107			}
108			// add a security check ? Comparing current IP and previous one
109			// IPUtils::checkIp($request->getClientIp()), $this->message->getAuthorIpRaw())
110			// sinon, passer l'id dans la session plutôt que dans la requête
111			}
112
113			$form = $this->formFactory->createBuilder(FormType::class, $this->message, ['csrf_protection' => false]);
114
115			$form->setAction($this->router->generate('piedweb_cms_conversation', [
116			'type' => $this->getType(),
117			'referring' => $this->getReferring(),
118			'id' => $this->getId(),
119			'step' => $this->getStep(),
120			], UrlGeneratorInterface::ABSOLUTE_URL));
121
122			return $form;
123			}
124
125			public function getCurrentStep(): FormBuilderInterface
126			{
127			$currentStepMethod = 'getStep'.self::$step[$this->getStep()];
128
129			return $this->$currentStepMethod();
130			}
131
132			abstract protected function getStepOne(): FormBuilderInterface;
133
134			/**
135			* Return rendered response (success or error).
136			*/
137			public function validCurrentStep($form): string
138			{
139			$currentStepMethod = 'valid'.self::$step[$this->getStep()];
140			if (method_exists($this, $currentStepMethod)) {
141			return $this->$currentStepMethod($form);
142			}
143
144			return $this->defaultStepValidator($form);
145			}
146
147			protected function validStepOne($form)
148			{
149			return $this->defaultStepValidator($form);
150			}
151
152			protected function defaultStepValidator($form): string
153			{
154			if ($form->isValid()) {
155			$this->sanitizeConversation();
156			$this->getDoctrine()->getManager()->persist($this->message);
157			$this->getDoctrine()->getManager()->flush();
158			$this->messageId = $this->message->getId();
159
160			if (false !== $this->getNextStepFunctionName()) {
161			$this->incrementStep();
162
163			return $this->showForm($this->getCurrentStep()->getForm());
164			/*
165			return $this->redirectToRoute('piedweb_cms_conversation', [
166			'type' => $this->getType(),
167			'id' => $this->message->getId(),
168			'step' => $this->getStep() + 1,
169			]);*/
170			}
171			//$form = $form->createView();
172
173			return $this->showSuccess();
174			}
175
176			// return the form with errors highlighted
177			return $this->showForm($form);
178			}
179
180			public function getShowFormTemplate()
181			{
182			$template = '@PiedWebConversation/_'
183			.$this->getType().$this->getReferring().'Step'.$this->getStep().'.html.twig';
184
185			if (!$this->twig->getLoader()->exists($template)) {
186			$template = '@PiedWebConversation/_'.$this->getType().'Step'.$this->getStep().'.html.twig';
187			}
188
189			if (!$this->twig->getLoader()->exists($template)) {
190			$template = '@PiedWebConversation/_conversation.html.twig';
191			}
192
193			return $template;
194			}
195
196			public function showForm($form): string
197			{
198			return $this->twig->render($this->getShowFormTemplate(), [
199			'conversation' => $form->createView(),
200			]);
201			}
202
203			protected function showSuccess(): string
204			{
205			return $this->twig->render('@PiedWebConversation/_alert.html.twig', [
206			'message' => $this->translator->trans($this->successMessage),
207			'context' => 'success',
208			]);
209			}
210
211			protected function getNextStepFunctionName()
212			{
213			$getFormMethod = 'getStep'.self::$step[$this->getNextStep()];
214			if (!method_exists($this, $getFormMethod)) {
215			return false;
216			}
217
218			return $getFormMethod;
219			}
220
221			protected function getNextStep()
222			{
223			return $this->getStep() + 1;
224			}
225
226			protected function sanitizeConversation()
227			{
228			$this->message->setContent(
229			htmlspecialchars($this->message->getContent())
230			);
231			}
232
233			protected function getStep()
234			{
235			if (null !== $this->currentStep) {
236			return $this->currentStep;
237			}
238
239			return $this->currentStep = $this->request->query->getInt('step', 1);
240			}
241
242			protected function incrementStep()
243			{
244			//$this->request->set('step', $this->getStep()+1)
245			++$this->currentStep;
246			}
247
248			protected function getId()
249			{
250			return $this->messageId ?? $this->request->query->getInt('id', 0);
251			}
252
253			protected function getReferring()
254			{
255			return $this->request->get('referring');
256			}
257
258			protected function getType()
259			{
260			return $this->request->get('type');
261			}
262
263			protected function getDoctrine()
264			{
265			return $this->doctrine;
266			}
267
268			protected function getAuthorNameConstraints()
269			{
270			return [
271			new NotBlank(),
272			new Length([
273			'max' => 100,
274			'maxMessage' => 'conversation.name.long',
275			]),
276			];
277			}
278
279			protected function getAuthorEmailConstraints()
280			{
281			return [
282			new NotBlank(),
283			new Email([
284			'message' => 'user.email.invalid',
285			'mode' => 'strict',
286			]),
287			];
288			}
289			}
290

PiedWeb / Conversation

FormTrait::getCurrentStep() A last analyzed 2020-12-09 18:34 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

FormTrait::getCurrentStep() A
last analyzed 2020-12-09 18:34 UTC