XOOPS / XoopsCore25

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/profile/include/install.php

Doc Comments +17 added lines, -17 removed lines

@@ -101,17 +101,17 @@ 
 
 // canedit: 0 - no; 1 - admin; 2 - admin & owner
 /**
- * @param      $name
- * @param      $title
- * @param      $description
- * @param      $category
- * @param      $type
- * @param      $valuetype
- * @param      $weight
- * @param      $canedit
+ * @param      string $name
+ * @param      string $title
+ * @param      string $description
+ * @param      integer $category
+ * @param      string $type
+ * @param      integer $valuetype
+ * @param      integer $weight
+ * @param      integer $canedit
  * @param      $options
- * @param      $step_id
- * @param      $length
+ * @param      integer $step_id
+ * @param      integer $length
  * @param bool $visible
  *
  * @return bool
@@ -183,7 +183,7 @@ 
  * @param $field_id
  * @param $module_id
  * @param $canedit
- * @param $visible
+ * @param boolean $visible
  */
 function profile_install_setPermissions($field_id, $module_id, $canedit, $visible)
 {
@@ -199,8 +199,8 @@ 
 }
 
 /**
- * @param $name
- * @param $weight
+ * @param string $name
+ * @param integer $weight
  */
 function profile_install_addCategory($name, $weight)
 {
@@ -208,10 +208,10 @@ 
 }
 
 /**
- * @param $name
- * @param $desc
- * @param $order
- * @param $save
+ * @param string $name
+ * @param string $desc
+ * @param integer $order
+ * @param integer $save
  */
 function profile_install_addStep($name, $desc, $order, $save)
 {

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.filters.php

Doc Comments +10 added lines

@@ -17,6 +17,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $message
+     */
     function DebugMessage($message, $file='', $line='') {
         if (is_object($this->phpThumbObject)) {
             return $this->phpThumbObject->DebugMessage($message, $file, $line);
@@ -753,6 +756,9 @@ 
     }
 
 
+    /**
+     * @param phpthumb $phpThumbObject
+     */
     public static function ImprovedImageRotate(&$gdimg_source, $rotate_angle=0, $config_background_hexcolor='FFFFFF', $bg=null, &$phpThumbObject) {
         while ($rotate_angle < 0) {
             $rotate_angle += 360;
@@ -1048,6 +1054,10 @@ 
     }
 
 
+    /**
+     * @param boolean $dither
+     * @param integer $ncolors
+     */
     public function ImageTrueColorToPalette2(&$image, $dither, $ncolors) {
         // http://www.php.net/manual/en/function.imagetruecolortopalette.php
         // zmorris at zsculpt dot com (17-Aug-2004 06:58)

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

Doc Comments +45 added lines

@@ -23,6 +23,9 @@ 
 	}
 
 
+	/**
+	 * @param string $functionname
+	 */
 	static function builtin_function_exists($functionname) {
 		if (function_exists('get_defined_functions')) {
 			static $get_defined_functions = array();
@@ -35,6 +38,10 @@ 
 	}
 
 
+	/**
+	 * @param string $version1
+	 * @param string $version2
+	 */
 	static function version_compare_replacement_sub($version1, $version2, $operator='') {
 		// If you specify the third optional operator argument, you can test for a particular relationship.
 		// The possible operators are: <, lt, <=, le, >, gt, >=, ge, ==, =, eq, !=, <>, ne respectively.
@@ -95,6 +102,9 @@ 
 	}
 
 
+	/**
+	 * @param string $version2
+	 */
 	static function version_compare_replacement($version1, $version2, $operator='') {
 		if (function_exists('version_compare')) {
 			// built into PHP v4.1.0+
@@ -212,6 +222,9 @@ 
 		return array($newwidth, $newheight);
 	}
 
+	/**
+	 * @param string $string
+	 */
 	static function HexCharDisplay($string) {
 		$len = strlen($string);
 		$output = '';
@@ -292,6 +305,10 @@ 
 	}
 
 
+	/**
+	 * @param integer $width
+	 * @param integer $height
+	 */
 	static function ScaleToFitInBox($width, $height, $maxwidth=null, $maxheight=null, $allow_enlarge=true, $allow_reduce=true) {
 		$maxwidth  = (is_null($maxwidth)  ? $width  : $maxwidth);
 		$maxheight = (is_null($maxheight) ? $height : $maxheight);
@@ -380,6 +397,12 @@ 
 	}
 
 
+	/**
+	 * @param integer $src_x
+	 * @param integer $src_y
+	 * @param integer $src_w
+	 * @param integer $src_h
+	 */
 	static function ImageCopyRespectAlpha(&$dst_im, &$src_im, $dst_x, $dst_y, $src_x, $src_y, $src_w, $src_h, $opacity_pct=100) {
 		$opacipct = $opacity_pct / 100;
 		for ($x = $src_x; $x < $src_w; $x++) {
@@ -404,6 +427,10 @@ 
 	}
 
 
+	/**
+	 * @param integer $old_width
+	 * @param integer $old_height
+	 */
 	static function ProportionalResize($old_width, $old_height, $new_width=false, $new_height=false) {
 		$old_aspect_ratio = $old_width / $old_height;
 		if (($new_width === false) && ($new_height === false)) {
@@ -427,6 +454,9 @@ 
 	}
 
 
+	/**
+	 * @param string $function
+	 */
 	static function FunctionIsDisabled($function) {
 		static $DisabledFunctions = null;
 		if (is_null($DisabledFunctions)) {
@@ -447,6 +477,11 @@ 
 	}
 
 
+	/**
+	 * @param string $command
+	 *
+	 * @return string
+	 */
 	static function SafeExec($command) {
 		static $AllowedExecFunctions = array();
 		if (empty($AllowedExecFunctions)) {
@@ -603,6 +638,9 @@ 
 	}
 
 
+	/**
+	 * @param integer $number
+	 */
 	static function LittleEndian2String($number, $minbytes=1) {
 		$intstring = '';
 		while ($number > 0) {
@@ -623,6 +661,10 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $needle
+	 * @param string[] $haystack
+	 */
 	static function CaseInsensitiveInArray($needle, $haystack) {
 		$needle = strtolower($needle);
 		foreach ($haystack as $key => $value) {
@@ -635,6 +677,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $file
+	 */
 	static function URLreadFsock($host, $file, &$errstr, $successonly=true, $port=80, $timeout=10) {
 		if (!function_exists('fsockopen') || phpthumb_functions::FunctionIsDisabled('fsockopen')) {
 			$errstr = 'fsockopen() unavailable';

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 = '';