evolution-cms / evolution

manager/includes/extenders/deprecated.functions.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
      * @deprecated
      *
      * @param $rs
-     * @return int|mixed
+     * @return integer
      */
     public function insertId($rs)
     {

manager/includes/extenders/modifiers.class.inc.php

Doc Comments +27 added lines, -1 removed lines

@@ -94,7 +94,7 @@ 
     /**
      * @param string $mode
      * @param string $modifiers
-     * @return bool|string
+     * @return false|string
      */
     public function _getDelim($mode,$modifiers) {
         $c = substr($modifiers,0,1);
@@ -131,6 +131,14 @@ 
             return $opt;
         }
     }
+
+    /**
+     * @param string $mode
+     * @param false|string $delim
+     * @param string $modifiers
+     *
+     * @return string
+     */
     public function _getRemainModifiers($mode,$delim,$modifiers) {
         if($delim) {
             if($mode=='(')
@@ -158,6 +166,9 @@ 
         return substr($string,strpos($string, $delim)+$len);
     }
 
+    /**
+     * @param string $modifiers
+     */
     public function splitEachModifiers($modifiers) {
         $modx = evolutionCMS();
 
@@ -227,6 +238,10 @@ 
         return $result;
     }
 
+    /**
+     * @param string $key
+     * @param string $value
+     */
     public function parsePhx($key,$value,$modifiers)
     {
         $modx = evolutionCMS();
@@ -293,6 +308,10 @@ 
         else                  return true;
     }
 
+    /**
+     * @param string $cmd
+     * @param string $opt
+     */
     public function getValueFromPreset($key, $value, $cmd, $opt)
     {
         $modx = evolutionCMS();
@@ -978,6 +997,9 @@ 
         return $value;
     }
 
+    /**
+     * @param string $cmd
+     */
     public function includeMdfFile($cmd) {
         $modx = evolutionCMS();
         $key = $this->key;
@@ -1133,6 +1155,10 @@ 
     }
 
     // Sets a placeholder variable which can only be access by Modifiers
+
+    /**
+     * @param string $value
+     */
     public function setModifiersVariable($key, $value) {
         if ($key != 'phx' && $key != 'dummy') $this->placeholders[$key] = $value;
     }

install/cli-install.php

Doc Comments +1 added lines, -1 removed lines

@@ -130,7 +130,7 @@
      * duplicate of method in documentParser class
      *
      * @param string $propertyString
-     * @return array
+     * @return string
      */
     function parseProperties($propertyString) {
         $parameter= array ();

manager/includes/extenders/dbapi.mysql.class.inc.php

Doc Comments +12 added lines

@@ -268,6 +268,7 @@ 
     /**
      * @name:  delete
      *
+     * @param string $from
      */
     public function delete($from, $where = '', $orderby = '', $limit = '')
     {
@@ -414,6 +415,9 @@ 
         }
     }
 
+    /**
+     * @param string $table
+     */
     public function save($fields, $table, $where = '')
     {
 
@@ -444,6 +448,7 @@ 
     /**
      * @name:  freeResult
      *
+     * @param mysqli_result $rs
      */
     public function freeResult($rs)
     {
@@ -554,6 +559,7 @@ 
      * @name:  getColumn
      * @desc:  returns an array of the values found on colun $name
      * @param: $dsq - dataset or query string
+     * @param string $name
      */
     public function getColumn($name, $dsq)
     {
@@ -720,6 +726,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $table_name
+     */
     public function optimize($table_name)
     {
         $rs = $this->query("OPTIMIZE TABLE {$table_name}");
@@ -730,6 +739,9 @@ 
         return $rs;
     }
 
+    /**
+     * @param string $table_name
+     */
     public function truncate($table_name)
     {
         $rs = $this->query("TRUNCATE {$table_name}");

manager/includes/functions/tv.php

Doc Comments +3 added lines, -3 removed lines

@@ -172,7 +172,7 @@ 
      *
      * @param string $param
      * @param array $tvsArray
-     * @return mixed
+     * @return string
      */
     function parseTvValues($param, $tvsArray)
     {
@@ -566,7 +566,7 @@ 
     /**
      * returns an array if a delimiter is present. returns array is a recordset is present
      *
-     * @param $src
+     * @param string $src
      * @param string $delim
      * @param string $type
      * @param bool $columns
@@ -1022,7 +1022,7 @@ 
 
 if (! function_exists('ParseIntputOptions')) {
     /**
-     * @param string|array|mysqli_result $v
+     * @param string $v
      * @return array
      */
     function ParseIntputOptions($v)

manager/includes/src/Cache.php

Doc Comments +1 added lines, -1 removed lines

@@ -237,7 +237,7 @@
     /**
      * build siteCache file
      * @param DocumentParser $modx
-     * @return boolean success
+     * @return null|boolean success
      */
     public function buildCache($modx)
     {

manager/includes/src/Event.php

Doc Comments +1 added lines, -1 removed lines

@@ -63,7 +63,7 @@
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getOutput()
     {

manager/includes/src/Support/MakeTable.php

Doc Comments +4 added lines, -7 removed lines

@@ -278,8 +278,7 @@ 
     /**
      * Sets the width attribute of each column in the array.
      *
-     * @param array $value An Array of column widths in the order of the keys in the
-     *            source table array.
+     * @param string[] $widthArray
      */
     public function setColumnWidths($widthArray)
     {
@@ -289,7 +288,6 @@ 
     /**
      * An optional array of values that can be preselected when using
      *
-     * @param array $value Indicates the INPUT form element type attribute.
      */
     public function setSelectedValues($valueArray)
     {
@@ -326,7 +324,7 @@ 
     /**
      * Determines what class the current row should have applied.
      *
-     * @param int $value The position of the current row being rendered.
+     * @param integer $position
      * @return string
      */
     public function determineRowClass($position)
@@ -353,7 +351,6 @@ 
      * Generates an onclick action applied to the current cell, to execute
      * any specified cell actions.
      *
-     * @param string $value Indicates the INPUT form element type attribute.
      * @return string
      */
     public function getCellAction($currentActionFieldValue)
@@ -395,7 +392,7 @@ 
     /**
      * Function to prepare a link generated in the table cell/link actions.
      *
-     * @param string $value Indicates the INPUT form element type attribute.
+     * @param string $link
      * @return string
      */
     public function prepareLink($link)
@@ -414,7 +411,7 @@ 
      *
      * @param array $fieldsArray The associative array representing the table rows
      * and columns.
-     * @param array $fieldHeadersArray An optional array of values for providing
+     * @param string[] $fieldHeadersArray An optional array of values for providing
      * alternative field headers; this is an associative arrays of keys from
      * the $fieldsArray where the values represent the alt heading content
      * for each column.

manager/includes/src/Support/Paginate.php

Doc Comments +1 added lines, -1 removed lines

@@ -149,7 +149,7 @@
     /**
      * This function returns the current page number.
      *
-     * @return int
+     * @return string
      */
     public function getCurrentPage()
     {