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/processors/cache_sync.class.processor.php

Doc Comments +13 added lines, -1 removed lines

@@ -18,11 +18,17 @@ 
         $this->request_time = $_SERVER['REQUEST_TIME'] + $modx->config['server_offset_time'];
     }
 
+    /**
+     * @param string $path
+     */
     function setCachepath($path)
     {
         $this->cachePath = $path;
     }
 
+    /**
+     * @param boolean $bool
+     */
     function setReport($bool)
     {
         $this->showReport = $bool;
@@ -45,6 +51,9 @@ 
         return str_replace($q1, $q2, $s);
     }
 
+    /**
+     * @return string
+     */
     function getParents($id, $path = '')
     { // modx:returns child's parent
         global $modx;
@@ -148,6 +157,9 @@ 
         }
     }
 
+    /**
+     * @return string
+     */
     public function getCacheRefreshTime()
     {
         global $modx;
@@ -190,7 +202,7 @@ 
     /**
      * build siteCache file
      * @param  DocumentParser $modx
-     * @return boolean success
+     * @return null|boolean success
      */
     public function buildCache($modx)
     {

manager/includes/extenders/maketable.class.php

Doc Comments +6 added lines, -4 removed lines

@@ -83,7 +83,7 @@ 
 	/**
 	 * Sets the class attribute of the main HTML TABLE.
 	 *
-	 * @param $value A class for the main HTML TABLE.
+	 * @param string $value A class for the main HTML TABLE.
 	 */
 	function setTableClass($value) {
 		$this->tableClass= $value;
@@ -128,7 +128,7 @@ 
 	/**
 	 * Sets the class attribute of regular table rows.
 	 *
-	 * @param $value A class for regular table rows.
+	 * @param string $value A class for regular table rows.
 	 */
 	function setRowRegularClass($value) {
 		$this->rowRegularClass= $value;
@@ -137,7 +137,7 @@ 
 	/**
 	 * Sets the class attribute of alternate table rows.
 	 *
-	 * @param $value A class for alternate table rows.
+	 * @param string $value A class for alternate table rows.
 	 */
 	function setRowAlternateClass($value) {
 		$this->rowAlternateClass= $value;
@@ -213,6 +213,7 @@ 
 	 *
 	 * @param $value An Array of column widths in the order of the keys in the
 	 * 			source table array.
+	 * @param string[] $widthArray
 	 */
 	function setColumnWidths($widthArray) {
 		$this->columnWidths= $widthArray;
@@ -240,7 +241,7 @@ 
 	/**
 	 * Retrieves the width of a specific table column by index position.
 	 *
-	 * @param $columnPosition The index of the column to get the width for.
+	 * @param integer $columnPosition The index of the column to get the width for.
 	 */
 	function getColumnWidth($columnPosition) {
 		$currentWidth= '';
@@ -254,6 +255,7 @@ 
 	 * Determines what class the current row should have applied.
 	 *
 	 * @param $value The position of the current row being rendered.
+	 * @param integer $position
 	 */
 	function determineRowClass($position) {
 		switch ($this->rowAlternatingScheme) {

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;

manager/media/rss/rss_parse.inc

Doc Comments +10 added lines

@@ -447,6 +447,10 @@ 
     /**
     * return XML parser, and possibly re-encoded source
     *
+    * @param string $source
+    * @param string $out_enc
+    * @param string|null $in_enc
+    * @param boolean $detect
     */
     function create_parser($source, $out_enc, $in_enc, $detect) {
         if ( substr(phpversion(),0,1) == 5) {
@@ -556,6 +560,9 @@ 
         }
     }
 
+    /**
+     * @param integer $lvl
+     */
     function error ($errormsg, $lvl=E_USER_WARNING) {
         // append PHP's error message if track_errors enabled
         if ( isset($php_errormsg) ) {
@@ -591,6 +598,9 @@ 
 	define('CASE_LOWER', 0);
 
 
+	/**
+	 * @param integer $case
+	 */
 	function array_change_key_case($array, $case=CASE_LOWER) {
         $output = array();
         switch($case){