XOOPS / XoopsCore25

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

Doc Comments +12 added lines

@@ -793,6 +793,9 @@ 
 
 	// from getid3.lib.php
 
+	/**
+	 * @param double $floatnumber
+	 */
 	public function trunc($floatnumber) {
 		// truncates a floating-point number at the decimal point
 		// returns int (if possible, otherwise float)
@@ -809,6 +812,9 @@ 
 		return $truncatednumber;
 	}
 
+	/**
+	 * @param string $byteword
+	 */
 	public function LittleEndian2Int($byteword) {
 		$intvalue = 0;
 		$byteword = strrev($byteword);
@@ -832,11 +838,17 @@ 
 		return $binvalue;
 	}
 
+	/**
+	 * @param string $rawdata
+	 */
 	public function FixedPoint2_30($rawdata) {
 		$binarystring = $this->BigEndian2Bin($rawdata);
 		return $this->Bin2Dec(substr($binarystring, 0, 2)) + (float) ($this->Bin2Dec(substr($binarystring, 2, 30)) / 1073741824);
 	}
 
+	/**
+	 * @param string $binstring
+	 */
 	public function Bin2Dec($binstring, $signed=false) {
 		$signmult = 1;
 		if ($signed) {

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

Doc Comments +26 added lines

@@ -345,6 +345,12 @@ 
 	}
 
 	// public:
+
+	/**
+	 * @param string $param
+	 *
+	 * @return integer
+	 */
 	public function getParameter($param) {
 		//if (property_exists('phpThumb', $param)) {
 			return $this->$param;
@@ -1119,6 +1125,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
+	 */
 	public function isInOpenBasedir($path) {
 		static $open_basedirs = null;
 		if (null === $open_basedirs) {
@@ -1136,6 +1146,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
+	 */
 	public function resolvePath($path, $allowed_dirs) {
 		$this->DebugMessage('resolvePath: '.$path.' (allowed_dirs: '.print_r($allowed_dirs, true).')', __FILE__, __LINE__);
 
@@ -1393,6 +1407,9 @@ 
 	}
 
 
+	/**
+	 * @return string
+	 */
 	public function ImageMagickCommandlineBase() {
 		static $commandline = null;
 		if (null === $commandline) {
@@ -4130,6 +4147,9 @@ 
 		return $this->ErrorImage(implode("\n", $DebugOutput), 700, 500, true);
 	}
 
+	/**
+	 * @param string $text
+	 */
 	public function FatalError($text) {
 		if (null === $this->fatalerror) {
 			$this->fatalerror = $text;
@@ -4137,6 +4157,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $text
+	 */
 	public 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);
@@ -4382,6 +4405,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $message
+	 */
 	public 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

@@ -18,6 +18,9 @@ 
 	public $phpThumbObject = null;
 
 
+	/**
+	 * @param string $message
+	 */
 	public function DebugMessage($message, $file='', $line='') {
 		if (is_object($this->phpThumbObject)) {
 			return $this->phpThumbObject->DebugMessage($message, $file, $line);
@@ -752,6 +755,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;
@@ -1049,6 +1055,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 +42 added lines

@@ -23,6 +23,9 @@ 
 	}
 
 
+	/**
+	 * @param string $functionname
+	 */
 	public 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
+	 */
 	public 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
+	 */
 	public 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
+	 */
 	public static function HexCharDisplay($string) {
 		$len = strlen($string);
 		$output = '';
@@ -292,6 +305,10 @@ 
 	}
 
 
+	/**
+	 * @param integer $width
+	 * @param integer $height
+	 */
 	public static function ScaleToFitInBox($width, $height, $maxwidth=null, $maxheight=null, $allow_enlarge=true, $allow_reduce=true) {
 		$maxwidth  = (null === $maxwidth  ? $width  : $maxwidth);
 		$maxheight = (null === $maxheight ? $height : $maxheight);
@@ -380,6 +397,12 @@ 
 	}
 
 
+	/**
+	 * @param integer $src_x
+	 * @param integer $src_y
+	 * @param integer $src_w
+	 * @param integer $src_h
+	 */
 	public 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
+	 */
 	public 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)) {
@@ -430,6 +457,9 @@ 
 	}
 
 
+	/**
+	 * @param string $function
+	 */
 	public static function FunctionIsDisabled($function) {
 		static $DisabledFunctions = null;
 		if (null === $DisabledFunctions) {
@@ -450,6 +480,11 @@ 
 	}
 
 
+	/**
+	 * @param string $command
+	 *
+	 * @return string
+	 */
 	public static function SafeExec($command) {
 		static $AllowedExecFunctions = array();
 		if (empty($AllowedExecFunctions)) {
@@ -626,6 +661,10 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $needle
+	 * @param string[] $haystack
+	 */
 	public static function CaseInsensitiveInArray($needle, $haystack) {
 		$needle = strtolower($needle);
 		foreach ($haystack as $key => $value) {
@@ -638,6 +677,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function URLreadFsock($host, $file, &$errstr, $successonly=true, $port=80, $timeout=10) {
 		if (!function_exists('fsockopen') || self::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
+	 */
 	public function deCompress($data, &$datLen)
 	{
 		$stLen  = strlen($data);
@@ -210,6 +217,11 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param boolean $bInit
+	 *
+	 * @return integer
+	 */
 	public function LZWCommand(&$data, $bInit)
 	{
 		if ($bInit) {
@@ -392,6 +404,10 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $lpData
+	 * @param integer $num
+	 */
 	public function load($lpData, $num)
 	{
 		$this->m_nColors  = 0;
@@ -504,6 +520,9 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param integer $hdrLen
+	 */
 	public function load($lpData, &$hdrLen)
 	{
 		$hdrLen = 0;
@@ -541,6 +560,9 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $str
+	 */
 	public function w2i($str)
 	{
 		return ord($str[ 0 ]) + (ord($str[ 1 ]) << 8);
@@ -579,6 +601,10 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $lpData
+	 * @param integer $hdrLen
+	 */
 	public function load($lpData, &$hdrLen)
 	{
 		$hdrLen = 0;
@@ -612,6 +638,9 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $str
+	 */
 	public function w2i($str)
 	{
 		return ord($str[ 0 ]) + (ord($str[ 1 ]) << 8);
@@ -649,6 +678,10 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $data
+	 * @param integer $datLen
+	 */
 	public function load($data, &$datLen)
 	{
 		$datLen = 0;
@@ -696,6 +729,10 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $data
+	 * @param integer $extLen
+	 */
 	public function skipExt(&$data, &$extLen)
 	{
 		$extLen = 0;
@@ -741,6 +778,9 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $str
+	 */
 	public function w2i($str)
 	{
 		return ord($str[ 0 ]) + (ord($str[ 1 ]) << 8);
@@ -814,6 +854,9 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param integer $iIndex
+	 */
 	public function loadFile($lpszFileName, $iIndex)
 	{
 		if ($iIndex < 0) {
@@ -967,6 +1010,9 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param integer $bgColor
+	 */
 	public function getPng($bgColor)
 	{
 		$out = '';