WeekType Field
Warning: You are browsing the documentation for Symfony 6.3, which is no longer maintained.
Read the updated version of this page for Symfony 7.2 (the current stable version).
This field type allows the user to modify data that represents a specific
ISO 8601 week number (e.g. 1984-W05
).
Can be rendered as a text input or select tags. The underlying format of the data can be a string or an array.
Underlying Data Type | can be a string, or array (see the input option) |
Rendered as | single text box, two text boxes or two select fields |
Default invalid message | Please enter a valid week. |
Legacy invalid message | The value {{ value }} is not valid. |
Parent type | FormType |
Class | WeekType |
Tip
The full list of options defined and inherited by this form type is available running this command in your app:
1 2
# replace 'FooType' by the class name of your form type
$ php bin/console debug:form FooType
Field Options
This option determines if the choice values should be translated and in which translation domain.
The values of the choice_translation_domain
option can be true
(reuse the current
translation domain), false
(disable translation), null
(uses the parent translation
domain or the default domain) or a string which represents the exact translation
domain to use.
placeholder
type: string
| array
If your widget option is set to choice
, then this field will be represented
as a series of select
boxes. When the placeholder value is a string,
it will be used as the blank value of all select boxes:
1 2 3 4 5
use Symfony\Component\Form\Extension\Core\Type\WeekType;
$builder->add('startWeek', WeekType::class, [
'placeholder' => 'Select a value',
]);
Alternatively, you can use an array that configures different placeholder values for the year and week fields:
1 2 3 4 5 6 7 8
use Symfony\Component\Form\Extension\Core\Type\WeekType;
$builder->add('startDateTime', WeekType::class, [
'placeholder' => [
'year' => 'Year',
'week' => 'Week',
],
]);
html5
type: boolean
default: true
If this is set to true
(the default), it'll use the HTML5 type (date, time
or datetime-local) to render the field. When set to false
, it'll use the text type.
This is useful when you want to use a custom JavaScript datepicker, which often requires a text type instead of an HTML5 type.
input
type: string
default: array
The format of the input data - i.e. the format that the date is stored on your underlying object. Valid values are:
string
(e.g."2011-W17"
)array
(e.g.[2011, 17]
)
The value that comes back from the form will also be normalized back into this format.
widget
type: string
default: choice
The basic way in which this field should be rendered. Can be one of the following:
choice
: renders two select inputs;text
: renders a two field input of typetext
(year and week);single_text
: renders a single input of typeweek
.
years
type: array
default: ten years before to ten years after the
current year
List of years available to the year field type. This option is only relevant
when the widget
option is set to choice
.
weeks
type: array
default: 1 to 53
List of weeks available to the week field type. This option is only relevant
when the widget
option is set to choice
.
Overridden Options
compound
type: boolean
default: false
This option specifies whether the type contains child types or not. This option is managed internally for built-in types, so there is no need to configure it explicitly.
empty_data
type: mixed
The actual default value of this option depends on other field options:
- If
widget
issingle_text
, then''
(empty string); - Otherwise
[]
(empty array).
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:
1 2 3 4
$builder->add('name', null, [
'required' => false,
'empty_data' => 'John Doe',
]);
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.
Note
If a form is compound, you can set empty_data
as an array, object or
closure. This option can be set for your entire form class, see the
How to Configure empty Data for a Form Class article for more details about these
options.
Caution
Form data transformers will still be
applied to the empty_data
value. 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.
error_bubbling
default: false
invalid_message
type: string
default: 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.e. fails validation).
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.g. apple
) into a
number field.
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).
Inherited Options
These options inherit from the FormType:
attr
type: array
default: []
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:
1 2 3
$builder->add('body', TextareaType::class, [
'attr' => ['class' => 'tinymce'],
]);
See also
Use the row_attr
option if you want to add these attributes to
the form type row element.
data
type: mixed
default: 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.g. if you bind an object to the form). If you want to override this initial value for the form or an individual field, you can set it in the data option:
1 2 3 4 5 6
use Symfony\Component\Form\Extension\Core\Type\HiddenType;
// ...
$builder->add('token', HiddenType::class, [
'data' => 'abcdef',
]);
Caution
The data
option always overrides the value taken from the domain data
(object) when rendering. This means the object value is also overridden when
the form edits an already persisted object, causing it to lose its
persisted value when the form is submitted.
disabled
type: boolean
default: false
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.
help
type: string
or TranslatableInterface
default: null
Allows you to define a help message for the form field, which by default is rendered below the field:
1 2 3 4 5 6 7 8 9 10 11 12 13
use Symfony\Component\Translation\TranslatableMessage;
$builder
->add('zipCode', null, [
'help' => 'The ZIP/Postal code for your credit card\'s billing address.',
])
// ...
->add('status', null, [
'help' => new TranslatableMessage('order.status', ['%order_id%' => $order->getId()], 'store'),
])
;
6.2
The support for TranslatableInterface
objects as help contents was
introduced in Symfony 6.2.
help_attr
type: array
default: []
Sets the HTML attributes for the element used to display the help message of the form field. Its value is an associative array with HTML attribute names as keys. These attributes can also be set in the template:
1 2 3
{{ form_help(form.name, 'Your name', {
'help_attr': {'class': 'CUSTOM_LABEL_CLASS'}
}) }}
help_html
type: boolean
default: false
By default, the contents of the help
option are escaped before rendering
them in the template. Set this option to true
to not escape them, which is
useful when the help contains HTML elements.
inherit_data
type: boolean
default: false
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. See How to Reduce Code Duplication with "inherit_data".
Caution
When a field has the inherit_data
option set, it uses the data of
the parent form as is. This means that
Data Transformers won't be
applied to that field.
invalid_message_parameters
type: array
default: []
When setting the invalid_message
option, you may need to
include some variables in the string. This can be done by adding placeholders
to that option and including the variables in this option:
1 2 3 4 5
$builder->add('someField', SomeFormType::class, [
// ...
'invalid_message' => 'You entered an invalid value, it should include %num% letters',
'invalid_message_parameters' => ['%num%' => 6],
]);
mapped
type: boolean
default: true
If you wish the field to be ignored when reading or writing to the object,
you can set the mapped
option to false
.
row_attr
type: array
default: []
An associative array of the HTML attributes added to the element which is used to render the form type row:
1 2 3
$builder->add('body', TextareaType::class, [
'row_attr' => ['class' => 'text-editor', 'id' => '...'],
]);
See also
Use the attr
option if you want to add these attributes to
the form type widget element.
Field Variables
Variable | Type | Usage |
---|---|---|
widget | mixed |
The value of the widget option. |
type | string |
Only present when widget is single_text and HTML5 is activated,
contains the input type to use (datetime , date or time ). |