Skip to content

[WIP][Reference][Form Types] Add missing options for "form" type #3449

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 1, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions reference/forms/types/form.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,8 @@ on all fields.

.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc

.. include:: /reference/forms/types/options/extra_fields_message.rst.inc

.. include:: /reference/forms/types/options/post_max_size_message.rst.inc

.. include:: /reference/forms/types/options/pattern.rst.inc
9 changes: 9 additions & 0 deletions reference/forms/types/options/extra_fields_message.rst.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
extra_fields_message
~~~~~~~~~~~~~~~~~~~~

**type**: ``string`` **default**: ``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. The
placeholder ``{{ extra_fields }}`` can be used to display a comma separated
list of the submitted extra field names.
18 changes: 18 additions & 0 deletions reference/forms/types/options/pattern.rst.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
pattern
~~~~~~~

**type**: ``string`` **default**: ``null``

This adds an HTML5 ``pattern`` attribute to restrict the field input by a
given regular expression.

.. caution:

The ``pattern`` attribute provides client-side validation for convenience
purposes only and must not be used as a replacement for reliable
server-side validation.

.. note:

When using validation constraints, this option is set automatically
for some constraints to match the server-side validation.
12 changes: 12 additions & 0 deletions reference/forms/types/options/post_max_size_message.rst.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
post_max_size_message
~~~~~~~~~~~~~~~~~~~~~

**type**: ``string`` **default**: ``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.ini``'s ``post_max_size`` directive. The ``{{ max }}``
placeholder can be used to display the allowed size.

.. note:

Validating the ``post_max_size`` only happens on the root form.