@@ -66,7 +66,7 @@ |
||
66 | 66 | /** |
67 | 67 | * @since 1.9 |
68 | 68 | * |
69 | - * @return true |
|
69 | + * @return boolean |
|
70 | 70 | */ |
71 | 71 | public function process() { |
72 | 72 |
@@ -22,7 +22,7 @@ |
||
22 | 22 | * @param Parser $parser |
23 | 23 | * @param ProcessingResult $result |
24 | 24 | * |
25 | - * @return mixed |
|
25 | + * @return string |
|
26 | 26 | */ |
27 | 27 | public function handle( Parser $parser, ProcessingResult $result ) { |
28 | 28 | $parameters = $result->getParameters(); |
@@ -40,7 +40,7 @@ |
||
40 | 40 | * |
41 | 41 | * @param Store $store |
42 | 42 | * @param PropertyStatisticsStore $propertyStatisticsStore |
43 | - * @param RequestOptions $requestOptions|null |
|
43 | + * @param RequestOptions $requestOptions |
|
44 | 44 | */ |
45 | 45 | public function __construct( Store $store, PropertyStatisticsStore $propertyStatisticsStore, RequestOptions $requestOptions = null ) { |
46 | 46 | $this->store = $store; |
@@ -177,7 +177,7 @@ |
||
177 | 177 | /** |
178 | 178 | * @since 2.2 |
179 | 179 | * |
180 | - * @return array |
|
180 | + * @return string[] |
|
181 | 181 | */ |
182 | 182 | public function getErrors() { |
183 | 183 | return $this->errors; |
@@ -43,7 +43,7 @@ |
||
43 | 43 | /** |
44 | 44 | * Returns the name of the class to be tested |
45 | 45 | * |
46 | - * @return string|false |
|
46 | + * @return boolean |
|
47 | 47 | */ |
48 | 48 | public function getClass() { |
49 | 49 | return false; |
@@ -35,7 +35,7 @@ |
||
35 | 35 | /** |
36 | 36 | * Returns the name of the class to be tested |
37 | 37 | * |
38 | - * @return string|false |
|
38 | + * @return string |
|
39 | 39 | */ |
40 | 40 | public function getClass() { |
41 | 41 | return '\SMW\AggregatablePrinter'; |
@@ -134,6 +134,7 @@ discard block |
||
134 | 134 | * but just controls query generation. For general effect, the default namespaces |
135 | 135 | * should be set to NULL. |
136 | 136 | * |
137 | + * @param boolean $setNS |
|
137 | 138 | * @return Description|null |
138 | 139 | */ |
139 | 140 | private function getSubqueryDescription( &$setNS ) { |
@@ -242,6 +243,7 @@ discard block |
||
242 | 243 | * be the content of "[[ ... ]]". Returns NULL upon error. |
243 | 244 | * |
244 | 245 | * Parameters $setNS has the same use as in getSubqueryDescription(). |
246 | + * @param boolean $setNS |
|
245 | 247 | */ |
246 | 248 | private function getLinkDescription( &$setNS ) { |
247 | 249 | // This method is called when we encountered an opening '[['. The following |
@@ -424,6 +426,7 @@ discard block |
||
424 | 426 | * a category or property) and create a suitable description. |
425 | 427 | * The first chunk behind the "[[" has already been read and is |
426 | 428 | * passed as a parameter. |
429 | + * @param string $firstChunk |
|
427 | 430 | */ |
428 | 431 | private function getArticleDescription( $firstChunk, &$setNS ) { |
429 | 432 | $chunk = $firstChunk; |
@@ -469,6 +472,10 @@ discard block |
||
469 | 472 | return $this->finishLinkDescription( $chunk, true, $result, $setNS ); |
470 | 473 | } |
471 | 474 | |
475 | + /** |
|
476 | + * @param boolean $hasNamespaces |
|
477 | + * @param Description|null $result |
|
478 | + */ |
|
472 | 479 | private function finishLinkDescription( $chunk, $hasNamespaces, $result, &$setNS ) { |
473 | 480 | if ( is_null( $result ) ) { // no useful information or concrete error found |
474 | 481 | $this->descriptionProcessor->addErrorForMsgCode( 'smw_unexpectedpart', $chunk ); // was smw_badqueryatom |
@@ -565,6 +572,7 @@ discard block |
||
565 | 572 | /** |
566 | 573 | * Enter a new subblock in the query, which must at some time be terminated by the |
567 | 574 | * given $endstring delimiter calling popDelimiter(); |
575 | + * @param string $endstring |
|
568 | 576 | */ |
569 | 577 | private function pushDelimiter( $endstring ) { |
570 | 578 | array_push( $this->separatorStack, $endstring ); |
@@ -574,6 +582,7 @@ discard block |
||
574 | 582 | * Exit a subblock in the query ending with the given delimiter. |
575 | 583 | * If the delimiter does not match the top-most open block, false |
576 | 584 | * will be returned. Otherwise return true. |
585 | + * @param string $endstring |
|
577 | 586 | */ |
578 | 587 | private function popDelimiter( $endstring ) { |
579 | 588 | $topdelim = array_pop( $this->separatorStack ); |
@@ -166,6 +166,7 @@ discard block |
||
166 | 166 | * |
167 | 167 | * The return value is the expected combined description. The object $currentDescription will |
168 | 168 | * also be changed (if it was non-NULL). |
169 | + * @param integer $compoundType |
|
169 | 170 | */ |
170 | 171 | private function getCompoundDescription( Description $currentDescription = null, Description $newDescription = null, $compoundType = SMW_CONJUNCTION_QUERY ) { |
171 | 172 | |
@@ -201,6 +202,10 @@ discard block |
||
201 | 202 | } |
202 | 203 | } |
203 | 204 | |
205 | + /** |
|
206 | + * @param Description $currentDescription |
|
207 | + * @param Description $newDescription |
|
208 | + */ |
|
204 | 209 | private function newCompoundDescriptionFor( $compoundType, $currentDescription, $newDescription ) { |
205 | 210 | |
206 | 211 | if ( ( ( $compoundType & SMW_CONJUNCTION_QUERY ) != 0 && ( $currentDescription instanceof Conjunction ) ) || |
@@ -145,7 +145,7 @@ discard block |
||
145 | 145 | * |
146 | 146 | * @param string $text |
147 | 147 | * |
148 | - * @return text |
|
148 | + * @return string |
|
149 | 149 | */ |
150 | 150 | public static function decodeSquareBracket( $text ) { |
151 | 151 | return str_replace( array( '%5B', '%5D' ), array( '[', ']' ), $text ); |
@@ -156,7 +156,7 @@ discard block |
||
156 | 156 | * |
157 | 157 | * @param string $text |
158 | 158 | * |
159 | - * @return text |
|
159 | + * @return string |
|
160 | 160 | */ |
161 | 161 | public static function obscureAnnotation( $text ) { |
162 | 162 | return preg_replace_callback( |
@@ -173,7 +173,7 @@ discard block |
||
173 | 173 | * |
174 | 174 | * @param string $text |
175 | 175 | * |
176 | - * @return text |
|
176 | + * @return string |
|
177 | 177 | */ |
178 | 178 | public static function removeAnnotation( $text ) { |
179 | 179 | return preg_replace_callback( |
@@ -230,7 +230,7 @@ discard block |
||
230 | 230 | * |
231 | 231 | * @since 1.9 |
232 | 232 | * |
233 | - * @return array |
|
233 | + * @return string[] |
|
234 | 234 | */ |
235 | 235 | protected function getModules() { |
236 | 236 | return array( |