evolution-cms / evolution

manager/media/rss/rss_fetch.inc

Doc Comments +6 added lines

@@ -243,6 +243,9 @@ 
         }
 }
 
+/**
+ * @param integer $lvl
+ */
 function debug ($debugmsg, $lvl=E_USER_NOTICE) {
     trigger_error("MagpieRSS [debug] $debugmsg", $lvl);
 }
@@ -289,6 +292,9 @@ 
     Input:      an HTTP response object (see Snoopy)
     Output:     parsed RSS object (see rss_parse)
 \*=======================================================================*/
+/**
+ * @param Snoopy $resp
+ */
 function _response_to_rss ($resp) {
     $rss = new MagpieRSS( $resp->results, MAGPIE_OUTPUT_ENCODING, MAGPIE_INPUT_ENCODING, MAGPIE_DETECT_ENCODING );
     

manager/media/rss/rss_cache.inc

Doc Comments +12 added lines

@@ -48,6 +48,9 @@ 
     Input:      url from wich the rss file was fetched
     Output:     true on sucess
 \*=======================================================================*/
+    /**
+     * @param string $url
+     */
     function set ($url, $rss) {
         $this->ERROR = "";
         $cache_file = $this->file_name( $url );
@@ -74,6 +77,9 @@ 
     Input:      url from wich the rss file was fetched
     Output:     cached object on HIT, false on MISS
 \*=======================================================================*/
+    /**
+     * @param string $url
+     */
     function get ($url) {
         $this->ERROR = "";
         $cache_file = $this->file_name( $url );
@@ -110,6 +116,9 @@ 
     Input:      url from wich the rss file was fetched
     Output:     cached object on HIT, false on MISS
 \*=======================================================================*/
+    /**
+     * @param string $url
+     */
     function check_cache ( $url ) {
         $this->ERROR = "";
         $filename = $this->file_name( $url );
@@ -156,6 +165,9 @@ 
 /*=======================================================================*\
     Function:   unserialize
 \*=======================================================================*/
+    /**
+     * @param string $data
+     */
     function unserialize ( $data ) {
         return unserialize( $data );
     }

manager/actions/bkmanager.static.php

Doc Comments +9 added lines

@@ -515,6 +515,9 @@ 
         $this->setDroptables(false);
     }
 
+    /**
+     * @param boolean $state
+     */
     public function setDroptables($state)
     {
         $this->_isDroptables = $state;
@@ -722,6 +725,9 @@ 
     $_SESSION['result_msg'] = $result_code;
 }
 
+/**
+ * @param string $dumpstring
+ */
 function dumpSql(&$dumpstring)
 {
     global $modx;
@@ -741,6 +747,9 @@ 
     return true;
 }
 
+/**
+ * @param string $dumpstring
+ */
 function snapshot(&$dumpstring)
 {
     global $path;

install/functions.php

Doc Comments +4 added lines

@@ -33,6 +33,10 @@
 }
 
 if( ! function_exists('parse')) {
+
+    /**
+     * @param string $src
+     */
     function parse($src, $ph, $left = '[+', $right = '+]')
     {
         foreach ($ph as $k => $v) {

manager/actions/mutate_settings/functions.inc.php

Doc Comments +1 added lines

@@ -18,6 +18,7 @@
 /**

  * get_langs_by_key

  *

+ * @param string $key
  * @return array of languages that define the key in their file

  */

 function get_langs_by_key($key) {

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

Doc Comments +3 added lines

@@ -6,6 +6,9 @@
 	{
 	}
 	
+	/**
+	 * @param integer $flags
+	 */
 	function htmlspecialchars($str='', $flags = ENT_COMPAT, $encode='')
 	{
 		global $modx;

manager/includes/controls/datagrid.class.php

Doc Comments +6 added lines

@@ -72,6 +72,9 @@ 
      */
     public $cdelim;
 
+    /**
+     * @param null|string $id
+     */
     public function __construct($id, $ds, $pageSize = 20, $pageNumber = -1) {
 		global $__DataGridCnt;
 
@@ -207,6 +210,9 @@ 
 
 	// format column values
 
+    /**
+     * @param integer $n
+     */
     public function RenderRowFnc($n, $row) {
 		if($this->_alt == 0) {
 			$Style = $this->_itemStyle;

manager/includes/controls/datasetpager.class.php

Doc Comments +6 added lines

@@ -31,6 +31,9 @@ 
     public $renderPagerFnc;
     public $renderPagerFncArgs;
 
+    /**
+     * @param boolean|string $id
+     */
     public function __construct($id, $ds, $pageSize = 10, $pageNumber = -1) {
 		global $_PAGE; // use view state object
 
@@ -77,6 +80,9 @@ 
 		$this->pageSize = $ps;
 	}
 
+    /**
+     * @param DataGrid $fncName
+     */
     public function setRenderRowFnc($fncName, $args = "") {
 		$this->renderRowFnc = &$fncName;
 		$this->renderRowFncArgs = $args;    // extra agruments

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

Doc Comments +26 added lines, -26 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
+     * @return false|null
      * @global string $base_url
      * @global string $site_url
      */
@@ -999,7 +999,7 @@ 
     }
 
     /**
-     * @param $contents
+     * @param string $contents
      * @return mixed
      */
     public function RecoveryEscapedTags($contents)
@@ -1023,7 +1023,7 @@ 
     }
 
     /**
-     * @param $tstart
+     * @param double $tstart
      * @return array
      */
     public function getTimerStats($tstart)
@@ -1775,7 +1775,7 @@ 
 
     /**
      * Remove Comment-Tags from output like <!--@- Comment -@-->
-     * @param $content
+     * @param string $content
      * @param string $left
      * @param string $right
      * @return mixed
@@ -1948,7 +1948,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
      */
@@ -2980,7 +2980,7 @@ 
 
     /**
      * @param $templateID
-     * @return mixed
+     * @return string
      */
     public function _getTemplateCodeFromDB($templateID)
     {
@@ -3021,9 +3021,9 @@ 
     }
 
     /**
-     * @param $id
+     * @param integer $id
      * @param int $top
-     * @return mixed
+     * @return string
      */
     public function getUltimateParentId($id, $top = 0)
     {
@@ -3354,7 +3354,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)
     {
@@ -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
      * @param bool $includeAllUsers true = Deletes not only own user-locks
-     * @return bool
+     * @return false|null
      */
     public function unlockElement($type, $id, $includeAllUsers = false)
     {
@@ -3484,7 +3484,7 @@ 
      * @param array $params
      * @param string $msg
      * @param array $files
-     * @return mixed
+     * @return boolean
      */
     public function sendmail($params = array(), $msg = '', $files = array())
     {
@@ -3980,7 +3980,7 @@ 
      *
      * @param string $type
      * @param bool $report
-     * @return bool
+     * @return boolean|null
      */
     public function clearCache($type = '', $report = false)
     {
@@ -5024,7 +5024,7 @@ 
      * Returns a record for the web user
      *
      * @param int $uid
-     * @return boolean|string
+     * @return boolean|null
      */
     public function getWebUserInfo($uid)
     {
@@ -5322,7 +5322,7 @@ 
      * Remove event listener - only for use within the current execution cycle
      *
      * @param string $evtName
-     * @return boolean
+     * @return false|null
      */
     public function removeEventListener($evtName)
     {
@@ -5346,7 +5346,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())
     {
@@ -5767,7 +5767,7 @@ 
 
     /**
      * @param string $string
-     * @return mixed|string
+     * @return string
      */
     public function removeSanitizeSeed($string = '')
     {
@@ -5782,7 +5782,7 @@ 
 
     /**
      * @param string $content
-     * @return mixed|string
+     * @return string
      */
     public function cleanUpMODXTags($content = '')
     {
@@ -5945,7 +5945,7 @@ 
 
     /**
      * @param string $str
-     * @return bool|mixed|string
+     * @return string
      */
     public function atBindFileContent($str = '')
     {
@@ -5996,8 +5996,8 @@ 
     }
 
     /**
-     * @param $str
-     * @return bool|string
+     * @param string $str
+     * @return false|string
      */
     public function getExtFromFilename($str)
     {
@@ -6025,7 +6025,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)
     {
@@ -6077,7 +6077,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 = '')
     {
@@ -6499,7 +6499,7 @@ 
 
     /**
      * @param string $str
-     * @return bool|mixed|string
+     * @return string
      */
     public function atBindInclude($str = '')
     {
@@ -6550,7 +6550,7 @@ 
      * @param $str
      * @param int $flags
      * @param string $encode
-     * @return mixed
+     * @return string
      */
     public function htmlspecialchars($str, $flags = ENT_COMPAT, $encode = '')
     {
@@ -6559,7 +6559,7 @@ 
     }
 
     /**
-     * @param $string
+     * @param string $string
      * @param bool $returnData
      * @return bool|mixed
      */