evolution-cms / evolution

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}");

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

Doc Comments +9 added lines

@@ -408,6 +408,9 @@ 
         return $out;
     }
 
+    /**
+     * @param string $name
+     */
     public function getColumn($name, $dsq)
     {
         if (!is_object($dsq)) {
@@ -506,6 +509,9 @@ 
         return $rsArray;
     }
 
+    /**
+     * @return string
+     */
     public function getVersion()
     {
         return $this->conn->server_info;
@@ -527,6 +533,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $table_name
+     */
     public function optimize($table_name)
     {
         $rs = $this->query("OPTIMIZE TABLE {$table_name}");

manager/media/rss/rss_parse.inc

Doc Comments +14 added lines

@@ -332,6 +332,10 @@ 
     }
 
     // smart append - field and namespace aware
+
+    /**
+     * @param string $el
+     */
     function append($el, $text) {
         if (!$el) {
             return;
@@ -447,6 +451,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 +564,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 +602,9 @@ 
 	define('CASE_LOWER', 0);
 
 
+	/**
+	 * @param integer $case
+	 */
 	function array_change_key_case($array, $case=CASE_LOWER) {
         $output = array();
         switch($case){