Miliooo\Messaging\Form\FormHandler\AbstractFormHandler

Complexity

Total Complexity

4

Size/Duplication

Total Lines	50
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	process()	0	16	3
	doProcess()	0	1	?

<?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\HttpFoundation\Request;
use Symfony\Component\Form\FormInterface;

/**
 * Description of AbstractFormHandler
 *
 * @author Michiel Boeckaert <boeckaert@gmail.com>
 */
abstract class AbstractFormHandler
{
    /**
     * The request the form will process
     *
     * @var Request
     */
    protected $request;

    /**
     * Constructor.
     *
     * @param Request $request The request the form will process
     */
    public function __construct(Request $request)

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;
    }

    /**
     * Processes a form
     *
     * @param FormInterface $form The form we process
     *
     * @return boolean false if not processed true if processed
     */
    public function process(FormInterface $form)

function process() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    {
        if ('POST' !== $this->request->getMethod()) {
            return false;
        }

        $form->handleRequest($this->request);

        if (!$form->isValid()) {
            return false;
        }

        $this->doProcess($form);

        return true;
    }

    /**
     * Do the processing of the valid form.
     *
     * @param FormInterface $form
     */
    abstract public function doProcess(FormInterface $form);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

}