Merge pull request #470 from StudioMaX/php85-deprecations

JamesHeinrich · web-flow · commit 4a586c4f62cc · 2025-09-03T08:05:41.000-04:00
Fix PHPStan warnings and PHP 8.5 deprecations
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -51,8 +51,8 @@ jobs:
       - uses: "actions/checkout@v4"
       - uses: "shivammathur/setup-php@v2"
         with:
-          php-version: "8.2"
-          tools: "phpstan:1.12.3"
+          php-version: "8.4"
+          tools: "phpstan:2.1.22"
           coverage: "none"
       - uses: "ramsey/composer-install@v3"
       - name: "Run PHPStan"
diff --git a/getid3/extension.cache.dbm.php b/getid3/extension.cache.dbm.php
@@ -73,12 +73,12 @@
 class getID3_cached_dbm extends getID3
 {
     /**
-     * @var resource
+     * @var null|resource|Dba\Connection
      */
-    private $dba;
+    private $dba; // @phpstan-ignore-line
 
     /**
-     * @var resource|bool
+     * @var resource|bool|null
      */
     private $lock;
 
diff --git a/getid3/getid3.lib.php b/getid3/getid3.lib.php
@@ -73,7 +73,8 @@ public static function trunc($floatnumber) {
 
 	/**
 	 * @param int|null $variable
-	 * @param int      $increment
+	 * @param-out int  $variable
+     * @param int      $increment
 	 *
 	 * @return bool
 	 */
@@ -115,7 +116,7 @@ public static function intValueSupported($num) {
 		// check if integers are 64-bit
 		static $hasINT64 = null;
 		if ($hasINT64 === null) { // 10x faster than is_null()
-			/** @var int|float|false $bigInt */
+			/** @var int|float|object $bigInt */
 			$bigInt = pow(2, 31);
 			$hasINT64 = is_int($bigInt); // 32-bit int are limited to (2^31)-1
 			if (!$hasINT64 && !defined('PHP_INT_MIN')) {
@@ -442,7 +443,7 @@ public static function BigEndian2String($number, $minbytes=1, $synchsafe=false,
 	}
 
 	/**
-	 * @param int $number
+	 * @param int|string $number
 	 *
 	 * @return string
 	 */
@@ -1741,7 +1742,7 @@ public static function EmbeddedLookup($key, $begin, $end, $file, $name) {
 			// METHOD B: cache all keys in this lookup - more memory but faster on next lookup of not-previously-looked-up key
 			//$cache[$file][$name][substr($line, 0, $keylength)] = trim(substr($line, $keylength + 1));
 			$explodedLine = explode("\t", $line, 2);
-			$ThisKey   = (isset($explodedLine[0]) ? $explodedLine[0] : '');
+			$ThisKey   = $explodedLine[0];
 			$ThisValue = (isset($explodedLine[1]) ? $explodedLine[1] : '');
 			$cache[$file][$name][$ThisKey] = trim($ThisValue);
 		}
@@ -1810,7 +1811,7 @@ public static function getFileSizeSyscall($path) {
 			$commandline = 'ls -l '.escapeshellarg($path).' | awk \'{print $5}\'';
 		}
 		if (isset($commandline)) {
-			$output = trim(`$commandline`);
+			$output = trim(shell_exec($commandline));
 			if (ctype_digit($output)) {
 				$filesize = (float) $output;
 			}
diff --git a/getid3/getid3.php b/getid3/getid3.php
@@ -481,7 +481,7 @@ public function __construct() {
 					if (strpos($value, ' ') !== false) {
 						if (!empty($path_so_far)) {
 							$commandline = 'dir /x '.escapeshellarg(implode(DIRECTORY_SEPARATOR, $path_so_far));
-							$dir_listing = `$commandline`;
+							$dir_listing = shell_exec($commandline);
 							$lines = explode("\n", $dir_listing);
 							foreach ($lines as $line) {
 								$line = trim($line);
@@ -529,7 +529,7 @@ public function fread_buffer_size() {
 	 * @return bool
 	 */
 	public function setOption($optArray) {
-		if (!is_array($optArray) || empty($optArray)) {
+		if (empty($optArray)) {
 			return false;
 		}
 		foreach ($optArray as $opt => $val) {
@@ -1821,7 +1821,7 @@ public function getHashdata($algorithm) {
 					if (file_exists(GETID3_HELPERAPPSDIR.'vorbiscomment.exe')) {
 
 						$commandline = '"'.GETID3_HELPERAPPSDIR.'vorbiscomment.exe" -w -c "'.$empty.'" "'.$file.'" "'.$temp.'"';
-						$VorbisCommentError = `$commandline`;
+						$VorbisCommentError = shell_exec($commandline);
 
 					} else {
 
@@ -1832,7 +1832,7 @@ public function getHashdata($algorithm) {
 				} else {
 
 					$commandline = 'vorbiscomment -w -c '.escapeshellarg($empty).' '.escapeshellarg($file).' '.escapeshellarg($temp).' 2>&1';
-					$VorbisCommentError = `$commandline`;
+					$VorbisCommentError = shell_exec($commandline);
 
 				}
 
diff --git a/getid3/module.audio-video.asf.php b/getid3/module.audio-video.asf.php
@@ -336,7 +336,7 @@ public function Analyze() {
 					// shortcut
 					$thisfile_asf['codec_list_object'] = array();
 					/** @var mixed[] $thisfile_asf_codeclistobject */
-					$thisfile_asf_codeclistobject      = &$thisfile_asf['codec_list_object'];
+					$thisfile_asf_codeclistobject      = &$thisfile_asf['codec_list_object']; // @phpstan-ignore-line
 
 					$thisfile_asf_codeclistobject['offset']                    = $NextObjectOffset + $offset;
 					$thisfile_asf_codeclistobject['objectid']                  = $NextObjectGUID;
diff --git a/getid3/module.audio-video.real.php b/getid3/module.audio-video.real.php
@@ -492,8 +492,8 @@ public function ParseOldRAheader($OldRAheaderData, &$ParsedArray) {
 			$ParsedArray['fourcc'] = $ParsedArray['fourcc3'];
 
 		}
-		/** @var string[]|false[] $value */
-		foreach ($ParsedArray['comments'] as $key => $value) {
+		/** @var array<string|false> $value */
+		foreach ($ParsedArray['comments'] as $key => $value) { // @phpstan-ignore-line
 			if ($value[0] === false) {
 				$ParsedArray['comments'][$key][0] = '';
 			}
diff --git a/getid3/module.audio-video.riff.php b/getid3/module.audio-video.riff.php
@@ -473,7 +473,7 @@ public function Analyze() {
 								@list($key, $value) = explode(':', $line, 2);
 								if (substr($value, 0, 3) == '[{"') {
 									if ($decoded = @json_decode($value, true)) {
-										if (!empty($decoded) && (count($decoded) == 1)) {
+										if (count($decoded) === 1) {
 											$value = $decoded[0];
 										} else {
 											$value = $decoded;
@@ -1375,7 +1375,7 @@ public function Analyze() {
 					$info['bitrate'] = ((($info['avdataend'] - $info['avdataoffset']) / $info['playtime_seconds']) * 8);
 				}
 
-			} elseif ($thisfile_riff_audio !== null && $thisfile_riff_video === null) {
+			} elseif ($thisfile_riff_audio !== null && $thisfile_riff_video === null) { // @phpstan-ignore-line
 
 				if (!isset($thisfile_audio['bitrate'])) {
 					$thisfile_audio['bitrate'] = ((($info['avdataend'] - $info['avdataoffset']) / $info['playtime_seconds']) * 8);
diff --git a/getid3/module.audio.midi.php b/getid3/module.audio.midi.php
@@ -88,7 +88,7 @@ public function Analyze() {
 			}
 		}
 
-		if (!is_array($trackdataarray) || count($trackdataarray) === 0) {
+		if (count($trackdataarray) === 0) {
 			$this->error('Cannot find MIDI track information');
 			unset($thisfile_midi);
 			unset($info['fileformat']);
diff --git a/getid3/module.audio.mp3.php b/getid3/module.audio.mp3.php
@@ -716,7 +716,7 @@ public function decodeMPEGaudioHeader($offset, &$info, $recursivesearch=true, $S
 						//$info['audio']['bitrate'] = (($framelengthfloat - intval($thisfile_mpeg_audio['padding'])) * $thisfile_mpeg_audio['sample_rate']) / 144;
 						$info['audio']['bitrate'] = $framelengthfloat * $thisfile_mpeg_audio['sample_rate'] * (2 / $info['audio']['channels']) / 144;
 					}
-					$thisfile_mpeg_audio['framelength'] = floor($framelengthfloat);
+					$thisfile_mpeg_audio['framelength'] = (int) floor($framelengthfloat);
 				}
 
 				if ($thisfile_mpeg_audio['xing_flags']['toc']) {
@@ -1178,7 +1178,6 @@ public function RecursiveFrameScanning(&$offset, &$nextframetestoffset, $ScanAsC
 
 			$nextframetestarray = array('error' => array(), 'warning' => array(), 'avdataend' => $info['avdataend'], 'avdataoffset'=>$info['avdataoffset']);
 			if ($this->decodeMPEGaudioHeader($nextframetestoffset, $nextframetestarray, false)) {
-				/** @phpstan-ignore-next-line */
 				getid3_lib::safe_inc($info['mp3_validity_check_bitrates'][$nextframetestarray['mpeg']['audio']['bitrate']]);
 				if ($ScanAsCBR) {
 					// force CBR mode, used for trying to pick out invalid audio streams with valid(?) VBR headers, or VBR streams with no VBR header
@@ -1190,7 +1189,7 @@ public function RecursiveFrameScanning(&$offset, &$nextframetestoffset, $ScanAsC
 
 				// next frame is OK, get ready to check the one after that
 				if (isset($nextframetestarray['mpeg']['audio']['framelength']) && ($nextframetestarray['mpeg']['audio']['framelength'] > 0)) {
-					$nextframetestoffset += $nextframetestarray['mpeg']['audio']['framelength'];
+					$nextframetestoffset += (int) $nextframetestarray['mpeg']['audio']['framelength'];
 				} else {
 					$this->error('Frame at offset ('.$offset.') is has an invalid frame length.');
 					return false;
diff --git a/getid3/module.audio.shorten.php b/getid3/module.audio.shorten.php
@@ -139,7 +139,7 @@ public function Analyze() {
 
 			static $shorten_present;
 			if (!isset($shorten_present)) {
-				$shorten_present = file_exists('/usr/local/bin/shorten') || `which shorten`;
+				$shorten_present = file_exists('/usr/local/bin/shorten') || shell_exec('which shorten');
 			}
 			if (!$shorten_present) {
 				$this->error('shorten binary was not found in path or /usr/local/bin');
@@ -149,7 +149,7 @@ public function Analyze() {
 
 		}
 
-		$output = `$commandline`;
+		$output = shell_exec($commandline);
 
 		if (!empty($output) && (substr($output, 12, 4) == 'fmt ')) {
 
diff --git a/getid3/module.audio.voc.php b/getid3/module.audio.voc.php
@@ -69,7 +69,6 @@ public function Analyze() {
 			$BlockSize      = getid3_lib::LittleEndian2Int(substr($BlockData, 1, 3));
 			$ThisBlock      = array();
 
-			/** @phpstan-ignore-next-line */
 			getid3_lib::safe_inc($thisfile_voc['blocktypes'][$BlockType], 1);
 			switch ($BlockType) {
 				case 0:  // Terminator
diff --git a/getid3/module.graphic.jpg.php b/getid3/module.graphic.jpg.php
@@ -117,7 +117,7 @@ public function Analyze() {
 
 			if (isset($info['jpg']['exif']['GPS']['GPSDateStamp'])) {
 				$explodedGPSDateStamp = explode(':', $info['jpg']['exif']['GPS']['GPSDateStamp']);
-				$computed_time[5] = (isset($explodedGPSDateStamp[0]) ? $explodedGPSDateStamp[0] : '');
+				$computed_time[5] = $explodedGPSDateStamp[0];
 				$computed_time[3] = (isset($explodedGPSDateStamp[1]) ? $explodedGPSDateStamp[1] : '');
 				$computed_time[4] = (isset($explodedGPSDateStamp[2]) ? $explodedGPSDateStamp[2] : '');
 
diff --git a/getid3/module.graphic.png.php b/getid3/module.graphic.png.php
@@ -160,7 +160,7 @@ public function Analyze() {
 							break;
 
 						default:
-							$this->warning('Unhandled color_type in tRNS chunk: '.$thisfile_png['IHDR']['raw']['color_type']); // @phpstan-ignore-line
+							$this->warning('Unhandled color_type in tRNS chunk: '.$thisfile_png['IHDR']['raw']['color_type']);
 							break;
 					}
 					break;
diff --git a/getid3/module.graphic.svg.php b/getid3/module.graphic.svg.php
@@ -59,7 +59,7 @@ public function Analyze() {
 					$keyvaluepair = trim($keyvaluepair);
 					if ($keyvaluepair) {
 						$keyvalueexploded = explode('=', $keyvaluepair);
-						$key   = (isset($keyvalueexploded[0]) ? $keyvalueexploded[0] : '');
+						$key   = $keyvalueexploded[0];
 						$value = (isset($keyvalueexploded[1]) ? $keyvalueexploded[1] : '');
 						$info['svg'][$section_to_fix]['sections'][$key] = trim($value, '"');
 					}
diff --git a/getid3/module.misc.cue.php b/getid3/module.misc.cue.php
@@ -147,7 +147,7 @@ public function parseCueSheet($file)
 	public function parseComment($line, $track_on)
 	{
 		$explodedline = explode(' ', $line, 3);
-		$comment_REM  = (isset($explodedline[0]) ? $explodedline[0] : '');
+		$comment_REM  = $explodedline[0];
 		$comment_type = (isset($explodedline[1]) ? $explodedline[1] : '');
 		$comment_data = (isset($explodedline[2]) ? $explodedline[2] : '');
 		if (($comment_REM == 'REM') && $comment_type) {
@@ -262,7 +262,7 @@ public function parseIndex($line, $track_on)
 
 		//extract the minutes, seconds, and frames
 		$explodedline = explode(':', $line);
-		$minutes = (isset($explodedline[0]) ? $explodedline[0] : '');
+		$minutes = $explodedline[0];
 		$seconds = (isset($explodedline[1]) ? $explodedline[1] : '');
 		$frames  = (isset($explodedline[2]) ? $explodedline[2] : '');
 
diff --git a/getid3/module.tag.id3v2.php b/getid3/module.tag.id3v2.php
@@ -659,7 +659,7 @@ public function ParseID3v2Frame(&$parsedFrame) {
 			// Owner identifier        <text string> $00
 			// Identifier              <up to 64 bytes binary data>
 			$exploded = explode("\x00", $parsedFrame['data'], 2);
-			$parsedFrame['ownerid'] = (isset($exploded[0]) ? $exploded[0] : '');
+			$parsedFrame['ownerid'] = $exploded[0];
 			$parsedFrame['data']    = (isset($exploded[1]) ? $exploded[1] : '');
 
 		} elseif ((($id3v2_majorversion >= 3) && ($parsedFrame['frame_name'] == 'TXXX')) || // 4.2.2 TXXX User defined text information frame
diff --git a/getid3/module.tag.lyrics3.php b/getid3/module.tag.lyrics3.php
@@ -231,7 +231,7 @@ public function getLyrics3Data($endoffset, $version, $length) {
 						foreach ($imagestrings as $key => $imagestring) {
 							if (strpos($imagestring, '||') !== false) {
 								$imagearray = explode('||', $imagestring);
-								$ParsedLyrics3['images'][$key]['filename']     =                                (isset($imagearray[0]) ? $imagearray[0] : '');
+								$ParsedLyrics3['images'][$key]['filename']     =                                $imagearray[0];
 								$ParsedLyrics3['images'][$key]['description']  =                                (isset($imagearray[1]) ? $imagearray[1] : '');
 								$ParsedLyrics3['images'][$key]['timestamp']    = $this->Lyrics3Timestamp2Seconds(isset($imagearray[2]) ? $imagearray[2] : '');
 							}
@@ -291,13 +291,13 @@ public function Lyrics3LyricsTimestampParse(&$Lyrics3data) {
 		$notimestamplyricsarray = array();
 		foreach ($lyricsarray as $key => $lyricline) {
 			$regs = array();
-			unset($thislinetimestamps);
+			$thislinetimestamps = array();
 			while (preg_match('#^(\\[[0-9]{2}:[0-9]{2}\\])#', $lyricline, $regs)) {
 				$thislinetimestamps[] = $this->Lyrics3Timestamp2Seconds($regs[0]);
 				$lyricline = str_replace($regs[0], '', $lyricline);
 			}
 			$notimestamplyricsarray[$key] = $lyricline;
-			if (isset($thislinetimestamps) && is_array($thislinetimestamps)) {
+			if (count($thislinetimestamps) > 0) {
 				sort($thislinetimestamps);
 				foreach ($thislinetimestamps as $timestampkey => $timestamp) {
 					if (isset($Lyrics3data['comments']['synchedlyrics'][$timestamp])) {
diff --git a/getid3/write.apetag.php b/getid3/write.apetag.php
@@ -27,7 +27,7 @@ class getid3_write_apetag
 	public $filename;
 
 	/**
-	 * @var array
+	 * @var array|null
 	 */
 	public $tag_data;
 
diff --git a/getid3/write.metaflac.php b/getid3/write.metaflac.php
@@ -118,7 +118,7 @@ public function WriteMetaFLAC() {
 					$commandline .= ' --import-picture-from='.escapeshellarg($picturecommand);
 				}
 				$commandline .= ' '.escapeshellarg($this->filename).' 2>&1';
-				$metaflacError = `$commandline`;
+				$metaflacError = shell_exec($commandline);
 
 				if (empty($metaflacError)) {
 					clearstatcache(true, $this->filename);
@@ -138,7 +138,7 @@ public function WriteMetaFLAC() {
 				$commandline .= ' --import-picture-from='.escapeshellarg($picturecommand);
 			}
 			$commandline .= ' '.escapeshellarg($this->filename).' 2>&1';
-			$metaflacError = `$commandline`;
+			$metaflacError = shell_exec($commandline);
 
 		}
 
@@ -177,7 +177,7 @@ public function DeleteMetaFLAC() {
 				$timestampbeforewriting = filemtime($this->filename);
 
 				$commandline = GETID3_HELPERAPPSDIR.'metaflac.exe --remove-all-tags "'.$this->filename.'" 2>&1';
-				$metaflacError = `$commandline`;
+				$metaflacError = shell_exec($commandline);
 
 				if (empty($metaflacError)) {
 					clearstatcache(true, $this->filename);
@@ -193,7 +193,7 @@ public function DeleteMetaFLAC() {
 
 			// It's simpler on *nix
 			$commandline = 'metaflac --remove-all-tags "'.$this->filename.'" 2>&1';
-			$metaflacError = `$commandline`;
+			$metaflacError = shell_exec($commandline);
 
 		}
 
diff --git a/getid3/write.php b/getid3/write.php
@@ -144,8 +144,8 @@ public function WriteTags() {
 			return false;
 		}
 
-		if (!is_array($this->tagformats)) {
-			$this->errors[] = 'tagformats must be an array in getid3_writetags';
+		if (count($this->tagformats) === 0) {
+			$this->errors[] = 'tagformats is empty in getid3_writetags';
 			return false;
 		}
 		// prevent duplicate tag formats
@@ -285,8 +285,8 @@ public function WriteTags() {
 		}
 
 		// Validation of supplied data
-		if (!is_array($this->tag_data)) {
-			$this->errors[] = '$this->tag_data is not an array in WriteTags()';
+		if (count($this->tag_data) === 0) {
+			$this->errors[] = '$this->tag_data is empty in WriteTags()';
 			return false;
 		}
 		// convert supplied data array keys to upper case, if they're not already
diff --git a/getid3/write.vorbiscomment.php b/getid3/write.vorbiscomment.php
@@ -88,7 +88,7 @@ public function WriteVorbisComment() {
 				$timestampbeforewriting = filemtime($this->filename);
 
 				$commandline = GETID3_HELPERAPPSDIR.'vorbiscomment.exe -w --raw -c "'.$tempcommentsfilename.'" "'.$this->filename.'" 2>&1';
-				$VorbiscommentError = `$commandline`;
+				$VorbiscommentError = shell_exec($commandline);
 
 				if (empty($VorbiscommentError)) {
 					clearstatcache(true, $this->filename);
@@ -103,7 +103,7 @@ public function WriteVorbisComment() {
 		} else {
 
 			$commandline = 'vorbiscomment -w --raw -c "'.$tempcommentsfilename.'" "'.$this->filename.'" 2>&1';
-			$VorbiscommentError = `$commandline`;
+			$VorbiscommentError = shell_exec($commandline);
 
 		}
 
diff --git a/phpstan.neon b/phpstan.neon
@@ -2,7 +2,6 @@ parameters:
     level: 4
     paths:
         - getid3
-    excludes_analyse:
     polluteScopeWithLoopInitialAssignments: true
     dynamicConstantNames:
         - GETID3_OS_ISWINDOWS

Original file line number	Diff line number	Diff line change
`@@ -492,8 +492,8 @@ public function ParseOldRAheader($OldRAheaderData, &$ParsedArray) {`
`492`	`492`	`$ParsedArray['fourcc'] = $ParsedArray['fourcc3'];`
`493`	`493`
`494`	`494`	`}`
`495`		`- /** @var string[]\|false[] $value */`
`496`		`- foreach ($ParsedArray['comments'] as $key => $value) {`
	`495`	`+ /** @var array<string\|false> $value */`
	`496`	`+ foreach ($ParsedArray['comments'] as $key => $value) { // @phpstan-ignore-line`
`497`	`497`	`if ($value[0] === false) {`
`498`	`498`	`$ParsedArray['comments'][$key][0] = '';`
`499`	`499`	`}`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ public function Analyze() {`
`88`	`88`	`}`
`89`	`89`	`}`
`90`	`90`
`91`		`- if (!is_array($trackdataarray) \|\| count($trackdataarray) === 0) {`
	`91`	`+ if (count($trackdataarray) === 0) {`
`92`	`92`	`$this->error('Cannot find MIDI track information');`
`93`	`93`	`unset($thisfile_midi);`
`94`	`94`	`unset($info['fileformat']);`
Original file line number	Diff line number	Diff line change
`@@ -139,7 +139,7 @@ public function Analyze() {`
`139`	`139`
`140`	`140`	`static $shorten_present;`
`141`	`141`	`if (!isset($shorten_present)) {`
`142`		- $shorten_present = file_exists('/usr/local/bin/shorten') \|\| `which shorten`;
	`142`	`+ $shorten_present = file_exists('/usr/local/bin/shorten') \|\| shell_exec('which shorten');`
`143`	`143`	`}`
`144`	`144`	`if (!$shorten_present) {`
`145`	`145`	`$this->error('shorten binary was not found in path or /usr/local/bin');`
`@@ -149,7 +149,7 @@ public function Analyze() {`
`149`	`149`
`150`	`150`	`}`
`151`	`151`
`152`		- $output = `$commandline`;
	`152`	`+ $output = shell_exec($commandline);`
`153`	`153`
`154`	`154`	`if (!empty($output) && (substr($output, 12, 4) == 'fmt ')) {`
`155`	`155`