This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
symfony/src/Symfony/Component/Form/FormFactoryInterface.php
Nicolas Grekas 42cad9b76e Merge branch '4.4'
* 4.4:
  Remove superfluous phpdoc tags
2019-08-14 14:45:29 +02:00

100 lines
3.6 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;
/**
* Allows creating a form based on a name, a class or a property.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
interface FormFactoryInterface
{
/**
* Returns a form.
*
* @see createBuilder()
*
* @param mixed $data The initial data
*
* @return FormInterface The form named after the type
*
* @throws \Symfony\Component\OptionsResolver\Exception\InvalidOptionsException if any given option is not applicable to the given type
*/
public function create(string $type = 'Symfony\Component\Form\Extension\Core\Type\FormType', $data = null, array $options = []);
/**
* Returns a form.
*
* @see createNamedBuilder()
*
* @param mixed $data The initial data
*
* @return FormInterface The form
*
* @throws \Symfony\Component\OptionsResolver\Exception\InvalidOptionsException if any given option is not applicable to the given type
*/
public function createNamed(string $name, string $type = 'Symfony\Component\Form\Extension\Core\Type\FormType', $data = null, array $options = []);
/**
* Returns a form for a property of a class.
*
* @see createBuilderForProperty()
*
* @param string $class The fully qualified class name
* @param string $property The name of the property to guess for
* @param mixed $data The initial data
*
* @return FormInterface The form named after the property
*
* @throws \Symfony\Component\OptionsResolver\Exception\InvalidOptionsException if any given option is not applicable to the form type
*/
public function createForProperty(string $class, string $property, $data = null, array $options = []);
/**
* Returns a form builder.
*
* @param mixed $data The initial data
*
* @return FormBuilderInterface The form builder
*
* @throws \Symfony\Component\OptionsResolver\Exception\InvalidOptionsException if any given option is not applicable to the given type
*/
public function createBuilder(string $type = 'Symfony\Component\Form\Extension\Core\Type\FormType', $data = null, array $options = []);
/**
* Returns a form builder.
*
* @param mixed $data The initial data
*
* @return FormBuilderInterface The form builder
*
* @throws \Symfony\Component\OptionsResolver\Exception\InvalidOptionsException if any given option is not applicable to the given type
*/
public function createNamedBuilder(string $name, string $type = 'Symfony\Component\Form\Extension\Core\Type\FormType', $data = null, array $options = []);
/**
* Returns a form builder for a property of a class.
*
* If any of the 'required' and type options can be guessed,
* and are not provided in the options argument, the guessed value is used.
*
* @param string $class The fully qualified class name
* @param string $property The name of the property to guess for
* @param mixed $data The initial data
*
* @return FormBuilderInterface The form builder named after the property
*
* @throws \Symfony\Component\OptionsResolver\Exception\InvalidOptionsException if any given option is not applicable to the form type
*/
public function createBuilderForProperty(string $class, string $property, $data = null, array $options = []);
}