evolution-cms / evolution

manager/includes/controls/phpmailer/POP3.php

Doc Comments +1 added lines, -1 removed lines

@@ -209,7 +209,7 @@
      * Connect to a POP3 server.
      *
      * @param string   $host
-     * @param int|bool $port
+     * @param integer $port
      * @param int      $tval
      *
      * @return bool

manager/includes/controls/phpmailer/SMTP.php

Doc Comments +1 added lines, -1 removed lines

@@ -1314,7 +1314,7 @@
      * If no reply has been received yet, it will return null.
      * If no pattern was matched, it will return false.
      *
-     * @return bool|null|string
+     * @return string
      *
      * @see recordLastTransactionID()
      */

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

Doc Comments +25 added lines, -25 removed lines

@@ -177,7 +177,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
      */
@@ -218,9 +218,9 @@ 
      *
      * @param string $url
      * @param int $count_attempts
-     * @param string|type $type $type
-     * @param string|type $responseCode
-     * @return bool
+     * @param string $type $type
+     * @param string $responseCode
+     * @return false|null
      * @global string $base_url
      * @global string $site_url
      */
@@ -915,7 +915,7 @@ 
     }
 
     /**
-     * @param $contents
+     * @param string $contents
      * @return mixed
      */
     function RecoveryEscapedTags($contents)
@@ -939,7 +939,7 @@ 
     }
 
     /**
-     * @param $tstart
+     * @param double $tstart
      * @return array
      */
     function getTimerStats($tstart)
@@ -1692,7 +1692,7 @@ 
 
     /**
      * Remove Comment-Tags from output like <!--@- Comment -@-->
-     * @param $content
+     * @param string $content
      * @param string $left
      * @param string $right
      * @return mixed
@@ -1862,7 +1862,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
      */
