2011-03-02 11:20:30 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This file is part of the Symfony package.
|
|
|
|
*
|
2011-03-06 11:40:06 +00:00
|
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
2011-03-02 11:20:30 +00:00
|
|
|
*
|
|
|
|
* For the full copyright and license information, please view the LICENSE
|
|
|
|
* file that was distributed with this source code.
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace Symfony\Component\Form;
|
|
|
|
|
|
|
|
interface FormFactoryInterface
|
|
|
|
{
|
2011-05-10 17:23:58 +01:00
|
|
|
/**
|
|
|
|
* Returns a form.
|
|
|
|
*
|
|
|
|
* @see createBuilder()
|
|
|
|
*
|
2012-05-15 21:19:31 +01:00
|
|
|
* @param string|FormTypeInterface $type The type of the form
|
|
|
|
* @param mixed $data The initial data
|
|
|
|
* @param array $options The options
|
|
|
|
* @param FormBuilder $parent The parent builder
|
2011-05-10 17:23:58 +01:00
|
|
|
*
|
2012-05-21 03:26:59 +01:00
|
|
|
* @return FormInterface The form named after the type
|
2011-05-10 17:23:58 +01:00
|
|
|
*
|
2012-05-21 03:26:59 +01:00
|
|
|
* @throws Exception\FormException if any given option is not applicable to the given type
|
2011-05-10 17:23:58 +01:00
|
|
|
*/
|
2011-12-14 14:01:09 +00:00
|
|
|
function create($type, $data = null, array $options = array(), FormBuilder $parent = null);
|
2011-03-18 11:50:26 +00:00
|
|
|
|
2011-05-10 17:23:58 +01:00
|
|
|
/**
|
|
|
|
* Returns a form.
|
|
|
|
*
|
2012-05-21 03:26:59 +01:00
|
|
|
* @see createNamedBuilder()
|
|
|
|
*
|
2012-05-15 21:19:31 +01:00
|
|
|
* @param string $name The name of the form
|
2012-05-23 20:50:13 +01:00
|
|
|
* @param string|FormTypeInterface $type The type of the form
|
2012-05-15 21:19:31 +01:00
|
|
|
* @param mixed $data The initial data
|
|
|
|
* @param array $options The options
|
|
|
|
* @param FormBuilder $parent The parent builder
|
2011-05-10 17:23:58 +01:00
|
|
|
*
|
2012-05-21 03:26:59 +01:00
|
|
|
* @return FormInterface The form
|
2011-05-10 17:23:58 +01:00
|
|
|
*
|
2012-05-21 03:26:59 +01:00
|
|
|
* @throws Exception\FormException if any given option is not applicable to the given type
|
2011-05-10 17:23:58 +01:00
|
|
|
*/
|
2012-05-23 20:50:13 +01:00
|
|
|
function createNamed($name, $type, $data = null, array $options = array(), FormBuilder $parent = null);
|
2011-03-18 11:50:26 +00:00
|
|
|
|
2011-05-10 17:23:58 +01:00
|
|
|
/**
|
|
|
|
* Returns a form for a property of a class.
|
|
|
|
*
|
2012-05-21 03:26:59 +01:00
|
|
|
* @see createBuilderForProperty()
|
|
|
|
*
|
2012-05-15 21:19:31 +01:00
|
|
|
* @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
|
|
|
|
* @param array $options The options for the builder
|
|
|
|
* @param FormBuilder $parent The parent builder
|
2011-05-10 17:23:58 +01:00
|
|
|
*
|
2012-05-21 03:26:59 +01:00
|
|
|
* @return FormInterface The form named after the property
|
2011-05-10 17:23:58 +01:00
|
|
|
*
|
2012-05-21 03:26:59 +01:00
|
|
|
* @throws Exception\FormException if any given option is not applicable to the form type
|
2011-05-10 17:23:58 +01:00
|
|
|
*/
|
2011-12-14 14:01:09 +00:00
|
|
|
function createForProperty($class, $property, $data = null, array $options = array(), FormBuilder $parent = null);
|
2011-03-02 13:58:19 +00:00
|
|
|
|
2011-05-10 17:23:58 +01:00
|
|
|
/**
|
2012-05-21 03:26:59 +01:00
|
|
|
* Returns a form builder.
|
2011-05-10 17:23:58 +01:00
|
|
|
*
|
2012-05-15 21:19:31 +01:00
|
|
|
* @param string|FormTypeInterface $type The type of the form
|
|
|
|
* @param mixed $data The initial data
|
|
|
|
* @param array $options The options
|
|
|
|
* @param FormBuilder $parent The parent builder
|
2011-05-10 17:23:58 +01:00
|
|
|
*
|
|
|
|
* @return FormBuilder The form builder
|
|
|
|
*
|
2012-05-21 03:26:59 +01:00
|
|
|
* @throws Exception\FormException if any given option is not applicable to the given type
|
2011-05-10 17:23:58 +01:00
|
|
|
*/
|
2011-12-14 14:01:09 +00:00
|
|
|
function createBuilder($type, $data = null, array $options = array(), FormBuilder $parent = null);
|
2011-04-22 09:42:21 +01:00
|
|
|
|
2011-05-10 17:23:58 +01:00
|
|
|
/**
|
|
|
|
* Returns a form builder.
|
|
|
|
*
|
2012-05-15 21:19:31 +01:00
|
|
|
* @param string $name The name of the form
|
2012-05-23 20:50:13 +01:00
|
|
|
* @param string|FormTypeInterface $type The type of the form
|
2012-05-15 21:19:31 +01:00
|
|
|
* @param mixed $data The initial data
|
|
|
|
* @param array $options The options
|
|
|
|
* @param FormBuilder $parent The parent builder
|
2011-05-10 17:23:58 +01:00
|
|
|
*
|
|
|
|
* @return FormBuilder The form builder
|
|
|
|
*
|
2012-05-21 03:26:59 +01:00
|
|
|
* @throws Exception\FormException if any given option is not applicable to the given type
|
2011-05-10 17:23:58 +01:00
|
|
|
*/
|
2012-05-23 20:50:13 +01:00
|
|
|
function createNamedBuilder($name, $type, $data = null, array $options = array(), FormBuilder $parent = null);
|
2011-04-22 09:42:21 +01:00
|
|
|
|
2011-05-10 17:23:58 +01:00
|
|
|
/**
|
|
|
|
* Returns a form builder for a property of a class.
|
|
|
|
*
|
|
|
|
* If any of the 'max_length', 'required' and type options can be guessed,
|
|
|
|
* and are not provided in the options argument, the guessed value is used.
|
|
|
|
*
|
2012-05-15 21:19:31 +01:00
|
|
|
* @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
|
|
|
|
* @param array $options The options for the builder
|
|
|
|
* @param FormBuilder $parent The parent builder
|
2011-05-10 17:23:58 +01:00
|
|
|
*
|
|
|
|
* @return FormBuilder The form builder named after the property
|
|
|
|
*
|
2012-05-21 03:26:59 +01:00
|
|
|
* @throws Exception\FormException if any given option is not applicable to the form type
|
2011-05-10 17:23:58 +01:00
|
|
|
*/
|
2011-12-14 14:01:09 +00:00
|
|
|
function createBuilderForProperty($class, $property, $data = null, array $options = array(), FormBuilder $parent = null);
|
2011-05-13 16:16:36 +01:00
|
|
|
|
2012-05-21 03:26:59 +01:00
|
|
|
/**
|
|
|
|
* Returns a type by name.
|
|
|
|
*
|
|
|
|
* This methods registers the type extensions from the form extensions.
|
|
|
|
*
|
|
|
|
* @param string $name The name of the type
|
|
|
|
*
|
|
|
|
* @return FormTypeInterface The type
|
|
|
|
*
|
|
|
|
* @throws Exception\FormException if the type can not be retrieved from any extension
|
|
|
|
*/
|
2011-05-13 16:16:36 +01:00
|
|
|
function getType($name);
|
2011-05-13 17:29:18 +01:00
|
|
|
|
2012-05-21 03:26:59 +01:00
|
|
|
/**
|
|
|
|
* Returns whether the given type is supported.
|
|
|
|
*
|
|
|
|
* @param string $name The name of the type
|
|
|
|
*
|
|
|
|
* @return Boolean Whether the type is supported
|
|
|
|
*/
|
2011-05-13 17:29:18 +01:00
|
|
|
function hasType($name);
|
|
|
|
|
2012-05-21 03:26:59 +01:00
|
|
|
/**
|
|
|
|
* Adds a type.
|
|
|
|
*
|
|
|
|
* @param FormTypeInterface $type The type
|
|
|
|
*/
|
2011-05-13 17:29:18 +01:00
|
|
|
function addType(FormTypeInterface $type);
|
2011-04-07 08:57:44 +01:00
|
|
|
}
|