Add option binaryFormat in constraint file

symfony · Jun 24, 2014 · deac0c3 · deac0c3
1 parent e3acdc5
commit deac0c3
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/reference/constraints/File.rst b/reference/constraints/File.rst
@@ -20,6 +20,7 @@ form type.
 | Applies to     | :ref:`property or method <validation-property-target>`              |
 +----------------+---------------------------------------------------------------------+
 | Options        | - `maxSize`_                                                        |
+|                | - `binaryFormat`_                                                   |
 |                | - `mimeTypes`_                                                      |
 |                | - `maxSizeMessage`_                                                 |
 |                | - `mimeTypesMessage`_                                               |
@@ -78,7 +79,7 @@ below a certain file size and a valid PDF, add the following:
                         maxSize: 1024k
                         mimeTypes: [application/pdf, application/x-pdf]
                         mimeTypesMessage: Please upload a valid PDF
-                        
+
 
     .. code-block:: php-annotations
 
@@ -151,6 +152,18 @@ have been specified.
 Options
 -------
 
+.. versionadded:: 2.6
+    The ``binaryFormat`` option was introduced in Symfony 2.6.
+
+binaryFormat
+~~~~~~~~~~~~
+
+**type**: ``boolean`` **default**: ``null``
+
+When true, the sizes will be displayed in messages with binary suffixes (KiB, MiB).
+When false, the sizes will be displayed with SI suffixes (kB, MB).
+When null, then the binaryFormat will be guessed from the suffix defined in the maxSize option.
+
 maxSize
 ~~~~~~~