evolution-cms / evolution

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()
     {

manager/includes/functions/actions/import.php

Doc Comments +1 added lines, -1 removed lines

@@ -357,7 +357,7 @@
 if(!function_exists('getFileContent')) {
     /**
      * @param string $filepath
-     * @return bool|string
+     * @return null|string
      */
     function getFileContent($filepath)
     {

manager/includes/functions/actions/files.php

Doc Comments +2 added lines, -2 removed lines

@@ -188,7 +188,7 @@ 
 if(!function_exists('removeLastPath')) {
     /**
      * @param string $string
-     * @return bool|string
+     * @return string|false
      */
     function removeLastPath($string)
     {
@@ -206,7 +206,7 @@ 
 if(!function_exists('getExtension')) {
     /**
      * @param string $string
-     * @return bool|string
+     * @return string|false
      *
      * @TODO: not work if $string contains folder name with dot
      */

manager/includes/src/Interfaces/CoreInterface.php

Doc Comments +5 added lines, -3 removed lines

@@ -3,9 +3,9 @@ 
 interface CoreInterface
 {
     /**
-     * @param $type
-     * @param $scanPath
-     * @param array $ext
+     * @param string $type
+     * @param string $scanPath
+     * @param string[] $ext
      *
      * @return array
      *
@@ -18,6 +18,7 @@ 
      * @param string $phpCode
      * @param string $namespace
      * @param array defaultParams
+     * @return void
      */
     public function addSnippet($name, $phpCode, $namespace = '#', array $defaultParams = array());
 
@@ -25,6 +26,7 @@ 
      * @param string $name
      * @param string $text
      * @param string $namespace
+     * @return void
      */
     public function addChunk($name, $text, $namespace = '#');
 }

manager/includes/src/Core.php

Doc Comments +26 added lines, -24 removed lines

@@ -212,7 +212,6 @@ 
 
     /**
      * @param array $services
-     * @param array $parameters
      */
     public function __construct(array $services = array())
     {
@@ -282,6 +281,9 @@ 
         return $service;
     }
 
+    /**
+     * @param string $name
+     */
     private function checkServiceAlias($name){
         foreach ($this->providerAliases as $alias => $interface) {
             if($name === $interface) {
@@ -319,7 +321,7 @@ 
      *
      * @param object $service         The service.
      * @param string $name            The service name.
-     * @param array  $callDefinitions The service calls definition.
+     * @param boolean  $callDefinitions The service calls definition.
      *
      * @throws Exceptions\ContainerException On failure.
      */
@@ -561,7 +563,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
      */
@@ -1262,7 +1264,7 @@ 
     }
 
     /**
-     * @param $contents
+     * @param string $contents
      * @return mixed
      */
     public function RecoveryEscapedTags($contents)
@@ -1286,7 +1288,7 @@ 
     }
 
     /**
-     * @param $tstart
+     * @param double $tstart
      * @return array
      */
     public function getTimerStats($tstart)
@@ -2052,7 +2054,7 @@ 
 
     /**
      * Remove Comment-Tags from output like <!--@- Comment -@-->
-     * @param $content
+     * @param string $content
      * @param string $left
      * @param string $right
      * @return mixed
@@ -2228,7 +2230,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
      */
@@ -3263,7 +3265,7 @@ 
 
     /**
      * @param $templateID
-     * @return mixed
+     * @return string
      */
     public function _getTemplateCodeFromDB($templateID)
     {
@@ -3306,7 +3308,7 @@ 
     /**
      * @param $id
      * @param int $top
-     * @return mixed
+     * @return string
      */
     public function getUltimateParentId($id, $top = 0)
     {
@@ -3646,7 +3648,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)
     {
@@ -3668,7 +3670,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)
     {
@@ -4181,7 +4183,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')
     {
@@ -4273,7 +4275,7 @@ 
      *
      * @param string $type
      * @param bool $report
-     * @return bool
+     * @return boolean|null
      */
     public function clearCache($type = '', $report = false)
     {
@@ -4639,7 +4641,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 = '}')
@@ -5611,7 +5613,7 @@ 
      * Remove event listener - only for use within the current execution cycle
      *
      * @param string $evtName
-     * @return boolean
+     * @return false|null
      */
     public function removeEventListener($evtName)
     {
@@ -5635,7 +5637,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())
     {
@@ -6280,7 +6282,7 @@ 
 
     /**
      * @param string $str
-     * @return bool|mixed|string
+     * @return string
      */
     public function atBindFileContent($str = '')
     {
@@ -6331,8 +6333,8 @@ 
     }
 
     /**
-     * @param $str
-     * @return bool|string
+     * @param string $str
+     * @return false|string
      */
     public function getExtFromFilename($str)
     {
@@ -6360,7 +6362,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)
     {
@@ -6412,7 +6414,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 = '')
     {
@@ -6827,7 +6829,7 @@ 
 
     /**
      * @param string $str
-     * @return bool|mixed|string
+     * @return string
      */
     public function atBindInclude($str = '')
     {
@@ -6878,7 +6880,7 @@ 
      * @param $str
      * @param int $flags
      * @param string $encode
-     * @return mixed
+     * @return null|string
      */
     public function htmlspecialchars($str, $flags = ENT_COMPAT, $encode = '')
     {
@@ -6886,7 +6888,7 @@ 
     }
 
     /**
-     * @param $string
+     * @param string $string
      * @param bool $returnData
      * @return bool|mixed
      */

manager/includes/src/Database.php

Doc Comments +2 added lines, -2 removed lines

@@ -371,7 +371,7 @@ 
 
     /**
      * @param $fields
-     * @param $table
+     * @param string $table
      * @param string $where
      * @return bool|mixed|mysqli_result
      */
@@ -516,7 +516,7 @@ 
     }
 
     /**
-     * @param $name
+     * @param string $name
      * @param mysqli_result|string $dsq
      * @return array
      */

manager/includes/src/Legacy/Modifiers.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;
     }

manager/includes/src/Legacy/PhpCompat.php

Doc Comments +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
      * @param int $flags
      * @param string $encode
      * @param int $safecount
-     * @return string|array
+     * @return null|string
      */
     public function htmlspecialchars($str = '', $flags = ENT_COMPAT, $encode = '', $safecount = 0)
     {

manager/includes/src/Support/DataGrid.php

Doc Comments +3 added lines

@@ -207,6 +207,9 @@
 
 	// format column values
 
+    /**
+     * @param integer $n
+     */
     public function RenderRowFnc($n, $row) {
 		if($this->_alt == 0) {
 			$Style = $this->_itemStyle;