evolution-cms / evolution

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

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

Doc Comments +6 added lines

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

manager/includes/extenders/maketable.class.php

Doc Comments +6 added lines, -4 removed lines

@@ -85,7 +85,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.
 	 */
     public function setTableClass($value) {
 		$this->tableClass= $value;
@@ -130,7 +130,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.
 	 */
     public function setRowRegularClass($value) {
 		$this->rowRegularClass= $value;
@@ -139,7 +139,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.
 	 */
     public function setRowAlternateClass($value) {
 		$this->rowAlternateClass= $value;
@@ -215,6 +215,7 @@ 
 	 *
 	 * @param $value An Array of column widths in the order of the keys in the
 	 * 			source table array.
+	 * @param string[] $widthArray
 	 */
     public function setColumnWidths($widthArray) {
 		$this->columnWidths= $widthArray;
@@ -242,7 +243,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.
 	 */
     public function getColumnWidth($columnPosition) {
 		$currentWidth= '';
@@ -256,6 +257,7 @@ 
 	 * Determines what class the current row should have applied.
 	 *
 	 * @param $value The position of the current row being rendered.
+	 * @param integer $position
 	 */
     public function determineRowClass($position) {
 		switch ($this->rowAlternatingScheme) {

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

Doc Comments +35 added lines

@@ -30,6 +30,11 @@ 
         $this->condModifiers = '=,is,eq,equals,ne,neq,notequals,isnot,isnt,not,%,isempty,isnotempty,isntempty,>=,gte,eg,gte,greaterthan,>,gt,isgreaterthan,isgt,lowerthan,<,lt,<=,lte,islte,islowerthan,islt,el,find,in,inarray,in_array,fnmatch,wcard,wcard_match,wildcard,wildcard_match,is_file,is_dir,file_exists,is_readable,is_writable,is_image,regex,preg,preg_match,memberof,mo,isinrole,ir';
     }
 
+    /**
+     * @param string $key
+     * @param string $value
+     * @param string|false $modifiers
+     */
     public function phxFilter($key,$value,$modifiers)
     {
         global $modx;
@@ -51,6 +56,10 @@ 
         return $value;
     }
 
+    /**
+     * @param string $mode
+     * @param string $modifiers
+     */
     public function _getDelim($mode,$modifiers) {
         $c = substr($modifiers,0,1);
         if(!in_array($c, array('"', "'", '`')) ) return false;
@@ -62,6 +71,11 @@ 
         return  $c;
     }
 
+    /**
+     * @param string $mode
+     * @param false|string $delim
+     * @param string $modifiers
+     */
     public function _getOpt($mode,$delim,$modifiers) {
         if($delim) {
             if($mode=='(') return substr($modifiers,1,strpos($modifiers, $delim . ')' )-1);
@@ -80,6 +94,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=='(')
@@ -107,6 +129,9 @@ 
         return substr($string,strpos($string, $delim)+$len);
     }
 
+    /**
+     * @param string $modifiers
+     */
     public function splitEachModifiers($modifiers) {
         global $modx;
 
@@ -242,6 +267,9 @@ 
         else                  return true;
     }
 
+    /**
+     * @param string $cmd
+     */
     public function getValueFromPreset($key, $value, $cmd, $opt)
     {
         global $modx;
@@ -927,6 +955,9 @@ 
         return $value;
     }
 
+    /**
+     * @param string $cmd
+     */
     public function includeMdfFile($cmd) {
         global $modx;
         $key = $this->key;
@@ -1082,6 +1113,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/menu.class.inc.php

Doc Comments +4 added lines

@@ -41,6 +41,10 @@
         $this->menu = $new;
     }
 
+    /**
+     * @param string $parentid
+     * @param integer $level
+     */
     public function DrawSub($parentid, $level)
     {
         global $modx;

manager/processors/cache_sync.class.processor.php

Doc Comments +13 added lines, -1 removed lines

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

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

Doc Comments +4 added lines

@@ -554,6 +554,7 @@ 
      * @name:  getColumn
      * @desc:  returns an array of the values found on colun $name
      * @param: $dsq - dataset or query string
+     * @param string $name
      */
     public function getColumn($name, $dsq)
     {
@@ -720,6 +721,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $table_name
+     */
     public function optimize($table_name)
     {
         $rs = $this->query("OPTIMIZE TABLE {$table_name}");