| Index: trunk/phase3/includes/Xml.php |
| — | — | @@ -334,10 +334,10 @@ |
| 335 | 335 | |
| 336 | 336 | /** |
| 337 | 337 | * Convenience function to build an HTML radio button |
| 338 | | - * @param $name value of the name attribute |
| 339 | | - * @param $value value of the value attribute |
| 340 | | - * @param $checked Whether the checkbox is checked or not |
| 341 | | - * @param $attribs other attributes |
| | 338 | + * @param $name String value of the name attribute |
| | 339 | + * @param $value String value of the value attribute |
| | 340 | + * @param $checked Bool Whether the checkbox is checked or not |
| | 341 | + * @param $attribs Array other attributes |
| 342 | 342 | * @return string HTML |
| 343 | 343 | */ |
| 344 | 344 | public static function radio( $name, $value, $checked = false, $attribs = array() ) { |
| — | — | @@ -376,8 +376,8 @@ |
| 377 | 377 | * @param $label String text of the label |
| 378 | 378 | * @param $name String value of the name attribute |
| 379 | 379 | * @param $id String id of the input |
| 380 | | - * @param $size int value of the size attribute |
| 381 | | - * @param $value value of the value attribute |
| | 380 | + * @param $size Int|Bool value of the size attribute |
| | 381 | + * @param $value String|Bool value of the value attribute |
| 382 | 382 | * @param $attribs array other attributes |
| 383 | 383 | * @return string HTML |
| 384 | 384 | */ |
| — | — | @@ -389,11 +389,11 @@ |
| 390 | 390 | /** |
| 391 | 391 | * Same as Xml::inputLabel() but return input and label in an array |
| 392 | 392 | * |
| 393 | | - * @param $label |
| 394 | | - * @param $name |
| 395 | | - * @param $id |
| 396 | | - * @param $size |
| 397 | | - * @param $value |
| | 393 | + * @param $label String |
| | 394 | + * @param $name String |
| | 395 | + * @param $id String |
| | 396 | + * @param $size Int|Bool |
| | 397 | + * @param $value String|Bool |
| 398 | 398 | * @param $attribs array |
| 399 | 399 | * |
| 400 | 400 | * @return array |
| Index: trunk/phase3/includes/HTMLForm.php |
| — | — | @@ -81,7 +81,10 @@ |
| 82 | 82 | ); |
| 83 | 83 | |
| 84 | 84 | protected $mMessagePrefix; |
| | 85 | + |
| | 86 | + /** @var HTMLFormField[] */ |
| 85 | 87 | protected $mFlatFields; |
| | 88 | + |
| 86 | 89 | protected $mFieldTree; |
| 87 | 90 | protected $mShowReset = false; |
| 88 | 91 | public $mFieldData; |
| — | — | @@ -512,6 +515,7 @@ |
| 513 | 516 | |
| 514 | 517 | /** |
| 515 | 518 | * Get the whole body of the form. |
| | 519 | + * @return String |
| 516 | 520 | */ |
| 517 | 521 | function getBody() { |
| 518 | 522 | return $this->displaySection( $this->mFieldTree ); |
| — | — | @@ -686,9 +690,10 @@ |
| 687 | 691 | |
| 688 | 692 | /** |
| 689 | 693 | * TODO: Document |
| 690 | | - * @param $fields array of fields (either arrays or objects) |
| | 694 | + * @param $fields array[]|HTMLFormField[] array of fields (either arrays or objects) |
| 691 | 695 | * @param $sectionName string ID attribute of the <table> tag for this section, ignored if empty |
| 692 | 696 | * @param $fieldsetIDPrefix string ID prefix for the <fieldset> tag of each subsection, ignored if empty |
| | 697 | + * @return String |
| 693 | 698 | */ |
| 694 | 699 | function displaySection( $fields, $sectionName = '', $fieldsetIDPrefix = '' ) { |
| 695 | 700 | $tableHtml = ''; |
| — | — | @@ -1310,6 +1315,7 @@ |
| 1311 | 1316 | /** |
| 1312 | 1317 | * For a checkbox, the label goes on the right hand side, and is |
| 1313 | 1318 | * added in getInputHTML(), rather than HTMLFormField::getRow() |
| | 1319 | + * @return String |
| 1314 | 1320 | */ |
| 1315 | 1321 | function getLabel() { |
| 1316 | 1322 | return ' '; |
| — | — | @@ -1756,6 +1762,8 @@ |
| 1757 | 1763 | /** |
| 1758 | 1764 | * This returns a block of all the radio options, in one cell. |
| 1759 | 1765 | * @see includes/HTMLFormField#getInputHTML() |
| | 1766 | + * @param $value String |
| | 1767 | + * @return String |
| 1760 | 1768 | */ |
| 1761 | 1769 | function getInputHTML( $value ) { |
| 1762 | 1770 | $html = $this->formatOptions( $this->mParams['options'], $value ); |
| — | — | @@ -1881,6 +1889,9 @@ |
| 1882 | 1890 | |
| 1883 | 1891 | /** |
| 1884 | 1892 | * Button cannot be invalid |
| | 1893 | + * @param $value String |
| | 1894 | + * @param $alldata Array |
| | 1895 | + * @return Bool |
| 1885 | 1896 | */ |
| 1886 | 1897 | public function validate( $value, $alldata ){ |
| 1887 | 1898 | return true; |