@@ -2901,7 +2901,7 @@ 
 
     /**
      * @param $templateID
-     * @return mixed
+     * @return string
      */
     function _getTemplateCodeFromDB($templateID)
     {
@@ -2942,9 +2942,9 @@ 
     }
 
     /**
-     * @param $id
+     * @param integer $id
      * @param int $top
-     * @return mixed
+     * @return string
      */
     function getUltimateParentId($id, $top = 0)
     {
@@ -3275,7 +3275,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
      */
     function lockElement($type, $id)
     {
@@ -3297,7 +3297,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
      */
     function unlockElement($type, $id, $includeAllUsers = false)
     {
@@ -3909,7 +3909,7 @@ 
      *
      * @param string $type
      * @param bool $report
-     * @return bool
+     * @return boolean|null
      */
     function clearCache($type = '', $report = false)
     {
@@ -5256,7 +5256,7 @@ 
      * Remove event listener - only for use within the current execution cycle
      *
      * @param string $evtName
-     * @return boolean
+     * @return false|null
      */
     function removeEventListener($evtName)
     {
@@ -5280,7 +5280,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
      */
     function invokeEvent($evtName, $extParams = array())
     {
@@ -5701,7 +5701,7 @@ 
 
     /**
      * @param string $string
-     * @return mixed|string
+     * @return string
      */
     function removeSanitizeSeed($string = '')
     {
@@ -5716,7 +5716,7 @@ 
 
     /**
      * @param string $content
-     * @return mixed|string
+     * @return string
      */
     function cleanUpMODXTags($content = '')
     {
@@ -5879,7 +5879,7 @@ 
 
     /**
      * @param string $str
-     * @return bool|mixed|string
+     * @return string
      */
     function atBindFileContent($str = '')
     {
@@ -5930,8 +5930,8 @@ 
     }
 
     /**
-     * @param $str
-     * @return bool|string
+     * @param string $str
+     * @return false|string
      */
     function getExtFromFilename($str)
     {
@@ -5959,7 +5959,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
      */
     function phpError($nr, $text, $file, $line)
     {
@@ -6011,7 +6011,7 @@ 
      * @param string $text
      * @param string $line
      * @param string $output
-     * @return bool
+     * @return null|boolean
      */
     function messageQuit($msg = 'unspecified error', $query = '', $is_error = true, $nr = '', $file = '', $source = '', $text = '', $line = '', $output = '')
     {
@@ -6434,7 +6434,7 @@ 
 
     /**
      * @param string $str
-     * @return bool|mixed|string
+     * @return string
      */
     function atBindInclude($str = '')
     {
@@ -6493,7 +6493,7 @@ 
     }
 
     /**
-     * @param $string
+     * @param string $string
      * @param bool $returnData
      * @return bool|mixed
      */

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

Doc Comments +6 added lines

@@ -618,6 +618,9 @@ 
     return mysql_data_seek($result, $row_number);
   }
   
+    /**
+     * @return string
+     */
     function _getFieldsStringFromArray($fields=array()) {
         
         if(empty($fields)) return '*';
@@ -630,6 +633,9 @@ 
         return join(',', $_);
     }
     
+    /**
+     * @return string
+     */
     function _getFromStringFromArray($tables=array()) {
         $_ = array();
         foreach($tables as $k=>$v) {

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

Doc Comments +9 added lines

@@ -375,6 +375,9 @@ 
 		return $rsArray;
 	}
 
+	/**
+	 * @return string
+	 */
 	function getVersion() {
 		return $this->conn->server_info;
 	}
@@ -410,6 +413,9 @@ 
 		return $result->data_seek($row_number);
 	}
 	
+    /**
+     * @return string
+     */
     function _getFieldsStringFromArray($fields=array()) {
         
         if(empty($fields)) return '*';
@@ -422,6 +428,9 @@ 
         return join(',', $_);
     }
     
+    /**
+     * @return string
+     */
     function _getFromStringFromArray($tables=array()) {
         $_ = array();
         foreach($tables as $k=>$v) {

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

Doc Comments +6 added lines

@@ -102,6 +102,9 @@ 
 		return $rs;
 	}
 
+	/**
+	 * @param string $filepath
+	 */
 	function makeFile($docid, $filepath)
 	{
 		global  $modx,$_lang;
@@ -250,6 +253,9 @@ 
 		return implode("\n", $this->output);
 	}
 	
+    /**
+     * @param string $url
+     */
     function curl_get_contents($url, $timeout = 30 )
     {
     	if(!function_exists('curl_init')) return @file_get_contents($url);

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

Doc Comments +3 added lines

@@ -192,6 +192,9 @@
 		return $_;
 	}
 
+	/**
+	 * @param string $checksum
+	 */
 	function setSystemChecksum($checksum) {
 		global $modx;
 		$tbl_system_settings = $modx->getFullTableName('system_settings');

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

Doc Comments +30 added lines

@@ -45,6 +45,10 @@ 
         return $value;
     }
     
+    /**
+     * @param string $mode
+     * @param string $modifiers
+     */
     function _getDelim($mode,$modifiers) {
         $c = substr($modifiers,0,1);
         if(!in_array($c, array('"', "'", '`')) ) return false;
@@ -56,6 +60,11 @@ 
         return  $c;
     }
     
+    /**
+     * @param string $mode
+     * @param false|string $delim
+     * @param string $modifiers
+     */
     function _getOpt($mode,$delim,$modifiers) {
         if($delim) {
             if($mode=='(') return substr($modifiers,1,strpos($modifiers, $delim . ')' )-1);
@@ -74,6 +83,14 @@ 
             return $opt;
         }
     }
+
+    /**
+     * @param string $mode
+     * @param false|string $delim
+     * @param string $modifiers
+     *
+     * @return string
+     */
     function _getRemainModifiers($mode,$delim,$modifiers) {
         if($delim) {
             if($mode=='(')
@@ -101,6 +118,9 @@ 
         return substr($string,strpos($string, $delim)+$len);
     }
     
+    /**
+     * @param string $modifiers
+     */
     function splitEachModifiers($modifiers) {
         global $modx;
         
@@ -234,6 +254,9 @@ 
         else                  return true;
     }
     
+    /**
+     * @param string $cmd
+     */
     function getValueFromPreset($key, $value, $cmd, $opt)
     {
         global $modx;
@@ -920,6 +943,9 @@ 
         return $value;
     }
 
+    /**
+     * @param string $cmd
+     */
     function includeMdfFile($cmd) {
         global $modx;
         $key = $this->key;
@@ -1075,6 +1101,10 @@ 
     }
     
     // Sets a placeholder variable which can only be access by Modifiers
+
+    /**
+     * @param string $value
+     */
     function setModifiersVariable($key, $value) {
         if ($key != 'phx' && $key != 'dummy') $this->placeholders[$key] = $value;
     }

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

Doc Comments +1 added lines, -1 removed lines

@@ -142,7 +142,7 @@
      * @param string $header The message headers
      * @param string $body   The message body
      * 
-     * @return bool
+     * @return boolean|null
      */
     public function MailSend($header, $body)
     {