Browse Source

merged branch gbirke/form_error_docs (PR #1599)

Commits
-------

22a49f1 Better docstring for FormError constructor

Discussion
----------

Better docstring for FormError constructor

Better docs for placeholder format of FormError.
Fabien Potencier 14 years ago
parent
commit
7f960a10f2
1 changed files with 4 additions and 0 deletions
  1. 4 0
      src/Symfony/Component/Form/FormError.php

+ 4 - 0
src/Symfony/Component/Form/FormError.php

@@ -33,6 +33,10 @@ class FormError
     /**
      * Constructor
      *
+     * Any array key in $messageParameters will be used as a placeholder in
+     * $messageTemplate.
+     * @see Symfony\Component\Translation\Translator
+     *
      * @param string $messageTemplate      The template for the error message
      * @param array $messageParameters     The parameters that should be
      *                                     substituted in the message template.