evolution-cms / evolution

manager/includes/extenders/maketable.class.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/paginate.inc.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()
     {

manager/includes/protect.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -16,7 +16,7 @@
 // sanitize array
 if (!function_exists('modx_sanitize_gpc')) {
     /**
-     * @param array|string $values
+     * @param string $values
      * @param int $depth
      * @return array|string
      */

manager/includes/tmplvars.commands.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -163,7 +163,7 @@
  *
  * @param string $param
  * @param array $tvsArray
- * @return mixed
+ * @return string
  */
 function parseTvValues($param, $tvsArray)
 {

manager/includes/tmplvars.format.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -349,7 +349,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

manager/includes/tmplvars.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -381,7 +381,7 @@
 } // end renderFormElement function
 
 /**
- * @param string|array|mysqli_result $v
+ * @param string $v
  * @return array
  */
 function ParseIntputOptions($v) {

manager/processors/cache_sync.class.processor.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/document.parser.class.inc.php

Doc Comments +25 added lines, -25 removed lines

@@ -277,7 +277,7 @@ 
      * MODX_MANAGER_PATH."includes/extenders/ex_{$extname}.inc.php"
      * $extname - extension name in lowercase
      *
-     * @param $extname
+     * @param string $extname
      * @param bool $reload
      * @return bool
      */
@@ -320,7 +320,7 @@ 
      * @param int $count_attempts
      * @param string $type $type
      * @param string $responseCode
-     * @return bool|null
+     * @return false|null
      * @global string $base_url
      * @global string $site_url
      */
@@ -1021,7 +1021,7 @@ 
     }
 
     /**
-     * @param $contents
+     * @param string $contents
      * @return mixed
      */
     public function RecoveryEscapedTags($contents)
@@ -1045,7 +1045,7 @@ 
     }
 
     /**
-     * @param $tstart
+     * @param double $tstart
      * @return array
      */
     public function getTimerStats($tstart)
@@ -1797,7 +1797,7 @@ 
 
     /**
      * Remove Comment-Tags from output like <!--@- Comment -@-->
-     * @param $content
+     * @param string $content
      * @param string $left
      * @param string $right
      * @return mixed
@@ -1970,7 +1970,7 @@ 
     /**
      * Run snippets as per the tags in $documentSource and replace the tags with the returned values.
      *
-     * @param $content
+     * @param string $content
      * @return string
      * @internal param string $documentSource
      */
@@ -3002,7 +3002,7 @@ 
 
     /**
      * @param $templateID
-     * @return mixed
+     * @return string
      */
     public function _getTemplateCodeFromDB($templateID)
     {
@@ -3043,9 +3043,9 @@ 
     }
 
     /**
-     * @param $id
+     * @param integer $id
      * @param int $top
-     * @return mixed
+     * @return string
      */
     public function getUltimateParentId($id, $top = 0)
     {
@@ -3376,7 +3376,7 @@ 
      *
      * @param int $type Types: 1=template, 2=tv, 3=chunk, 4=snippet, 5=plugin, 6=module, 7=resource, 8=role
      * @param int $id Element- / Resource-id
-     * @return bool
+     * @return false|null
      */
     public function lockElement($type, $id)
     {
@@ -3398,7 +3398,7 @@ 
      * @param int $type Types: 1=template, 2=tv, 3=chunk, 4=snippet, 5=plugin, 6=module, 7=resource, 8=role
      * @param int $id Element- / Resource-id
      * @param bool $includeAllUsers true = Deletes not only own user-locks
-     * @return bool
+     * @return false|null
      */
     public function unlockElement($type, $id, $includeAllUsers = false)
     {
@@ -3506,7 +3506,7 @@ 
      * @param array $params
      * @param string $msg
      * @param array $files
-     * @return mixed
+     * @return boolean
      */
     public function sendmail($params = array(), $msg = '', $files = array())
     {
@@ -3910,7 +3910,7 @@ 
      *                     Default: 1
      * @param string $fields List of fields
      *                       Default: id, pagetitle, description, alias
-     * @return boolean|array
+     * @return string
      */
     public function getPageInfo($pageid = -1, $active = 1, $fields = 'id, pagetitle, description, alias')
     {
@@ -4002,7 +4002,7 @@ 
      *
      * @param string $type
      * @param bool $report
-     * @return bool
+     * @return boolean|null
      */
     public function clearCache($type = '', $report = false)
     {
@@ -4369,7 +4369,7 @@ 
      * - Placeholders prefix. Default: '{'.
      * @param string $suffix {string}
      * - Placeholders suffix. Default: '}'.
-     * @return bool|mixed|string {string; false} - Parsed chunk or false if $chunkArr is not array.
+     * @return false|string {string; false} - Parsed chunk or false if $chunkArr is not array.
      * - Parsed chunk or false if $chunkArr is not array.
      */
     public function parseChunk($chunkName, $chunkArr, $prefix = '{', $suffix = '}')
@@ -5345,7 +5345,7 @@ 
      * Remove event listener - only for use within the current execution cycle
      *
      * @param string $evtName
-     * @return boolean
+     * @return false|null
      */
     public function removeEventListener($evtName)
     {
@@ -5369,7 +5369,7 @@ 
      *
      * @param string $evtName
      * @param array $extParams Parameters available to plugins. Each array key will be the PHP variable name, and the array value will be the variable value.
-     * @return boolean|array
+     * @return false|null
      */
     public function invokeEvent($evtName, $extParams = array())
     {
@@ -5968,7 +5968,7 @@ 
 
     /**
      * @param string $str
-     * @return bool|mixed|string
+     * @return string
      */
     public function atBindFileContent($str = '')
     {
@@ -6019,8 +6019,8 @@ 
     }
 
     /**
-     * @param $str
-     * @return bool|string
+     * @param string $str
+     * @return false|string
      */
     public function getExtFromFilename($str)
     {
@@ -6048,7 +6048,7 @@ 
      * @param string $text Error message
      * @param string $file File where the error was detected
      * @param string $line Line number within $file
-     * @return boolean
+     * @return boolean|null
      */
     public function phpError($nr, $text, $file, $line)
     {
@@ -6100,7 +6100,7 @@ 
      * @param string $text
      * @param string $line
      * @param string $output
-     * @return bool
+     * @return null|boolean
      */
     public function messageQuit($msg = 'unspecified error', $query = '', $is_error = true, $nr = '', $file = '', $source = '', $text = '', $line = '', $output = '')
     {
@@ -6522,7 +6522,7 @@ 
 
     /**
      * @param string $str
-     * @return bool|mixed|string
+     * @return string
      */
     public function atBindInclude($str = '')
     {
@@ -6573,7 +6573,7 @@ 
      * @param $str
      * @param int $flags
      * @param string $encode
-     * @return mixed
+     * @return string
      */
     public function htmlspecialchars($str, $flags = ENT_COMPAT, $encode = '')
     {
@@ -6582,7 +6582,7 @@ 
     }
 
     /**
-     * @param $string
+     * @param string $string
      * @param bool $returnData
      * @return bool|mixed
      */

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

Doc Comments +11 added lines

@@ -414,6 +414,9 @@ 
         }
     }
 
+    /**
+     * @param string $table
+     */
     public function save($fields, $table, $where = '')
     {
 
@@ -444,6 +447,7 @@ 
     /**
      * @name:  freeResult
      *
+     * @param mysqli_result $rs
      */
     public function freeResult($rs)
     {
@@ -554,6 +558,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 +725,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $table_name
+     */
     public function optimize($table_name)
     {
         $rs = $this->query("OPTIMIZE TABLE {$table_name}");
@@ -730,6 +738,9 @@ 
         return $rs;
     }
 
+    /**
+     * @param string $table_name
+     */
     public function truncate($table_name)
     {
         $rs = $this->query("TRUNCATE {$table_name}");