@@ -278,8 +278,7 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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. |
@@ -149,7 +149,7 @@ |
||
| 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 | { |
@@ -16,7 +16,7 @@ |
||
| 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 | */ |
@@ -163,7 +163,7 @@ |
||
| 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 | { |
@@ -349,7 +349,7 @@ |
||
| 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 |
@@ -381,7 +381,7 @@ |
||
| 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) { |
@@ -237,7 +237,7 @@ |
||
| 237 | 237 | /** |
| 238 | 238 | * build siteCache file |
| 239 | 239 | * @param DocumentParser $modx |
| 240 | - * @return boolean success |
|
| 240 | + * @return null|boolean success |
|
| 241 | 241 | */ |
| 242 | 242 | public function buildCache($modx) |
| 243 | 243 | { |
@@ -414,6 +414,9 @@ discard block |
||
| 414 | 414 | } |
| 415 | 415 | } |
| 416 | 416 | |
| 417 | + /** |
|
| 418 | + * @param string $table |
|
| 419 | + */ |
|
| 417 | 420 | public function save($fields, $table, $where = '') |
| 418 | 421 | { |
| 419 | 422 | |
@@ -444,6 +447,7 @@ discard block |
||
| 444 | 447 | /** |
| 445 | 448 | * @name: freeResult |
| 446 | 449 | * |
| 450 | + * @param mysqli_result $rs |
|
| 447 | 451 | */ |
| 448 | 452 | public function freeResult($rs) |
| 449 | 453 | { |
@@ -554,6 +558,7 @@ discard block |
||
| 554 | 558 | * @name: getColumn |
| 555 | 559 | * @desc: returns an array of the values found on colun $name |
| 556 | 560 | * @param: $dsq - dataset or query string |
| 561 | + * @param string $name |
|
| 557 | 562 | */ |
| 558 | 563 | public function getColumn($name, $dsq) |
| 559 | 564 | { |
@@ -720,6 +725,9 @@ discard block |
||
| 720 | 725 | return $result; |
| 721 | 726 | } |
| 722 | 727 | |
| 728 | + /** |
|
| 729 | + * @param string $table_name |
|
| 730 | + */ |
|
| 723 | 731 | public function optimize($table_name) |
| 724 | 732 | { |
| 725 | 733 | $rs = $this->query("OPTIMIZE TABLE {$table_name}"); |
@@ -730,6 +738,9 @@ discard block |
||
| 730 | 738 | return $rs; |
| 731 | 739 | } |
| 732 | 740 | |
| 741 | + /** |
|
| 742 | + * @param string $table_name |
|
| 743 | + */ |
|
| 733 | 744 | public function truncate($table_name) |
| 734 | 745 | { |
| 735 | 746 | $rs = $this->query("TRUNCATE {$table_name}"); |
@@ -240,9 +240,9 @@ discard block |
||
| 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 |
||
| 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 | { |
@@ -368,7 +368,7 @@ discard block |
||
| 368 | 368 | |
| 369 | 369 | /** |
| 370 | 370 | * @param $fields |
| 371 | - * @param $table |
|
| 371 | + * @param string $table |
|
| 372 | 372 | * @param string $where |
| 373 | 373 | * @return bool|mixed|mysqli_result |
| 374 | 374 | */ |
@@ -435,7 +435,7 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 | */ |