Kunstmaan / KunstmaanBundlesCMS

src/Kunstmaan/FormBundle/Entity/FormAdaptorInterface.php

<?php

namespace Kunstmaan\FormBundle\Entity;

use ArrayObject;

use Symfony\Component\Form\FormBuilderInterface;

/**
 * Form adaptor Interface
 */
interface FormAdaptorInterface
{

    /**
     * Modify the given FormBuilderInterface
     *
     * @param FormBuilderInterface $formBuilder The form builder
     * @param ArrayObject          $fields      The fields
     * @param int                  $sequence    The sequence of the form field
     */
    public function adaptForm(FormBuilderInterface $formBuilder, ArrayObject $fields, $sequence);

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.

    /**
     * Returns a unique id
     *
     * @return string
     */
    public function getUniqueId();

}