Kunstmaan / KunstmaanBundlesCMS

src/Kunstmaan/AdminBundle/Helper/FormWidgets/FormWidgetInterface.php

<?php

namespace Kunstmaan\AdminBundle\Helper\FormWidgets;

use Doctrine\ORM\EntityManager;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\FormView;
use Symfony\Component\HttpFoundation\Request;

/**
 * A tab can be added to the TabPane and show fields or other information of a certain entity
 */
interface FormWidgetInterface
{
    /**
     * @param FormBuilderInterface $builder The form builder
     */
    public function buildForm(FormBuilderInterface $builder);

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.

    /**
     * @param Request $request
     */
    public function bindRequest(Request $request);

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.

    /**
     * @param EntityManager $em The entity manager
     */
    public function persist(EntityManager $em);

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.

    /**
     * @param FormView $formView
     *
     * @return array
     */
    public function getFormErrors(FormView $formView);

    /**
     * @return string
     */
    public function getIdentifier();

    /**
     * @param string $identifier
     *
     * @return TabInterface
     */
    public function setIdentifier($identifier);

    /**
     * @return string
     */
    public function getTemplate();

    /**
     * @param Request $request
     *
     * @return array
     */
    public function getExtraParams(Request $request);
}