92 lines
2.9 KiB
PHP
92 lines
2.9 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony package.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Symfony\Component\Form;
|
|
|
|
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
|
|
|
|
/**
|
|
* @author Bernhard Schussek <bschussek@gmail.com>
|
|
*/
|
|
interface FormTypeInterface
|
|
{
|
|
/**
|
|
* Builds the form.
|
|
*
|
|
* This method is called for each type in the hierarchy starting form the
|
|
* top most type. Type extensions can further modify the form.
|
|
*
|
|
* @see FormTypeExtensionInterface::buildForm()
|
|
*
|
|
* @param FormBuilderInterface $builder The form builder
|
|
* @param array $options The options
|
|
*/
|
|
public function buildForm(FormBuilderInterface $builder, array $options);
|
|
|
|
/**
|
|
* Builds the form view.
|
|
*
|
|
* This method is called for each type in the hierarchy starting form the
|
|
* top most type. Type extensions can further modify the view.
|
|
*
|
|
* A view of a form is built before the views of the child forms are built.
|
|
* This means that you cannot access child views in this method. If you need
|
|
* to do so, move your logic to {@link finishView()} instead.
|
|
*
|
|
* @see FormTypeExtensionInterface::buildView()
|
|
*
|
|
* @param FormView $view The view
|
|
* @param FormInterface $form The form
|
|
* @param array $options The options
|
|
*/
|
|
public function buildView(FormView $view, FormInterface $form, array $options);
|
|
|
|
/**
|
|
* Finishes the form view.
|
|
*
|
|
* This method gets called for each type in the hierarchy starting form the
|
|
* top most type. Type extensions can further modify the view.
|
|
*
|
|
* When this method is called, views of the form's children have already
|
|
* been built and finished and can be accessed. You should only implement
|
|
* such logic in this method that actually accesses child views. For everything
|
|
* else you are recommended to implement {@link buildView()} instead.
|
|
*
|
|
* @see FormTypeExtensionInterface::finishView()
|
|
*
|
|
* @param FormView $view The view
|
|
* @param FormInterface $form The form
|
|
* @param array $options The options
|
|
*/
|
|
public function finishView(FormView $view, FormInterface $form, array $options);
|
|
|
|
/**
|
|
* Sets the default options for this type.
|
|
*
|
|
* @param OptionsResolverInterface $resolver The resolver for the options.
|
|
*/
|
|
public function setDefaultOptions(OptionsResolverInterface $resolver);
|
|
|
|
/**
|
|
* Returns the name of the parent type.
|
|
*
|
|
* @return string|null The name of the parent type if any, null otherwise.
|
|
*/
|
|
public function getParent();
|
|
|
|
/**
|
|
* Returns the name of this type.
|
|
*
|
|
* @return string The name of this type
|
|
*/
|
|
public function getName();
|
|
}
|