@@ -262,6 +262,7 @@ discard block |
||
262 | 262 | * Sets the input xml file to be parsed |
263 | 263 | * |
264 | 264 | * @param string Filename (full path) |
265 | + * @param string $file |
|
265 | 266 | * @return boolean |
266 | 267 | * @access public |
267 | 268 | */ |
@@ -768,7 +769,6 @@ discard block |
||
768 | 769 | * Add an error message |
769 | 770 | * |
770 | 771 | * @param integer $code Error code |
771 | - * @param mixed $message Error message or array with error message parameters |
|
772 | 772 | * @param integer $lineNo Source code line number |
773 | 773 | * @access private |
774 | 774 | */ |
@@ -68,7 +68,6 @@ discard block |
||
68 | 68 | * |
69 | 69 | * @access public |
70 | 70 | * |
71 | - * @param array $options Rendering options. Renderer-specific. |
|
72 | 71 | */ |
73 | 72 | function reset() |
74 | 73 | { |
@@ -130,6 +129,7 @@ discard block |
||
130 | 129 | * Set current language |
131 | 130 | * |
132 | 131 | * @abstract |
132 | + * @param string $lang |
|
133 | 133 | * @return void |
134 | 134 | * @access public |
135 | 135 | * |
@@ -59,7 +59,6 @@ |
||
59 | 59 | |
60 | 60 | /** |
61 | 61 | * Return the message as a DOM element |
62 | - * @param DOMDocument $wsdl The wsdl document the messages will be children of |
|
63 | 62 | */ |
64 | 63 | public function getMessageElement(DOMDocument $dom) |
65 | 64 | { |
@@ -98,6 +98,7 @@ discard block |
||
98 | 98 | |
99 | 99 | /** |
100 | 100 | * @param string a unique prefix for the keys of cached values |
101 | + * @param string $value |
|
101 | 102 | */ |
102 | 103 | public function setKeyPrefix($value) |
103 | 104 | { |
@@ -106,7 +107,7 @@ discard block |
||
106 | 107 | |
107 | 108 | /** |
108 | 109 | * @param string a key identifying a value to be cached |
109 | - * @return sring a key generated from the provided key which ensures the uniqueness across applications |
|
110 | + * @return string a key generated from the provided key which ensures the uniqueness across applications |
|
110 | 111 | */ |
111 | 112 | protected function generateUniqueKey($key) |
112 | 113 | { |
@@ -160,6 +161,8 @@ discard block |
||
160 | 161 | * @param mixed the value to be cached |
161 | 162 | * @param integer the number of seconds in which the cached value will expire. 0 means never expire. |
162 | 163 | * @param ICacheDependency dependency of the cached item. If the dependency changes, the item is labeled invalid. |
164 | + * @param string $id |
|
165 | + * @param string $value |
|
163 | 166 | * @return boolean true if the value is successfully stored into cache, false otherwise |
164 | 167 | */ |
165 | 168 | public function add($id,$value,$expire=0,$dependency=null) |
@@ -198,6 +201,7 @@ discard block |
||
198 | 201 | * in {@link get()} already. So only the implementation of data retrieval |
199 | 202 | * is needed. |
200 | 203 | * @param string a unique key identifying the cached value |
204 | + * @param string $key |
|
201 | 205 | * @return string the value stored in cache, false if the value is not in the cache or expired. |
202 | 206 | */ |
203 | 207 | abstract protected function getValue($key); |
@@ -212,6 +216,8 @@ discard block |
||
212 | 216 | * @param string the key identifying the value to be cached |
213 | 217 | * @param string the value to be cached |
214 | 218 | * @param integer the number of seconds in which the cached value will expire. 0 means never expire. |
219 | + * @param string $key |
|
220 | + * @param integer $expire |
|
215 | 221 | * @return boolean true if the value is successfully stored into cache, false otherwise |
216 | 222 | */ |
217 | 223 | abstract protected function setValue($key,$value,$expire); |
@@ -226,6 +232,8 @@ discard block |
||
226 | 232 | * @param string the key identifying the value to be cached |
227 | 233 | * @param string the value to be cached |
228 | 234 | * @param integer the number of seconds in which the cached value will expire. 0 means never expire. |
235 | + * @param string $key |
|
236 | + * @param integer $expire |
|
229 | 237 | * @return boolean true if the value is successfully stored into cache, false otherwise |
230 | 238 | */ |
231 | 239 | abstract protected function addValue($key,$value,$expire); |
@@ -234,6 +242,7 @@ discard block |
||
234 | 242 | * Deletes a value with the specified key from cache |
235 | 243 | * This method should be implemented by child classes to delete the data from actual cache storage. |
236 | 244 | * @param string the key of the value to be deleted |
245 | + * @param string $key |
|
237 | 246 | * @return boolean if no error happens during deletion |
238 | 247 | */ |
239 | 248 | abstract protected function deleteValue($key); |
@@ -409,6 +418,7 @@ discard block |
||
409 | 418 | /** |
410 | 419 | * Constructor. |
411 | 420 | * @param string the directory to be checked |
421 | + * @param string $directory |
|
412 | 422 | */ |
413 | 423 | public function __construct($directory) |
414 | 424 | { |
@@ -446,6 +456,7 @@ discard block |
||
446 | 456 | |
447 | 457 | /** |
448 | 458 | * @param boolean whether the subdirectories of the directory will also be checked. |
459 | + * @param boolean $value |
|
449 | 460 | */ |
450 | 461 | public function setRecursiveCheck($value) |
451 | 462 | { |
@@ -468,6 +479,7 @@ discard block |
||
468 | 479 | * @param int the depth of the subdirectories to be checked. |
469 | 480 | * If the value is less than 0, it means unlimited depth. |
470 | 481 | * If the value is 0, it means checking the files directly under the specified directory. |
482 | + * @param integer $value |
|
471 | 483 | */ |
472 | 484 | public function setRecursiveLevel($value) |
473 | 485 | { |
@@ -490,6 +502,7 @@ discard block |
||
490 | 502 | * By default, it always returns true, meaning the file should be checked. |
491 | 503 | * You may override this method to check only certain files. |
492 | 504 | * @param string the name of the file that may be checked for dependency. |
505 | + * @param string $fileName |
|
493 | 506 | * @return boolean whether this file should be checked. |
494 | 507 | */ |
495 | 508 | protected function validateFile($fileName) |
@@ -503,6 +516,7 @@ discard block |
||
503 | 516 | * By default, it always returns true, meaning the subdirectory should be checked. |
504 | 517 | * You may override this method to check only certain subdirectories. |
505 | 518 | * @param string the name of the subdirectory that may be checked for dependency. |
519 | + * @param string $directory |
|
506 | 520 | * @return boolean whether this subdirectory should be checked. |
507 | 521 | */ |
508 | 522 | protected function validateDirectory($directory) |
@@ -516,6 +530,7 @@ discard block |
||
516 | 530 | * {@link setRecursiveCheck RecursiveCheck} is set true. |
517 | 531 | * @param string the directory name |
518 | 532 | * @param int level of the recursion |
533 | + * @param string $directory |
|
519 | 534 | * @return array list of file modification time indexed by the file path |
520 | 535 | */ |
521 | 536 | protected function generateTimestamps($directory,$level=0) |
@@ -93,6 +93,7 @@ discard block |
||
93 | 93 | |
94 | 94 | /** |
95 | 95 | * @param boolean whether the keys are case-sensitive. |
96 | + * @param boolean $value |
|
96 | 97 | */ |
97 | 98 | public function setCaseSensitive($value) |
98 | 99 | { |
@@ -126,6 +127,7 @@ discard block |
||
126 | 127 | * Removes an item from the map by its key. |
127 | 128 | * This overrides the parent implementation by converting the key to lower case first if CaseSensitive is false. |
128 | 129 | * @param mixed the key of the item to be removed |
130 | + * @param string $key |
|
129 | 131 | * @return mixed the removed value, null if no such key exists. |
130 | 132 | */ |
131 | 133 | public function remove($key) |
@@ -149,6 +151,7 @@ discard block |
||
149 | 151 | * This method overrides parent implementation by returning true |
150 | 152 | * if the collection contains the named key. |
151 | 153 | * @param string the property name |
154 | + * @param string $name |
|
152 | 155 | * @return boolean whether the property is defined |
153 | 156 | */ |
154 | 157 | public function hasProperty($name) |
@@ -161,6 +164,7 @@ discard block |
||
161 | 164 | * This method overrides parent implementation by returning true |
162 | 165 | * if the collection contains the named key. |
163 | 166 | * @param string the property name |
167 | + * @param string $name |
|
164 | 168 | * @return boolean whether the property can be read |
165 | 169 | */ |
166 | 170 | public function canGetProperty($name) |
@@ -173,6 +177,7 @@ discard block |
||
173 | 177 | * This method overrides parent implementation by always returning true |
174 | 178 | * because you can always add a new value to the collection. |
175 | 179 | * @param string the property name |
180 | + * @param string $name |
|
176 | 181 | * @return boolean true |
177 | 182 | */ |
178 | 183 | public function canSetProperty($name) |
@@ -31,6 +31,7 @@ |
||
31 | 31 | /** |
32 | 32 | * Constructor. |
33 | 33 | * @param integer number of (virtual) items in the data source. |
34 | + * @param integer $count |
|
34 | 35 | */ |
35 | 36 | public function __construct($count) |
36 | 37 | { |
@@ -75,6 +75,7 @@ discard block |
||
75 | 75 | |
76 | 76 | /** |
77 | 77 | * @param boolean whether this list is read-only or not |
78 | + * @param boolean $value |
|
78 | 79 | */ |
79 | 80 | protected function setReadOnly($value) |
80 | 81 | { |
@@ -277,7 +278,7 @@ discard block |
||
277 | 278 | * Finds the base item. If found, the item is inserted after it. |
278 | 279 | * @param mixed the base item which comes before the second parameter when added to the list |
279 | 280 | * @param mixed the item |
280 | - * @return int the index where the item is inserted |
|
281 | + * @return double the index where the item is inserted |
|
281 | 282 | * @throws TInvalidDataValueException if the base item is not within this list |
282 | 283 | * @throws TInvalidOperationException if the list is read-only |
283 | 284 | * @since 3.2a |
@@ -369,6 +370,8 @@ discard block |
||
369 | 370 | * This method is required by the interface ArrayAccess. |
370 | 371 | * @param integer the offset to set item |
371 | 372 | * @param mixed the item value |
373 | + * @param null|integer $offset |
|
374 | + * @param integer $item |
|
372 | 375 | */ |
373 | 376 | public function offsetSet($offset,$item) |
374 | 377 | { |
@@ -385,6 +388,7 @@ discard block |
||
385 | 388 | * Unsets the item at the specified offset. |
386 | 389 | * This method is required by the interface ArrayAccess. |
387 | 390 | * @param integer the offset to unset item |
391 | + * @param integer $offset |
|
388 | 392 | */ |
389 | 393 | public function offsetUnset($offset) |
390 | 394 | { |
@@ -63,6 +63,7 @@ discard block |
||
63 | 63 | |
64 | 64 | /** |
65 | 65 | * @param mixed original data source |
66 | + * @param Traversable $value |
|
66 | 67 | */ |
67 | 68 | public function setDataSource($value) |
68 | 69 | { |
@@ -88,6 +89,7 @@ discard block |
||
88 | 89 | |
89 | 90 | /** |
90 | 91 | * @param integer number of items in each page |
92 | + * @param integer $value |
|
91 | 93 | */ |
92 | 94 | public function setPageSize($value) |
93 | 95 | { |
@@ -107,6 +109,7 @@ discard block |
||
107 | 109 | |
108 | 110 | /** |
109 | 111 | * @param integer current page index |
112 | + * @param integer $value |
|
110 | 113 | */ |
111 | 114 | public function setCurrentPageIndex($value) |
112 | 115 | { |
@@ -125,6 +128,7 @@ discard block |
||
125 | 128 | |
126 | 129 | /** |
127 | 130 | * @param boolean whether to allow paging |
131 | + * @param boolean $value |
|
128 | 132 | */ |
129 | 133 | public function setAllowPaging($value) |
130 | 134 | { |
@@ -141,6 +145,7 @@ discard block |
||
141 | 145 | |
142 | 146 | /** |
143 | 147 | * @param boolean whether to allow custom paging |
148 | + * @param boolean $value |
|
144 | 149 | */ |
145 | 150 | public function setAllowCustomPaging($value) |
146 | 151 | { |
@@ -157,6 +162,7 @@ discard block |
||
157 | 162 | |
158 | 163 | /** |
159 | 164 | * @param integer user-assigned number of items in data source |
165 | + * @param integer $value |
|
160 | 166 | */ |
161 | 167 | public function setVirtualItemCount($value) |
162 | 168 | { |
@@ -290,6 +296,8 @@ discard block |
||
290 | 296 | * @param TList the data to be iterated through |
291 | 297 | * @param integer start index |
292 | 298 | * @param integer number of items to be iterated through |
299 | + * @param integer $startIndex |
|
300 | + * @param integer $count |
|
293 | 301 | */ |
294 | 302 | public function __construct(TList $list,$startIndex,$count) |
295 | 303 | { |
@@ -374,6 +382,8 @@ discard block |
||
374 | 382 | /** |
375 | 383 | * Constructor. |
376 | 384 | * @param array the data to be iterated through |
385 | + * @param integer $startIndex |
|
386 | + * @param integer $count |
|
377 | 387 | */ |
378 | 388 | public function __construct(TMap $map,$startIndex,$count) |
379 | 389 | { |
@@ -76,6 +76,7 @@ discard block |
||
76 | 76 | * Constructor. |
77 | 77 | * @param array|Iterator the initial data. Default is null, meaning no initialization. |
78 | 78 | * @param boolean whether the list is read-only. Always true for paged list. |
79 | + * @param integer[] $data |
|
79 | 80 | */ |
80 | 81 | public function __construct($data=null,$readOnly=false) |
81 | 82 | { |
@@ -92,6 +93,7 @@ discard block |
||
92 | 93 | |
93 | 94 | /** |
94 | 95 | * @param boolean whether to allow custom paging |
96 | + * @param boolean $value |
|
95 | 97 | */ |
96 | 98 | public function setCustomPaging($value) |
97 | 99 | { |
@@ -139,6 +141,7 @@ discard block |
||
139 | 141 | * Raises <b>OnPageIndexChanged</b> event. |
140 | 142 | * This event is raised each time when the list changes to a different page. |
141 | 143 | * @param TPagedListPageChangedEventParameter event parameter |
144 | + * @param TPagedListPageChangedEventParameter|null $param |
|
142 | 145 | */ |
143 | 146 | public function onPageIndexChanged($param) |
144 | 147 | { |
@@ -151,6 +154,7 @@ discard block |
||
151 | 154 | * and needs the new page of data. This event can only be raised when |
152 | 155 | * {@link setCustomPaging CustomPaging} is true. |
153 | 156 | * @param TPagedListFetchDataEventParameter event parameter |
157 | + * @param TPagedListFetchDataEventParameter $param |
|
154 | 158 | */ |
155 | 159 | public function onFetchData($param) |
156 | 160 | { |
@@ -316,6 +320,7 @@ discard block |
||
316 | 320 | |
317 | 321 | /** |
318 | 322 | * @param mixed the item |
323 | + * @param integer $item |
|
319 | 324 | * @return integer the index of the item in the list (0 based), -1 if not found. |
320 | 325 | */ |
321 | 326 | public function indexOf($item) |
@@ -380,6 +385,7 @@ discard block |
||
380 | 385 | /** |
381 | 386 | * Constructor. |
382 | 387 | * @param integer old page index |
388 | + * @param integer $oldPage |
|
383 | 389 | */ |
384 | 390 | public function __construct($oldPage) |
385 | 391 | { |