Miliooo\Messaging\Form\FormHandler\NewSingleThreadFormHandler

Complexity

Total Complexity

5

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	1
Bugs	1	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	doProcess()	0	12	1
A	processFormModelExtra()	0	4	1
A	getFormData()	0	10	2

<?php

/*
 * This file is part of the MilioooMessageBundle package.
 *
 * (c) Michiel boeckaert <boeckaert@gmail.com>
 * 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 <boeckaert@gmail.com>
 */
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)

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().

    {
        $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)

The parameter $newThreadFormModel is not used and could be removed.

    {

    }
}