Symfony form input options
Form Types Reference (The Symfony Reference)
The FormType predefines a couple of options that are then available on all types for which FormType is the parent. This option specifies where to send the form's data on submission usually a URI.
Its value is rendered as the action attribute of the form element. An empty value is considered a same-document reference, i. Usually, if you submit extra fields that aren't configured in your form, you'll get a "This form should not contain extra fields. In most cases, if you have an author field, then you expect setAuthor to be called on the underlying object. In some cases, however, setAuthor may not be called. Notice that setAuthor is not called.
The author is modified by reference. This option specifies if a form is compound. This is independent of whether the form actually has children. A form can be compound but not have any children at all e. Allows you to attach one or more validation constraints to a specific field.
Resources | Graphviz - Graph Visualization Software
For more information, see Adding Validation. This option is added in the FormTypeValidatorExtension form extension. Defaults to field of the underlying structure. When you create a form, each field initially displays the value of the corresponding property of the form's domain data e. If you want to override this initial value for the form or an individual field, you can set it in the data option:.
The data option always overrides the value taken from the domain data object when rendering. This means the object value is also overriden when the form edits an already persisted object, causing it to lose it's persisted value when the form is submitted. This option is used to set the appropriate data mapper to be used by the form, so you can use it for any form field type which requires an object.
This option determines what value the field will return when the submitted value is empty or missing. It does not set an initial value if none is provided when the form is rendered in a view. This means it helps you handling form submission with blank fields. For example, if you want the name field to be explicitly set to John Doe when no value is selected, you can do it like this:. This will still render an empty text box, but upon submission the John Doe value will be set. Use the data or placeholder options to show this initial value in the rendered form.
See the How to Configure empty Data for a Form Class article for more details about these options. This means that an empty string will be cast to null. Use a custom data transformer if you explicitly want to return the empty string. If true , any errors for this field will be passed to the parent field or form. For example, if set to true on a normal field, any errors for that field will be attached to the main form, not to the specific field.
Imagine you have a custom method named matchingCityAndZipCode that validates whether the city and zip code match. Unfortunately, there is no "matchingCityAndZipCode" field in your form, so all that Symfony can do is display the error on top of the form.
With customized error mapping, you can do better: By default, errors for any property that is not mapped will bubble up to the parent form. You can use the dot. For instance, to map all these errors to the city field, use:.
This form should not contain extra fields. This is the validation error message that's used if the submitted form data contains one or more fields that are not part of the form definition. This option determines if the form will inherit data from its parent form. This can be useful if you have a set of fields that are duplicated across multiple forms. This means that Data Transformers won't be applied to that field. This value is not valid. This is the validation error message that's used if the data entered into this field doesn't make sense i.
This might happen, for example, if the user enters a nonsense string into a TimeType field that cannot be converted into a real time or if the user enters a string e. Normal business logic validation such as when setting a minimum length for a field should be set using validation messages with your validation rules reference.
This can be done by adding placeholders to that option and including the variables in this option:. It's an associative array with HTML attribute as a key.
This attributes can also be directly set inside the template:.
Configures the string used as the label of the field, in case the label option was not set. This is useful when using keyword translation messages.
If you're using keyword translation messages as labels, you often end up having multiple keyword messages for the same label e. This is because the label is build for each "path" to a field.
To avoid duplicated keyword messages, you can configure the label format to a static value, like:. This option is inherited by the child types. With the code above, the label of the street field of both forms will use the form. The default value null results in a "humanized" version of the field name. Make sure to update your templates in case you customized form theming.
If you wish the field to be ignored when reading or writing to the object, you can set the mapped option to false. This option specifies the HTTP method used to submit the form's data. Its value is rendered as the method attribute of the form element and is used to decide whether to process the form submission in the handleRequest method after submission.
This is used to "fake" these HTTP methods, as they're not supported on standard browsers. This can be useful when using method routing requirements. The PATCH method allows submitting partial data. In other words, if the submitted form data is missing certain fields, those will be ignored and the default values if any will be used. With all other HTTP methods, if the submitted form data is missing some fields, those fields are set to null.
The uploaded file was too large. Please try to upload a smaller file. This is the validation error message that's used if submitted POST form data exceeds php.
Fields display a property value of the form's domain object by default. When the form is submitted, the submitted value is written back into the object. Its default value is the field's name. If true, an HTML5 required attribute will be rendered.
The corresponding label will also render with a required class. This is superficial and independent from validation.
How to create custom validator directives with AngularJS - AlgoTech Engineering Blog
At best, if you let Symfony guess your field type, then the value of this option will be guessed from your validation information. The required option also affects how empty data for each field is handled. If true, the whitespace of the submitted string value will be stripped via the trim function when the data is bound. This guarantees that if a value is submitted with extra whitespace, it will be removed before the value is merged back onto the underlying object.
The following options are defined in the BaseType class. The BaseType class is the parent class for both the form type and the ButtonType , but it is not part of the form type tree i. If you want to add extra attributes to an HTML field representation you can use the attr option. It's an associative array with HTML attributes as keys.
This can be useful when you need to set a custom class for some widget:. For all fields, this option should only be true for root forms. You won't need to change this option and probably won't need to worry about it. Allows you to override the block name used to render the form type. Useful for example if you have multiple instances of the same form and you need to personalize the rendering of the forms individually. If you don't want a user to modify the value of a field, you can set the disabled option to true.
Any submitted value will be ignored. The label is "guessed" from the field name. Sets the label that will be used when rendering the field. Setting to false will suppress the label. The label can also be directly set inside the template:. This is the translation domain that will be used for any label or option that is rendered for this field. Use null to reuse the translation domain of the parent form or the default domain of the translator for the root form.
Use false to disable translations. This work, including the code samples, is licensed under a Creative Commons BY-SA 3. Documentation Community Showcase Business Solutions News Download. Setup Creating Pages Routing Controllers Templates Configuration. Assetic Bundles Console Contributing Databases Doctrine ORM Debug Deployment Email Event Dispatcher Expressions Forms Front-end HTTP Cache Logging Performance Profiler Request Security Serializer Service Container Sessions Testing Translation i18n Validation Workflow.
Asset BrowserKit Cache ClassLoader Config Console CssSelector Debug DependencyInjection Dotenv DomCrawler EventDispatcher ExpressionLanguage Filesystem Finder Form HttpFoundation HttpKernel Intl Ldap OptionsResolver Process PropertyAccess PropertyInfo Routing Security Serializer Stopwatch Templating Translation Validator VarDumper Workflow Yaml PHPUnit Bridge.
Master Symfony fundamentals Be trained by SensioLabs experts 2 to 6 day sessions -- French or English. To explain this further, here's a simple example: If you want to override this initial value for the form or an individual field, you can set it in the data option: Caution The data option always overrides the value taken from the domain data object when rendering.
For example, if you want the name field to be explicitly set to John Doe when no value is selected, you can do it like this: This value is not valid This is the validation error message that's used if the data entered into this field doesn't make sense i. This can be done by adding placeholders to that option and including the variables in this option: This attributes can also be directly set inside the template: Twig 1 2 3. To avoid duplicated keyword messages, you can configure the label format to a static value, like: POST This option specifies the HTTP method used to submit the form's data.
POST GET PUT DELETE PATCH. Note The PATCH method allows submitting partial data. Note The required option also affects how empty data for each field is handled. This can be useful when you need to set a custom class for some widget: The label is "guessed" from the field name Sets the label that will be used when rendering the field. The label can also be directly set inside the template: News from the Symfony blog A week of symfony June June 18, Save the dates for the SymfonyTour and participate in our CFP!
June 16, Introducing Webpack Encore for Asset Management June 13, Visit The Symfony Blog. In the news Symfony 3 Certification now available in 4, centers around the world! Upcoming training sessions Mastering Symfony 3 Berlin - June 21, Getting Started with Symfony 3 Paris - June 26, Web Development with Symfony 3 Paris - June 26, View all sessions.