NewSingleThreadFormHandler::__construct() - Code Metrics - Miliooo/MilioooMessageBundle - Measure and Improve Code Quality continuously with Scrutinizer

NewSingleThreadFormHandler::__construct() A
last analyzed 2017-02-15 05:46 UTC

↳ Parent: NewSingleThreadFormHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	1

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

<?php

/*
 * This file is part of the MilioooMessageBundle package.
 *
 * (c) Michiel boeckaert <[email protected]>
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Miliooo\Messaging\Form\FormHandler;

use Symfony\Component\Form\FormInterface;
use Symfony\Component\HttpFoundation\Request;
use Miliooo\Messaging\Form\FormModel\NewThreadInterface;
use Miliooo\Messaging\Form\FormModelProcessor\NewThreadFormProcessorInterface;

/**
 * Form handler for single threads.
 *
 * @author Michiel Boeckaert <[email protected]>
 */
class NewSingleThreadFormHandler extends AbstractFormHandler
{
    /**
     * A processor instance.
     *
     * The processor is responsible for processing the valid form model
     *
     * @var NewThreadFormProcessorInterface
     */
    protected $newThreadProcessor;

    /**
     * The request when the form was valid.
     *
     * @var Request
     */
    protected $request;

    /**
     * Constructor.
     *
     * @param Request                         $request   The request the form will process
     * @param NewThreadFormProcessorInterface $processor A new thread form model processor
     */
    public function __construct(Request $request, NewThreadFormProcessorInterface $processor)

    {
        $this->request = $request;

        parent::__construct($request);
        $this->newThreadProcessor = $processor;
    }

    /**
     * Processes the form with the request
     *
     * @param FormInterface $form A form instance
     */
    public function doProcess(FormInterface $form)
    {
        //here we have the valid Form Model. This needs to be an instance of NewThreadInterface.

        $newThreadFormModel = $this->getFormData($form);

        //we update the createdAt to use the datetime when the form was successfully submitted
        $newThreadFormModel->setCreatedAt(new \DateTime('now'));
        $this->processFormModelExtra($newThreadFormModel);

        $this->newThreadProcessor->process($newThreadFormModel);
    }

    /**
     * Gets the form data
     *
     * Helper function to get auto completion
     *
     * @param FormInterface $form
     *
     * @return NewThreadInterface
     *
     * @throws \InvalidArgumentException when form data is not the expected data
     */
    protected function getFormData(FormInterface $form)
    {
        $data = $form->getData();

        if (!$data instanceof NewThreadInterface) {
            throw new \InvalidArgumentException('Form data needs to implement NewThreadInterface');
        }

        return $data;
    }

    /**
     * Helper function if you need to extend this class.
     *
     * Here you have your custom form model which implements the NewThreadInterface.
     * If you need extra processing of this valid form model you can extend this class and overwrite this function.
     *
     * An example...
     * You want to store the ip address from the client.
     * $newThreadFormModel->setIpAddress = $this->request->getClientIp();     *
     *
     * @param NewThreadInterface $newThreadFormModel
     */
    protected function processFormModelExtra(NewThreadInterface $newThreadFormModel)

    {

    }
}


1			<?php
2
3			/*
4			* This file is part of the MilioooMessageBundle package.
5			*
6			* (c) Michiel boeckaert <[email protected]>
7			* This source file is subject to the MIT license that is bundled
8			* with this source code in the file LICENSE.
9			*/
10
11			namespace Miliooo\Messaging\Form\FormHandler;
12
13			use Symfony\Component\Form\FormInterface;
14			use Symfony\Component\HttpFoundation\Request;
15			use Miliooo\Messaging\Form\FormModel\NewThreadInterface;
16			use Miliooo\Messaging\Form\FormModelProcessor\NewThreadFormProcessorInterface;
17
18			/**
19			* Form handler for single threads.
20			*
21			* @author Michiel Boeckaert <[email protected]>
22			*/
23			class NewSingleThreadFormHandler extends AbstractFormHandler
24			{
25			/**
26			* A processor instance.
27			*
28			* The processor is responsible for processing the valid form model
29			*
30			* @var NewThreadFormProcessorInterface
31			*/
32			protected $newThreadProcessor;
33
34			/**
35			* The request when the form was valid.
36			*
37			* @var Request
38			*/
39			protected $request;
40
41			/**
42			* Constructor.
43			*
44			* @param Request $request The request the form will process
45			* @param NewThreadFormProcessorInterface $processor A new thread form model processor
46			*/
47			public function __construct(Request $request, NewThreadFormProcessorInterface $processor)
			0 ignored issues – show Bug introduced 2016-03-28 11:28 UTC by Report Bug Copy Issue Report You have injected the Request via parameter `$request`. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via `getCurrentRequest()`. Loading history...
48			{
49			$this->request = $request;
50
51			parent::__construct($request);
52			$this->newThreadProcessor = $processor;
53			}
54
55			/**
56			* Processes the form with the request
57			*
58			* @param FormInterface $form A form instance
59			*/
60			public function doProcess(FormInterface $form)
61			{
62			//here we have the valid Form Model. This needs to be an instance of NewThreadInterface.
63
64			$newThreadFormModel = $this->getFormData($form);
65
66			//we update the createdAt to use the datetime when the form was successfully submitted
67			$newThreadFormModel->setCreatedAt(new \DateTime('now'));
68			$this->processFormModelExtra($newThreadFormModel);
69
70			$this->newThreadProcessor->process($newThreadFormModel);
71			}
72
73			/**
74			* Gets the form data
75			*
76			* Helper function to get auto completion
77			*
78			* @param FormInterface $form
79			*
80			* @return NewThreadInterface
81			*
82			* @throws \InvalidArgumentException when form data is not the expected data
83			*/
84			protected function getFormData(FormInterface $form)
85			{
86			$data = $form->getData();
87
88			if (!$data instanceof NewThreadInterface) {
89			throw new \InvalidArgumentException('Form data needs to implement NewThreadInterface');
90			}
91
92			return $data;
93			}
94
95			/**
96			* Helper function if you need to extend this class.
97			*
98			* Here you have your custom form model which implements the NewThreadInterface.
99			* If you need extra processing of this valid form model you can extend this class and overwrite this function.
100			*
101			* An example...
102			* You want to store the ip address from the client.
103			* $newThreadFormModel->setIpAddress = $this->request->getClientIp(); *
104			*
105			* @param NewThreadInterface $newThreadFormModel
106			*/
107			protected function processFormModelExtra(NewThreadInterface $newThreadFormModel)
			0 ignored issues – show Unused Code introduced 2016-03-28 11:28 UTC by Report Bug Copy Issue Report The parameter `$newThreadFormModel` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
108			{
109
110			}
111			}
112

Miliooo / MilioooMessageBundle

NewSingleThreadFormHandler::__construct() A last analyzed 2017-02-15 05:46 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

NewSingleThreadFormHandler::__construct() A
last analyzed 2017-02-15 05:46 UTC