Completed
Pull Request — develop (#689)
by Alexander
05:50
created
manager/includes/controls/datagrid.class.php 1 patch
Doc Comments   +7 added lines patch added patch discarded remove patch
@@ -72,6 +72,10 @@  discard block
 block discarded – undo
72 72
      */
73 73
     public $cdelim;
74 74
 
75
+    /**
76
+     * @param null|string $id
77
+     * @param string $ds
78
+     */
75 79
     public function __construct($id, $ds, $pageSize = 20, $pageNumber = -1) {
76 80
 		global $__DataGridCnt;
77 81
 
@@ -207,6 +211,9 @@  discard block
 block discarded – undo
207 211
 
208 212
 	// format column values
209 213
 
214
+    /**
215
+     * @param integer $n
216
+     */
210 217
     public function RenderRowFnc($n, $row) {
211 218
 		if($this->_alt == 0) {
212 219
 			$Style = $this->_itemStyle;
Please login to merge, or discard this patch.
manager/includes/extenders/dbapi.mysqli.class.inc.php 1 patch
Doc Comments   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -240,9 +240,9 @@  discard block
 block discarded – undo
240 240
     }
241 241
 
242 242
     /**
243
-     * @param string|array $fields
244
-     * @param string|array $from
245
-     * @param string|array $where
243
+     * @param string $fields
244
+     * @param string $from
245
+     * @param string $where
246 246
      * @param string $orderBy
247 247
      * @param string $limit
248 248
      * @return bool|mysqli_result
@@ -326,7 +326,7 @@  discard block
 block discarded – undo
326 326
      * @param string $fromtable
327 327
      * @param string $where
328 328
      * @param string $limit
329
-     * @return mixed
329
+     * @return null|integer
330 330
      */
331 331
     public function insert($fields, $intotable, $fromfields = "*", $fromtable = "", $where = "", $limit = "")
332 332
     {
@@ -435,7 +435,7 @@  discard block
 block discarded – undo
435 435
 
436 436
     /**
437 437
      * @param null|mysqli $conn
438
-     * @return mixed
438
+     * @return integer
439 439
      */
440 440
     public function getInsertId($conn = null)
441 441
     {
@@ -513,7 +513,7 @@  discard block
 block discarded – undo
513 513
     }
514 514
 
515 515
     /**
516
-     * @param $name
516
+     * @param string $name
517 517
      * @param mysqli_result|string $dsq
518 518
      * @return array
519 519
      */
@@ -572,7 +572,7 @@  discard block
 block discarded – undo
572 572
 
573 573
     /**
574 574
      * @param string $table
575
-     * @return array
575
+     * @return boolean
576 576
      */
577 577
     public function getTableMetaData($table)
578 578
     {
@@ -619,7 +619,7 @@  discard block
 block discarded – undo
619 619
     }
620 620
 
621 621
     /**
622
-     * @param string|mysqli_result $rs
622
+     * @param string $rs
623 623
      * @param bool $index
624 624
      * @return array
625 625
      */
Please login to merge, or discard this patch.
manager/includes/extenders/maketable.class.php 1 patch
Doc Comments   +4 added lines, -7 removed lines patch added patch discarded remove patch
@@ -278,8 +278,7 @@  discard block
 block discarded – undo
278 278
     /**
279 279
      * Sets the width attribute of each column in the array.
280 280
      *
281
-     * @param array $value An Array of column widths in the order of the keys in the
282
-     *            source table array.
281
+     * @param string[] $widthArray
283 282
      */
284 283
     public function setColumnWidths($widthArray)
285 284
     {
@@ -289,7 +288,6 @@  discard block
 block discarded – undo
289 288
     /**
290 289
      * An optional array of values that can be preselected when using
291 290
      *
292
-     * @param array $value Indicates the INPUT form element type attribute.
293 291
      */
294 292
     public function setSelectedValues($valueArray)
295 293
     {
@@ -326,7 +324,7 @@  discard block
 block discarded – undo
326 324
     /**
327 325
      * Determines what class the current row should have applied.
328 326
      *
329
-     * @param int $value The position of the current row being rendered.
327
+     * @param integer $position
330 328
      * @return string
331 329
      */
332 330
     public function determineRowClass($position)
@@ -353,7 +351,6 @@  discard block
 block discarded – undo
353 351
      * Generates an onclick action applied to the current cell, to execute
354 352
      * any specified cell actions.
355 353
      *
356
-     * @param string $value Indicates the INPUT form element type attribute.
357 354
      * @return string
358 355
      */
359 356
     public function getCellAction($currentActionFieldValue)
@@ -395,7 +392,7 @@  discard block
 block discarded – undo
395 392
     /**
396 393
      * Function to prepare a link generated in the table cell/link actions.
397 394
      *
398
-     * @param string $value Indicates the INPUT form element type attribute.
395
+     * @param string $link
399 396
      * @return string
400 397
      */
401 398
     public function prepareLink($link)
@@ -414,7 +411,7 @@  discard block
 block discarded – undo
414 411
      *
415 412
      * @param array $fieldsArray The associative array representing the table rows
416 413
      * and columns.
417
-     * @param array $fieldHeadersArray An optional array of values for providing
414
+     * @param string[] $fieldHeadersArray An optional array of values for providing
418 415
      * alternative field headers; this is an associative arrays of keys from
419 416
      * the $fieldsArray where the values represent the alt heading content
420 417
      * for each column.
Please login to merge, or discard this patch.
manager/includes/extenders/modifiers.class.inc.php 1 patch
Doc Comments   +25 added lines, -1 removed lines patch added patch discarded remove patch
@@ -95,7 +95,7 @@  discard block
 block discarded – undo
95 95
     /**
96 96
      * @param string $mode
97 97
      * @param string $modifiers
98
-     * @return bool|string
98
+     * @return false|string
99 99
      */
100 100
     public function _getDelim($mode,$modifiers) {
101 101
         $c = substr($modifiers,0,1);
@@ -132,6 +132,14 @@  discard block
 block discarded – undo
132 132
             return $opt;
133 133
         }
134 134
     }
135
+
136
+    /**
137
+     * @param string $mode
138
+     * @param false|string $delim
139
+     * @param string $modifiers
140
+     *
141
+     * @return string
142
+     */
135 143
     public function _getRemainModifiers($mode,$delim,$modifiers) {
136 144
         if($delim) {
137 145
             if($mode=='(')
@@ -159,6 +167,9 @@  discard block
 block discarded – undo
159 167
         return substr($string,strpos($string, $delim)+$len);
160 168
     }
161 169
 
170
+    /**
171
+     * @param string $modifiers
172
+     */
162 173
     public function splitEachModifiers($modifiers) {
163 174
         global $modx;
164 175
 
@@ -228,6 +239,9 @@  discard block
 block discarded – undo
228 239
         return $result;
229 240
     }
230 241
 
242
+    /**
243
+     * @param string $key
244
+     */
231 245
     public function parsePhx($key,$value,$modifiers)
232 246
     {
233 247
         global $modx;
@@ -294,6 +308,9 @@  discard block
 block discarded – undo
294 308
         else                  return true;
295 309
     }
296 310
 
311
+    /**
312
+     * @param string $cmd
313
+     */
297 314
     public function getValueFromPreset($key, $value, $cmd, $opt)
298 315
     {
299 316
         global $modx;
@@ -979,6 +996,9 @@  discard block
 block discarded – undo
979 996
         return $value;
980 997
     }
981 998
 
999
+    /**
1000
+     * @param string $cmd
1001
+     */
982 1002
     public function includeMdfFile($cmd) {
983 1003
         global $modx;
984 1004
         $key = $this->key;
@@ -1134,6 +1154,10 @@  discard block
 block discarded – undo
1134 1154
     }
1135 1155
 
1136 1156
     // Sets a placeholder variable which can only be access by Modifiers
1157
+
1158
+    /**
1159
+     * @param string $value
1160
+     */
1137 1161
     public function setModifiersVariable($key, $value) {
1138 1162
         if ($key != 'phx' && $key != 'dummy') $this->placeholders[$key] = $value;
1139 1163
     }
Please login to merge, or discard this patch.
manager/includes/paginate.inc.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -149,7 +149,7 @@
 block discarded – undo
149 149
     /**
150 150
      * This function returns the current page number.
151 151
      *
152
-     * @return int
152
+     * @return string
153 153
      */
154 154
     public function getCurrentPage()
155 155
     {
Please login to merge, or discard this patch.
manager/includes/protect.inc.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -16,7 +16,7 @@
 block discarded – undo
16 16
 // sanitize array
17 17
 if (!function_exists('modx_sanitize_gpc')) {
18 18
     /**
19
-     * @param array|string $values
19
+     * @param string $values
20 20
      * @param int $depth
21 21
      * @return array|string
22 22
      */
Please login to merge, or discard this patch.
manager/includes/tmplvars.commands.inc.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -163,7 +163,7 @@
 block discarded – undo
163 163
  *
164 164
  * @param string $param
165 165
  * @param array $tvsArray
166
- * @return mixed
166
+ * @return string
167 167
  */
168 168
 function parseTvValues($param, $tvsArray)
169 169
 {
Please login to merge, or discard this patch.
manager/includes/tmplvars.format.inc.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -349,7 +349,7 @@
 block discarded – undo
349 349
 /**
350 350
  * returns an array if a delimiter is present. returns array is a recordset is present
351 351
  *
352
- * @param $src
352
+ * @param string $src
353 353
  * @param string $delim
354 354
  * @param string $type
355 355
  * @param bool $columns
Please login to merge, or discard this patch.
manager/includes/tmplvars.inc.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -381,7 +381,7 @@
 block discarded – undo
381 381
 } // end renderFormElement function
382 382
 
383 383
 /**
384
- * @param string|array|mysqli_result $v
384
+ * @param string $v
385 385
  * @return array
386 386
  */
387 387
 function ParseIntputOptions($v) {
Please login to merge, or discard this patch.