evolution-cms / evolution

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/document.parser.class.inc.php

Doc Comments +25 added lines, -25 removed lines

@@ -252,7 +252,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
      */
@@ -295,7 +295,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
      */
@@ -995,7 +995,7 @@ 
     }
 
     /**
-     * @param $contents
+     * @param string $contents
      * @return mixed
      */
     public function RecoveryEscapedTags($contents)
@@ -1019,7 +1019,7 @@ 
     }
 
     /**
-     * @param $tstart
+     * @param double $tstart
      * @return array
      */
     public function getTimerStats($tstart)
@@ -1771,7 +1771,7 @@ 
 
     /**
      * Remove Comment-Tags from output like <!--@- Comment -@-->
-     * @param $content
+     * @param string $content
      * @param string $left
      * @param string $right
      * @return mixed
@@ -1944,7 +1944,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
      */
@@ -2977,7 +2977,7 @@ 
 
     /**
      * @param $templateID
-     * @return mixed
+     * @return string
      */
     public function _getTemplateCodeFromDB($templateID)
     {
@@ -3018,9 +3018,9 @@ 
     }
 
     /**
-     * @param $id
+     * @param integer $id
      * @param int $top
-     * @return mixed
+     * @return string
      */
     public function getUltimateParentId($id, $top = 0)
     {
@@ -3351,7 +3351,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)
     {
@@ -3373,7 +3373,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)
     {
@@ -3481,7 +3481,7 @@ 
      * @param array $params
      * @param string $msg
      * @param array $files
-     * @return mixed
+     * @return boolean
      */
     public function sendmail($params = array(), $msg = '', $files = array())
     {
@@ -3977,7 +3977,7 @@ 
      *
      * @param string $type
      * @param bool $report
-     * @return bool
+     * @return boolean|null
      */
     public function clearCache($type = '', $report = false)
     {
@@ -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/dbapi.mysql.class.inc.php

Doc Comments +10 added lines

@@ -452,6 +452,7 @@ 
     * @name:  getColumn
     * @desc:  returns an array of the values found on colun $name
     * @param: $dsq - dataset or query string
+    * @param string $name
     */
    function getColumn($name, $dsq) {
       if (!is_resource($dsq))
@@ -601,6 +602,9 @@ 
        return $result;
    }
    
+   /**
+    * @param string $table_name
+    */
    function optimize($table_name)
    {
        $rs = $this->query("OPTIMIZE TABLE {$table_name}");
@@ -618,6 +622,9 @@ 
     return mysql_data_seek($result, $row_number);
   }
   
+    /**
+     * @return string
+     */
     function _getFieldsStringFromArray($fields=array()) {
         
         if(empty($fields)) return '*';
@@ -630,6 +637,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 +15 added lines

@@ -291,6 +291,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function getColumn($name, $dsq) {
 		if (!is_object($dsq)) {
 			$dsq = $this->query($dsq);
@@ -375,6 +378,9 @@ 
 		return $rsArray;
 	}
 
+	/**
+	 * @return string
+	 */
 	function getVersion() {
 		return $this->conn->server_info;
 	}
@@ -393,6 +399,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $table_name
+	 */
 	function optimize($table_name) {
 		$rs = $this->query("OPTIMIZE TABLE {$table_name}");
 		if ($rs) {
@@ -410,6 +419,9 @@ 
 		return $result->data_seek($row_number);
 	}
 	
+    /**
+     * @return string
+     */
     function _getFieldsStringFromArray($fields=array()) {
         
         if(empty($fields)) return '*';
@@ -422,6 +434,9 @@ 
         return join(',', $_);
     }
     
+    /**
+     * @return string
+     */
     function _getFromStringFromArray($tables=array()) {
         $_ = array();
         foreach($tables as $k=>$v) {

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

Doc Comments +35 added lines

@@ -24,6 +24,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
+     */
     function phxFilter($key,$value,$modifiers)
     {
         global $modx;
@@ -45,6 +50,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 +65,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 +88,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 +123,9 @@ 
         return substr($string,strpos($string, $delim)+$len);
     }
     
+    /**
+     * @param string $modifiers
+     */
     function splitEachModifiers($modifiers) {
         global $modx;
         
@@ -234,6 +259,9 @@ 
         else                  return true;
     }
     
+    /**
+     * @param string $cmd
+     */
     function getValueFromPreset($key, $value, $cmd, $opt)
     {
         global $modx;
@@ -920,6 +948,9 @@ 
         return $value;
     }
 
+    /**
+     * @param string $cmd
+     */
     function includeMdfFile($cmd) {
         global $modx;
         $key = $this->key;
@@ -1075,6 +1106,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/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;