Merge "Expand documentation about options in HTMLForm"
authorjenkins-bot <jenkins-bot@gerrit.wikimedia.org>
Sat, 25 Aug 2018 06:51:43 +0000 (06:51 +0000)
committerGerrit Code Review <gerrit@wikimedia.org>
Sat, 25 Aug 2018 06:51:43 +0000 (06:51 +0000)
1  2 
includes/htmlform/HTMLForm.php

@@@ -57,10 -57,12 +57,12 @@@ use Wikimedia\ObjectFactory
   *    'cssclass'            -- CSS class
   *    'csshelpclass'        -- CSS class used to style help text
   *    'dir'                 -- Direction of the element.
-  *    'options'             -- associative array mapping labels to values.
+  *    'options'             -- associative array mapping raw text labels to values.
   *                             Some field types support multi-level arrays.
+  *                             Overwrites 'options-message'.
   *    'options-messages'    -- associative array mapping message keys to values.
   *                             Some field types support multi-level arrays.
+  *                             Overwrites 'options' and 'options-message'.
   *    'options-message'     -- message key or object to be parsed to extract the list of
   *                             options (like 'ipbreason-dropdown').
   *    'label-message'       -- message key or object for a message to use as the label.
@@@ -76,9 -78,6 +78,9 @@@
   *    'help-messages'       -- array of message keys/objects. As above, each item can
   *                             be an array of msg key and then parameters.
   *                             Overwrites 'help'.
 + *    'help-inline'         -- Whether help text (defined using options above) will be shown
 + *                             inline after the input field, rather than in a popup.
 + *                             Defaults to true. Only used by OOUI form fields.
   *    'notice'              -- message text for a message to use as a notice in the field.
   *                             Currently used by OOUI form fields only.
   *    'notice-messages'     -- array of message keys/objects to use for notice.