evolution-cms / evolution

install/instprocessor.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/actions/files.dynamic.php

Doc Comments +2 added lines, -2 removed lines

@@ -719,7 +719,7 @@ 
 
 /**
  * @param string $string
- * @return bool|string
+ * @return string|false
  */
 function removeLastPath($string)
 {
@@ -734,7 +734,7 @@ 
 
 /**
  * @param string $string
- * @return bool|string
+ * @return string|false
  */
 function getExtension($string)
 {

manager/actions/import_site.static.php

Doc Comments +1 added lines, -1 removed lines

@@ -344,7 +344,7 @@
 
 /**
  * @param string $filepath
- * @return bool|string
+ * @return null|string
  */
 function getFileContent($filepath) {
 	global $_lang;

manager/includes/document.parser.class.inc.php

Doc Comments +24 added lines, -24 removed lines

@@ -256,7 +256,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
      */
@@ -299,7 +299,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
      */
@@ -1000,7 +1000,7 @@ 
     }
 
     /**
-     * @param $contents
+     * @param string $contents
      * @return mixed
      */
     public function RecoveryEscapedTags($contents)
@@ -1024,7 +1024,7 @@ 
     }
 
     /**
-     * @param $tstart
+     * @param double $tstart
      * @return array
      */
     public function getTimerStats($tstart)
@@ -1776,7 +1776,7 @@ 
 
     /**
      * Remove Comment-Tags from output like <!--@- Comment -@-->
-     * @param $content
+     * @param string $content
      * @param string $left
      * @param string $right
      * @return mixed
@@ -1949,7 +1949,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
      */
@@ -2981,7 +2981,7 @@ 
 
     /**
      * @param $templateID
-     * @return mixed
+     * @return string
      */
     public function _getTemplateCodeFromDB($templateID)
     {
@@ -3022,9 +3022,9 @@ 
     }
 
     /**
-     * @param $id
+     * @param integer $id
      * @param int $top
-     * @return mixed
+     * @return string
      */
     public function getUltimateParentId($id, $top = 0)
     {
@@ -3355,7 +3355,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)
     {
@@ -3377,7 +3377,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)
     {
@@ -3485,7 +3485,7 @@ 
      * @param array $params
      * @param string $msg
      * @param array $files
-     * @return mixed
+     * @return boolean
      */
     public function sendmail($params = array(), $msg = '', $files = array())
     {
@@ -3981,7 +3981,7 @@ 
      *
      * @param string $type
      * @param bool $report
-     * @return bool
+     * @return boolean|null
      */
     public function clearCache($type = '', $report = false)
     {
@@ -4348,7 +4348,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 = '}')
@@ -5324,7 +5324,7 @@ 
      * Remove event listener - only for use within the current execution cycle
      *
      * @param string $evtName
-     * @return boolean
+     * @return false|null
      */
     public function removeEventListener($evtName)
     {
@@ -5348,7 +5348,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())
     {
@@ -5947,7 +5947,7 @@ 
 
     /**
      * @param string $str
-     * @return bool|mixed|string
+     * @return string
      */
     public function atBindFileContent($str = '')
     {
@@ -5998,8 +5998,8 @@ 
     }
 
     /**
-     * @param $str
-     * @return bool|string
+     * @param string $str
+     * @return false|string
      */
     public function getExtFromFilename($str)
     {
@@ -6027,7 +6027,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)
     {
@@ -6079,7 +6079,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 = '')
     {
@@ -6501,7 +6501,7 @@ 
 
     /**
      * @param string $str
-     * @return bool|mixed|string
+     * @return string
      */
     public function atBindInclude($str = '')
     {
@@ -6552,7 +6552,7 @@ 
      * @param $str
      * @param int $flags
      * @param string $encode
-     * @return mixed
+     * @return string
      */
     public function htmlspecialchars($str, $flags = ENT_COMPAT, $encode = '')
     {
@@ -6561,7 +6561,7 @@ 
     }
 
     /**
-     * @param $string
+     * @param string $string
      * @param bool $returnData
      * @return bool|mixed
      */

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

Doc Comments +8 added lines, -8 removed lines

@@ -240,9 +240,9 @@ 
     }
 
     /**
-     * @param string|array $fields
-     * @param string|array $from
-     * @param string|array $where
+     * @param string $fields
+     * @param string $from
+     * @param string $where
      * @param string $orderBy
      * @param string $limit
      * @return bool|mysqli_result
@@ -326,7 +326,7 @@ 
      * @param string $fromtable
      * @param string $where
      * @param string $limit
-     * @return mixed
+     * @return null|integer
      */
     public function insert($fields, $intotable, $fromfields = "*", $fromtable = "", $where = "", $limit = "")
     {
@@ -435,7 +435,7 @@ 
 
     /**
      * @param null|mysqli $conn
-     * @return mixed
+     * @return integer
      */
     public function getInsertId($conn = null)
     {
@@ -513,7 +513,7 @@ 
     }
 
     /**
-     * @param $name
+     * @param string $name
      * @param mysqli_result|string $dsq
      * @return array
      */
@@ -572,7 +572,7 @@ 
 
     /**
      * @param string $table
-     * @return array
+     * @return boolean
      */
     public function getTableMetaData($table)
     {
@@ -619,7 +619,7 @@ 
     }
 
     /**
-     * @param string|mysqli_result $rs
+     * @param string $rs
      * @param bool $index
      * @return array
      */

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/extenders/modifiers.class.inc.php

Doc Comments +25 added lines, -1 removed lines

@@ -95,7 +95,7 @@ 
     /**
      * @param string $mode
      * @param string $modifiers
-     * @return bool|string
+     * @return false|string
      */
     public function _getDelim($mode,$modifiers) {
         $c = substr($modifiers,0,1);
@@ -132,6 +132,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=='(')
@@ -159,6 +167,9 @@ 
         return substr($string,strpos($string, $delim)+$len);
     }
 
+    /**
+     * @param string $modifiers
+     */
     public function splitEachModifiers($modifiers) {
         global $modx;
 
@@ -228,6 +239,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $key
+     */
     public function parsePhx($key,$value,$modifiers)
     {
         global $modx;
@@ -294,6 +308,9 @@ 
         else                  return true;
     }
 
+    /**
+     * @param string $cmd
+     */
     public function getValueFromPreset($key, $value, $cmd, $opt)
     {
         global $modx;
@@ -979,6 +996,9 @@ 
         return $value;
     }
 
+    /**
+     * @param string $cmd
+     */
     public function includeMdfFile($cmd) {
         global $modx;
         $key = $this->key;
@@ -1134,6 +1154,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;
     }

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
      */