XOOPS / XoopsCore25

htdocs/modules/profile/class/field.php

Doc Comments +3 added lines, -3 removed lines

@@ -238,7 +238,7 @@ 
      * @param XoopsUser      $user    {@link XoopsUser} object to get the value of
      * @param profileProfile $profile object to get the value of
      *
-     * @return mixed
+     * @return string
      **/
     public function getOutputValue(&$user, $profile)
     {
@@ -433,7 +433,7 @@ 
 class ProfileFieldHandler extends XoopsPersistableObjectHandler
 {
     /**
-     * @param null|XoopsDatabase $db
+     * @param XoopsDatabase $db
      */
     public function __construct(XoopsDatabase $db)
     {
@@ -644,7 +644,7 @@ 
     /**
      * Get array of standard variable names (user table)
      *
-     * @return array
+     * @return string[]
      */
     public function getUserVars()
     {

htdocs/modules/profile/include/forms.php

Doc Comments +4 added lines, -4 removed lines

@@ -26,7 +26,7 @@ 
  * @param ProfileField $field  {@link ProfileField} object to get edit form for
  * @param mixed        $action URL to submit to - or false for $_SERVER['REQUEST_URI']
  *
- * @return object
+ * @return XoopsThemeForm
  */
 function profile_getFieldForm(ProfileField $field, $action = false)
 {
@@ -278,7 +278,7 @@ 
  * @param int       $step Which step we are at
  *
  * @internal param \profileRegstep $next_step
- * @return object
+ * @return XoopsThemeForm
  */
 function profile_getRegisterForm(XoopsUser $user, $profile, $step = null)
 {
@@ -387,7 +387,7 @@ 
  * @param ProfileProfile|null $profile
  * @param bool                $action
  *
- * @return object
+ * @return XoopsThemeForm
  */
 function profile_getUserForm(XoopsUser $user, ProfileProfile $profile = null, $action = false)
 {
@@ -522,7 +522,7 @@ 
  * @param ProfileRegstep|null $step {@link ProfileRegstep} to edit
  * @param bool                $action
  *
- * @return object
+ * @return XoopsThemeForm
  */
 function profile_getStepForm(ProfileRegstep $step = null, $action = false)
 {

htdocs/modules/system/admin/modulesadmin/modulesadmin.php

Doc Comments +3 added lines, -3 removed lines

@@ -528,7 +528,7 @@ 
 }
 
 /**
- * @param        $dirname
+ * @param        string $dirname
  * @param        $template
  * @param string $type
  *
@@ -1388,9 +1388,9 @@ 
 
 /**
  * @param $module
- * @param $title
+ * @param string $title
  *
- * @return array
+ * @return string[]
  */
 function xoops_module_log_header($module, $title)
 {

htdocs/modules/system/class/avatar.php

Doc Comments +1 added lines, -1 removed lines

@@ -115,7 +115,7 @@
      * Create new Object
      *
      * @param  bool $isNew
-     * @return object
+     * @return SystemAvatar
      */
     public function &create($isNew = true)
     {

htdocs/modules/system/class/maintenance.php

Doc Comments +12 added lines, -6 removed lines

@@ -142,7 +142,7 @@ 
      *
      * @param array tables 'list of tables'
      * @param array maintenance 'optimize, check, repair, analyze'
-     * @return array
+     * @return string
      */
     public function CheckRepairAnalyzeOptimizeQueries($tables, $maintenance)
     {
@@ -214,7 +214,7 @@ 
      *
      * @param array tables 'list of tables'
      * @param int   drop
-     * @return array 'ret[0] = dump, ret[1] = display result
+     * @return string[] 'ret[0] = dump, ret[1] = display result
      */
     public function dump_tables($tables, $drop)
     {
@@ -243,7 +243,7 @@ 
      *
      * @param array modules 'list of modules'
      * @param int   drop
-     * @return array 'ret[0] = dump, ret[1] = display result
+     * @return string[] 'ret[0] = dump, ret[1] = display result
      */
     public function dump_modules($modules, $drop)
     {
@@ -285,7 +285,10 @@ 
      * @param string table
      * @param int    drop
      * @param string class
-     * @return array 'ret[0] = dump, ret[1] = display result
+     * @param string[] $ret
+     * @param string $table
+     * @param string $class
+     * @return string[] 'ret[0] = dump, ret[1] = display result
      */
     public function dump_table_structure($ret, $table, $drop, $class)
     {
@@ -314,7 +317,9 @@ 
      *
      * @param array
      * @param string table
-     * @return array 'ret[0] = dump, ret[1] = display result
+     * @param string[] $ret
+     * @param string $table
+     * @return string[] 'ret[0] = dump, ret[1] = display result
      */
     public function dump_table_datas($ret, $table)
     {
@@ -379,7 +384,8 @@ 
      * Dump Write
      *
      * @param array
-     * @return array 'ret[0] = dump, ret[1] = display result
+     * @param string[] $ret
+     * @return string[] 'ret[0] = dump, ret[1] = display result
      */
     public function dump_write($ret)
     {

htdocs/modules/system/class/thumbs/phpthumb.class.php

Doc Comments +17 added lines

@@ -1120,6 +1120,10 @@ 
 
 	/* True if the provided path points inside one of open_basedirs (or if open_basedirs are disabled) */
 	// http://support.silisoftware.com/phpBB3/viewtopic.php?t=961
+
+	/**
+	 * @param string $path
+	 */
 	function isInOpenBasedir($path) {
 		static $open_basedirs = null;
 		if (is_null($open_basedirs)) {
@@ -1137,6 +1141,10 @@ 
 
 	/* Resolves all symlinks in $path, checking that each continuous part ends in an allowed zone. Returns null, if any component leads outside of allowed zone. */
 	// http://support.silisoftware.com/phpBB3/viewtopic.php?t=961
+
+	/**
+	 * @return string
+	 */
 	function resolvePath($path, $allowed_dirs) {
 		$this->DebugMessage('resolvePath: '.$path.' (allowed_dirs: '.print_r($allowed_dirs, true).')', __FILE__, __LINE__);
 
@@ -4116,6 +4124,9 @@ 
 		return $this->ErrorImage(implode("\n", $DebugOutput), 700, 500, true);
 	}
 
+	/**
+	 * @param string $text
+	 */
 	function FatalError($text) {
 		if (is_null($this->fatalerror)) {
 			$this->fatalerror = $text;
@@ -4123,6 +4134,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $text
+	 */
 	function ErrorImage($text, $width=0, $height=0, $forcedisplay=false) {
 		$width  = ($width  ? $width  : $this->config_error_image_width);
 		$height = ($height ? $height : $this->config_error_image_height);
@@ -4368,6 +4382,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $message
+	 */
 	function DebugTimingMessage($message, $file='', $line='', $timestamp=0) {
 		if (!$timestamp) {
 			$timestamp = array_sum(explode(' ', microtime()));

htdocs/modules/system/class/thumbs/phpthumb.gif.php

Doc Comments +46 added lines

@@ -64,6 +64,9 @@ 
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////
 
+/**
+ * @param string $lpszFileName
+ */
 function gif_outputAsBmp($gif, $lpszFileName, $bgColor = -1)
 {
 	if (!isSet($gif) || (@get_class($gif) <> 'cgif') || !$gif->loaded() || ($lpszFileName == '')) {
@@ -186,6 +189,10 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $data
+	 * @param integer $datLen
+	 */
 	function deCompress($data, &$datLen)
 	{
 		$stLen  = strlen($data);
@@ -210,6 +217,11 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param boolean $bInit
+	 *
+	 * @return integer
+	 */
 	function LZWCommand(&$data, $bInit)
 	{
 		if ($bInit) {
@@ -392,6 +404,10 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $lpData
+	 * @param integer $num
+	 */
 	function load($lpData, $num)
 	{
 		$this->m_nColors  = 0;
@@ -503,6 +519,9 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param integer $hdrLen
+	 */
 	function load($lpData, &$hdrLen)
 	{
 		$hdrLen = 0;
@@ -540,6 +559,9 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $str
+	 */
 	function w2i($str)
 	{
 		return ord(substr($str, 0, 1)) + (ord(substr($str, 1, 1)) << 8);
@@ -578,6 +600,10 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $lpData
+	 * @param integer $hdrLen
+	 */
 	function load($lpData, &$hdrLen)
 	{
 		$hdrLen = 0;
@@ -611,6 +637,9 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $str
+	 */
 	function w2i($str)
 	{
 		return ord(substr($str, 0, 1)) + (ord(substr($str, 1, 1)) << 8);
@@ -648,6 +677,10 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $data
+	 * @param integer $datLen
+	 */
 	function load($data, &$datLen)
 	{
 		$datLen = 0;
@@ -695,6 +728,10 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $data
+	 * @param integer $extLen
+	 */
 	function skipExt(&$data, &$extLen)
 	{
 		$extLen = 0;
@@ -740,6 +777,9 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $str
+	 */
 	function w2i($str)
 	{
 		return ord(substr($str, 0, 1)) + (ord(substr($str, 1, 1)) << 8);
@@ -811,6 +851,9 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param integer $iIndex
+	 */
 	function loadFile($lpszFileName, $iIndex)
 	{
 		if ($iIndex < 0) {
@@ -963,6 +1006,9 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param integer $bgColor
+	 */
 	function getPng($bgColor)
 	{
 		$out = '';

htdocs/modules/system/class/userrank.php

Doc Comments +1 added lines, -1 removed lines

@@ -115,7 +115,7 @@
 class systemuserrankHandler extends XoopsPersistableObjectHandler
 {
     /**
-     * @param null|XoopsDatabase $db
+     * @param XoopsDatabase $db
      */
     public function __construct(XoopsDatabase $db)
     {

htdocs/modules/system/include/functions.php

Doc Comments +2 added lines, -2 removed lines

@@ -19,7 +19,7 @@ 
  *
  * Comment by Taiwen Jiang (a.k.a. phppp): THE METHOD IS NOT COMPLETE AND NOT SAFE. YOU ARE ENCOURAGED TO USE PHP'S NATIVE FILTER_VAR OR FILTER_INPUT FUNCTIONS DIRECTLY BEFORE WE MIGRATE TO XOOPS 3.
  * @param                   $global
- * @param                   $key
+ * @param                   string $key
  * @param  string           $default
  * @param  string           $type
  * @return int|mixed|string
@@ -104,7 +104,7 @@ 
 }
 
 /**
- * @param $img
+ * @param string $img
  *
  * @return mixed
  */