1. interface
  2. Symfony
  3. \
  4. Component
  5. \
  6. Form
  7. \
  8. FormFactoryInterface

FormFactoryInterface

interface FormFactoryInterface

Allows creating a form based on a name, a class or a property.

Methods

FormInterface
create(string $type = 'Symfony\\Component\\Form\\Extension\\Core\\Type\\FormType', mixed $data = null, array $options = array())

Returns a form.

FormInterface
createNamed(string|int $name, string $type = 'Symfony\\Component\\Form\\Extension\\Core\\Type\\FormType', mixed $data = null, array $options = array())

Returns a form.

FormInterface
createForProperty(string $class, string $property, mixed $data = null, array $options = array())

Returns a form for a property of a class.

FormBuilderInterface
createBuilder(string $type = 'Symfony\\Component\\Form\\Extension\\Core\\Type\\FormType', mixed $data = null, array $options = array())

Returns a form builder.

FormBuilderInterface
createNamedBuilder(string|int $name, string $type = 'Symfony\\Component\\Form\\Extension\\Core\\Type\\FormType', mixed $data = null, array $options = array())

Returns a form builder.

FormBuilderInterface
createBuilderForProperty(string $class, string $property, mixed $data = null, array $options = array())

Returns a form builder for a property of a class.

Details

FormInterface create(string $type = 'Symfony\\Component\\Form\\Extension\\Core\\Type\\FormType', mixed $data = null, array $options = array())

Returns a form.

Parameters

string $type The type of the form
mixed $data The initial data
array $options The options

Return Value

FormInterface The form named after the type

Exceptions

InvalidOptionsException if any given option is not applicable to the given type

See also

FormInterface createNamed(string|int $name, string $type = 'Symfony\\Component\\Form\\Extension\\Core\\Type\\FormType', mixed $data = null, array $options = array())

Returns a form.

Parameters

string|int $name The name of the form
string $type The type of the form
mixed $data The initial data
array $options The options

Return Value

FormInterface The form

Exceptions

InvalidOptionsException if any given option is not applicable to the given type

See also

FormInterface createForProperty(string $class, string $property, mixed $data = null, array $options = array())

Returns a form for a property of a class.

Parameters

string $class The fully qualified class name
string $property The name of the property to guess for
mixed $data The initial data
array $options The options for the builder

Return Value

FormInterface The form named after the property

Exceptions

InvalidOptionsException if any given option is not applicable to the form type

See also

FormBuilderInterface createBuilder(string $type = 'Symfony\\Component\\Form\\Extension\\Core\\Type\\FormType', mixed $data = null, array $options = array())

Returns a form builder.

Parameters

string $type The type of the form
mixed $data The initial data
array $options The options

Return Value

FormBuilderInterface The form builder

Exceptions

InvalidOptionsException if any given option is not applicable to the given type

FormBuilderInterface createNamedBuilder(string|int $name, string $type = 'Symfony\\Component\\Form\\Extension\\Core\\Type\\FormType', mixed $data = null, array $options = array())

Returns a form builder.

Parameters

string|int $name The name of the form
string $type The type of the form
mixed $data The initial data
array $options The options

Return Value

FormBuilderInterface The form builder

Exceptions

InvalidOptionsException if any given option is not applicable to the given type

FormBuilderInterface createBuilderForProperty(string $class, string $property, mixed $data = null, array $options = array())

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.

Parameters

string $class The fully qualified class name
string $property The name of the property to guess for
mixed $data The initial data
array $options The options for the builder

Return Value

FormBuilderInterface The form builder named after the property

Exceptions

InvalidOptionsException if any given option is not applicable to the form type