evolution-cms / evolution

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

Doc Comments +11 added lines

@@ -414,6 +414,9 @@ 
         }
     }
 
+    /**
+     * @param string $table
+     */
     public function save($fields, $table, $where = '')
     {
 
@@ -444,6 +447,7 @@ 
     /**
      * @name:  freeResult
      *
+     * @param mysqli_result $rs
      */
     public function freeResult($rs)
     {
@@ -554,6 +558,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 +725,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $table_name
+     */
     public function optimize($table_name)
     {
         $rs = $this->query("OPTIMIZE TABLE {$table_name}");
@@ -730,6 +738,9 @@ 
         return $rs;
     }
 
+    /**
+     * @param string $table_name
+     */
     public function truncate($table_name)
     {
         $rs = $this->query("TRUNCATE {$table_name}");

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

Doc Comments +9 added lines, -9 removed lines

@@ -240,9 +240,9 @@ 
     }
 
     /**
-     * @param string|array $fields
-     * @param string|array $from
-     * @param string|array $where
+     * @param string $fields
+     * @param string $from
+     * @param string $where
      * @param string $orderBy
      * @param string $limit
      * @return bool|mysqli_result
@@ -326,7 +326,7 @@ 
      * @param string $fromtable
      * @param string $where
      * @param string $limit
-     * @return mixed
+     * @return null|integer
      */
     public function insert($fields, $intotable, $fromfields = "*", $fromtable = "", $where = "", $limit = "")
     {
@@ -368,7 +368,7 @@ 
 
     /**
      * @param $fields
-     * @param $table
+     * @param string $table
      * @param string $where
      * @return bool|mixed|mysqli_result
      */
@@ -435,7 +435,7 @@ 
 
     /**
      * @param null|mysqli $conn
-     * @return mixed
+     * @return integer
      */
     public function getInsertId($conn = null)
     {
@@ -513,7 +513,7 @@ 
     }
 
     /**
-     * @param $name
+     * @param string $name
      * @param mysqli_result|string $dsq
      * @return array
      */
@@ -572,7 +572,7 @@ 
 
     /**
      * @param string $table
-     * @return array
+     * @return boolean
      */
     public function getTableMetaData($table)
     {
@@ -619,7 +619,7 @@ 
     }
 
     /**
-     * @param string|mysqli_result $rs
+     * @param string $rs
      * @param bool $index
      * @return array
      */

manager/includes/extenders/deprecated.functions.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
      * @deprecated
      *
      * @param $rs
-     * @return int|mixed
+     * @return integer
      */
     public function insertId($rs)
     {

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

Doc Comments +27 added lines, -1 removed lines

@@ -94,7 +94,7 @@ 
     /**
      * @param string $mode
      * @param string $modifiers
-     * @return bool|string
+     * @return false|string
      */
     public function _getDelim($mode,$modifiers) {
         $c = substr($modifiers,0,1);
@@ -131,6 +131,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=='(')
@@ -158,6 +166,9 @@ 
         return substr($string,strpos($string, $delim)+$len);
     }
 
+    /**
+     * @param string $modifiers
+     */
     public function splitEachModifiers($modifiers) {
         $modx = evolutionCMS();
 
@@ -227,6 +238,10 @@ 
         return $result;
     }
 
+    /**
+     * @param string $key
+     * @param string $value
+     */
     public function parsePhx($key,$value,$modifiers)
     {
         $modx = evolutionCMS();
@@ -293,6 +308,10 @@ 
         else                  return true;
     }
 
+    /**
+     * @param string $cmd
+     * @param string $opt
+     */
     public function getValueFromPreset($key, $value, $cmd, $opt)
     {
         $modx = evolutionCMS();
@@ -978,6 +997,9 @@ 
         return $value;
     }
 
+    /**
+     * @param string $cmd
+     */
     public function includeMdfFile($cmd) {
         $modx = evolutionCMS();
         $key = $this->key;
@@ -1133,6 +1155,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/document.parser.class.inc.php

Doc Comments +24 added lines, -24 removed lines

@@ -280,7 +280,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
      */
@@ -325,7 +325,7 @@ 
      * @param int $count_attempts
      * @param string $type $type
      * @param string $responseCode
-     * @return bool|null
+     * @return false|null
      * @global string $base_url
      * @global string $site_url
      */
@@ -1042,7 +1042,7 @@ 
     }
 
     /**
-     * @param $contents
+     * @param string $contents
      * @return mixed
      */
     public function RecoveryEscapedTags($contents)
@@ -1068,7 +1068,7 @@ 
     }
 
     /**
-     * @param $tstart
+     * @param double $tstart
      * @return array
      */
     public function getTimerStats($tstart)
@@ -1851,7 +1851,7 @@ 
 
     /**
      * Remove Comment-Tags from output like <!--@- Comment -@-->
-     * @param $content
+     * @param string $content
      * @param string $left
      * @param string $right
      * @return mixed
@@ -2029,7 +2029,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
      */
@@ -3098,7 +3098,7 @@ 
 
     /**
      * @param $templateID
-     * @return mixed
+     * @return string
      */
     public function _getTemplateCodeFromDB($templateID)
     {
@@ -3142,7 +3142,7 @@ 
     /**
      * @param $id
      * @param int $top
-     * @return mixed
+     * @return string
      */
     public function getUltimateParentId($id, $top = 0)
     {
@@ -3482,7 +3482,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)
     {
@@ -3505,7 +3505,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)
     {
@@ -3616,7 +3616,7 @@ 
      * @param array $params
      * @param string $msg
      * @param array $files
-     * @return mixed
+     * @return boolean
      */
     public function sendmail($params = array(), $msg = '', $files = array())
     {
@@ -4053,7 +4053,7 @@ 
      *                     Default: 1
      * @param string $fields List of fields
      *                       Default: id, pagetitle, description, alias
-     * @return boolean|array
+     * @return string
      */
     public function getPageInfo($pageid = -1, $active = 1, $fields = 'id, pagetitle, description, alias')
     {
@@ -4151,7 +4151,7 @@ 
      *
      * @param string $type
      * @param bool $report
-     * @return bool
+     * @return boolean|null
      */
     public function clearCache($type = '', $report = false)
     {
@@ -4524,7 +4524,7 @@ 
      * - Placeholders prefix. Default: '{'.
      * @param string $suffix {string}
      * - Placeholders suffix. Default: '}'.
-     * @return bool|mixed|string {string; false} - Parsed chunk or false if $chunkArr is not array.
+     * @return false|string {string; false} - Parsed chunk or false if $chunkArr is not array.
      * - Parsed chunk or false if $chunkArr is not array.
      */
     public function parseChunk($chunkName, $chunkArr, $prefix = '{', $suffix = '}')
@@ -5558,7 +5558,7 @@ 
      * Remove event listener - only for use within the current execution cycle
      *
      * @param string $evtName
-     * @return boolean
+     * @return false|null
      */
     public function removeEventListener($evtName)
     {
@@ -5582,7 +5582,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())
     {
@@ -6204,7 +6204,7 @@ 
 
     /**
      * @param string $str
-     * @return bool|mixed|string
+     * @return string
      */
     public function atBindFileContent($str = '')
     {
@@ -6261,8 +6261,8 @@ 
     }
 
     /**
-     * @param $str
-     * @return bool|string
+     * @param string $str
+     * @return false|string
      */
     public function getExtFromFilename($str)
     {
@@ -6290,7 +6290,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)
     {
@@ -6342,7 +6342,7 @@ 
      * @param string $text
      * @param string $line
      * @param string $output
-     * @return bool
+     * @return null|boolean
      */
     public function messageQuit(
         $msg = 'unspecified error',
@@ -6785,7 +6785,7 @@ 
 
     /**
      * @param string $str
-     * @return bool|mixed|string
+     * @return string
      */
     public function atBindInclude($str = '')
     {
@@ -6837,7 +6837,7 @@ 
      * @param $str
      * @param int $flags
      * @param string $encode
-     * @return mixed
+     * @return string
      */
     public function htmlspecialchars($str, $flags = ENT_COMPAT, $encode = '')
     {
@@ -6847,7 +6847,7 @@ 
     }
 
     /**
-     * @param $string
+     * @param string $string
      * @param bool $returnData
      * @return bool|mixed
      */