@@ -30,7 +30,7 @@ |
||
| 30 | 30 | /** |
| 31 | 31 | * Do a prefix search of user names and return a list of matching user names. |
| 32 | 32 | * |
| 33 | - * @param string|User $audience The string 'public' or a user object to show the search for |
|
| 33 | + * @param string $audience The string 'public' or a user object to show the search for |
|
| 34 | 34 | * @param string $search |
| 35 | 35 | * @param int $limit |
| 36 | 36 | * @param int $offset How many results to offset from the beginning |
@@ -171,10 +171,16 @@ |
||
| 171 | 171 | return is_object( $datum ) ? get_class( $datum ) : gettype( $datum ); |
| 172 | 172 | } |
| 173 | 173 | |
| 174 | + /** |
|
| 175 | + * @param string $expected |
|
| 176 | + */ |
|
| 174 | 177 | public static function wrongType( $expected, $datum ) { |
| 175 | 178 | return "Expected $expected, but recieved " . self::typeOf( $datum ); |
| 176 | 179 | } |
| 177 | 180 | |
| 181 | + /** |
|
| 182 | + * @param integer $datum |
|
| 183 | + */ |
|
| 178 | 184 | public static function outOfRange( $min, $max, $datum ) { |
| 179 | 185 | return "Expected value between $min and $max, but recieved $datum"; |
| 180 | 186 | } |
@@ -510,8 +510,8 @@ discard block |
||
| 510 | 510 | * Wait till the current timestamp reaches $time and return the current |
| 511 | 511 | * timestamp. This returns false if it would have to wait more than 10ms. |
| 512 | 512 | * |
| 513 | - * @param array $time Result of UIDGenerator::millitime() |
|
| 514 | - * @return array|bool UIDGenerator::millitime() result or false |
|
| 513 | + * @param integer[] $time Result of UIDGenerator::millitime() |
|
| 514 | + * @return resource UIDGenerator::millitime() result or false |
|
| 515 | 515 | */ |
| 516 | 516 | protected function timeWaitUntil( array $time ) { |
| 517 | 517 | do { |
@@ -571,7 +571,7 @@ discard block |
||
| 571 | 571 | } |
| 572 | 572 | |
| 573 | 573 | /** |
| 574 | - * @return array (current time in seconds, milliseconds since then) |
|
| 574 | + * @return integer[] (current time in seconds, milliseconds since then) |
|
| 575 | 575 | */ |
| 576 | 576 | protected static function millitime() { |
| 577 | 577 | list( $msec, $sec ) = explode( ' ', microtime() ); |
@@ -184,7 +184,7 @@ |
||
| 184 | 184 | |
| 185 | 185 | /** |
| 186 | 186 | * Throw an error, and log a debug message |
| 187 | - * @param mixed $code |
|
| 187 | + * @param string $code |
|
| 188 | 188 | * @param string $debugMessage |
| 189 | 189 | * @throws ZipDirectoryReaderError |
| 190 | 190 | */ |
@@ -22,20 +22,6 @@ |
||
| 22 | 22 | |
| 23 | 23 | /** |
| 24 | 24 | * @param array $config Configuration options |
| 25 | - * @param array $config['namespace'] Configuration for the NamespaceInputWidget |
|
| 26 | - * dropdown with list of namespaces |
|
| 27 | - * @param string $config['namespace']['includeAllValue'] If specified, |
|
| 28 | - * add an "all namespaces" option to the dropdown, and use this as the input value for it |
|
| 29 | - * @param array|null $config['invert'] Configuration for the "invert selection" |
|
| 30 | - * CheckboxInputWidget. If null, the checkbox will not be generated. |
|
| 31 | - * @param array|null $config['associated'] Configuration for the "include associated namespace" |
|
| 32 | - * CheckboxInputWidget. If null, the checkbox will not be generated. |
|
| 33 | - * @param array $config['invertLabel'] Configuration for the FieldLayout with label |
|
| 34 | - * wrapping the "invert selection" checkbox |
|
| 35 | - * @param string $config['invertLabel']['label'] Label text for the label |
|
| 36 | - * @param array $config['associatedLabel'] Configuration for the FieldLayout with label |
|
| 37 | - * wrapping the "include associated namespace" checkbox |
|
| 38 | - * @param string $config['associatedLabel']['label'] Label text for the label |
|
| 39 | 25 | */ |
| 40 | 26 | public function __construct( array $config = array() ) { |
| 41 | 27 | // Configuration initialization |
@@ -19,9 +19,6 @@ |
||
| 19 | 19 | * Like TitleInputWidget, but the namespace has to be input through a separate dropdown field. |
| 20 | 20 | * |
| 21 | 21 | * @param array $config Configuration options |
| 22 | - * @param array $config['namespace'] Configuration for the NamespaceInputWidget dropdown |
|
| 23 | - * with list of namespaces |
|
| 24 | - * @param array $config['title'] Configuration for the TitleInputWidget text field |
|
| 25 | 22 | */ |
| 26 | 23 | public function __construct( array $config = array() ) { |
| 27 | 24 | // Configuration initialization |
@@ -16,9 +16,6 @@ |
||
| 16 | 16 | |
| 17 | 17 | /** |
| 18 | 18 | * @param array $config Configuration options |
| 19 | - * @param string $config['includeAllValue'] If specified, add a "all namespaces" option to the |
|
| 20 | - * namespace dropdown, and use this as the input value for it |
|
| 21 | - * @param number[] $config['exclude'] List of namespace numbers to exclude from the selector |
|
| 22 | 19 | */ |
| 23 | 20 | public function __construct( array $config = array() ) { |
| 24 | 21 | // Configuration initialization |
@@ -20,14 +20,6 @@ |
||
| 20 | 20 | |
| 21 | 21 | /** |
| 22 | 22 | * @param array $config Configuration options |
| 23 | - * @param int|null $config['namespace'] Namespace to prepend to queries |
|
| 24 | - * @param bool|null $config['relative'] If a namespace is set, |
|
| 25 | - * return a title relative to it (default: true) |
|
| 26 | - * @param bool|null $config['suggestions'] Display search suggestions (default: true) |
|
| 27 | - * @param bool|null $config['highlightFirst'] Automatically highlight |
|
| 28 | - * the first result (default: true) |
|
| 29 | - * @param bool|null $config['validateTitle'] Whether the input must |
|
| 30 | - * be a valid title (default: true) |
|
| 31 | 23 | */ |
| 32 | 24 | public function __construct( array $config = array() ) { |
| 33 | 25 | // Parent constructor |
@@ -109,7 +109,7 @@ discard block |
||
| 109 | 109 | * |
| 110 | 110 | * @todo We can give more info than just the wiki id! |
| 111 | 111 | * @param string $wikiID Wiki'd id (generally database name) |
| 112 | - * @return string|int Wiki's name or $wiki_id if the wiki was not found |
|
| 112 | + * @return string|null Wiki's name or $wiki_id if the wiki was not found |
|
| 113 | 113 | */ |
| 114 | 114 | public static function getWikiName( $wikiID ) { |
| 115 | 115 | $wiki = WikiMap::getWiki( $wikiID ); |
@@ -160,7 +160,7 @@ discard block |
||
| 160 | 160 | * @param string $page Page name (must be normalised before calling this function!) |
| 161 | 161 | * @param string|null $fragmentId |
| 162 | 162 | * |
| 163 | - * @return string|bool URL or false if the wiki was not found |
|
| 163 | + * @return string|false URL or false if the wiki was not found |
|
| 164 | 164 | */ |
| 165 | 165 | public static function getForeignURL( $wikiID, $page, $fragmentId = null ) { |
| 166 | 166 | $wiki = WikiMap::getWiki( $wikiID ); |