getID3::__construct()

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Performance profile

How much work a call to getID3::__construct() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reads or writes the filesystem via is_dir().

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

57–132

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 232.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

9

9 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• filesystemfilesystem accessis_dir()called directly

What one call costs · 80 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost getID3::__construct() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 2

• getID3::warning()Warning handling.
• getid3_exception::__construct()

Used by · 9

• getid3_lib::GetDataImageSize()
• getid3_lyrics3::Analyze()
• getid3_matroska::Analyze()
• getid3_quicktime::QuicktimeParseAtom()
• getid3_riff::Analyze()
• getid3_riff::ParseRIFF()
• getid3_riff::ParseRIFFdata()
• wp_read_audio_metadata()Retrieves metadata from an audio file's ID3 tags.
• wp_read_video_metadata()Retrieves metadata from a video file's ID3 tags.

Source code

View on Trac ↗View on GitHub ↗

399	public function __construct() {400 401		// Check for PHP version402		$required_php_version = '5.3.0';403		if (version_compare(PHP_VERSION, $required_php_version, '<')) {404			$this->startup_error .= 'getID3() requires PHP v'.$required_php_version.' or higher - you are running v'.PHP_VERSION."\n";405			return;406		}407 408		// Check memory409		$memoryLimit = ini_get('memory_limit');410		if (preg_match('#([0-9]+) ?M#i', $memoryLimit, $matches)) {411			// could be stored as "16M" rather than 16777216 for example412			$memoryLimit = (int) $matches[1] * 1048576;413		} elseif (preg_match('#([0-9]+) ?G#i', $memoryLimit, $matches)) { // The 'G' modifier is available since PHP 5.1.0414			// could be stored as "2G" rather than 2147483648 for example415			$memoryLimit = (int) $matches[1] * 1073741824;416		}417		$this->memory_limit = $memoryLimit;418 419		if ($this->memory_limit <= 0) {420			// memory limits probably disabled421		} elseif ($this->memory_limit <= 4194304) {422			$this->startup_error .= 'PHP has less than 4MB available memory and will very likely run out. Increase memory_limit in php.ini'."\n";423		} elseif ($this->memory_limit <= 12582912) {424			$this->startup_warning .= 'PHP has less than 12MB available memory and might run out if all modules are loaded. Increase memory_limit in php.ini'."\n";425		}426 427		// Check safe_mode off428		if (preg_match('#(1|ON)#i', ini_get('safe_mode'))) {429			$this->warning('WARNING: Safe mode is on, shorten support disabled, md5data/sha1data for ogg vorbis disabled, ogg vorbos/flac tag writing disabled.');430		}431 432		if (($mbstring_func_overload = (int) ini_get('mbstring.func_overload')) && ($mbstring_func_overload & 0x02)) {433			// http://php.net/manual/en/mbstring.overload.php434			// "mbstring.func_overload in php.ini is a positive value that represents a combination of bitmasks specifying the categories of functions to be overloaded. It should be set to 1 to overload the mail() function. 2 for string functions, 4 for regular expression functions"435			// getID3 cannot run when string functions are overloaded. It doesn't matter if mail() or ereg* functions are overloaded since getID3 does not use those.436			$this->startup_error .= 'WARNING: php.ini contains "mbstring.func_overload = '.ini_get('mbstring.func_overload').'", getID3 cannot run with this setting (bitmask 2 (string functions) cannot be set). Recommended to disable entirely.'."\n";437		}438 439		// check for magic quotes in PHP < 5.4.0 (when these options were removed and getters always return false)440		if (version_compare(PHP_VERSION, '5.4.0', '<')) {441			// Check for magic_quotes_runtime442			if (function_exists('get_magic_quotes_runtime')) {443				if (get_magic_quotes_runtime()) { // @phpstan-ignore-line444					$this->startup_error .= 'magic_quotes_runtime must be disabled before running getID3(). Surround getid3 block by set_magic_quotes_runtime(0) and set_magic_quotes_runtime(1).'."\n";445				}446			}447			// Check for magic_quotes_gpc448			if (function_exists('get_magic_quotes_gpc')) {449				if (get_magic_quotes_gpc()) {450					$this->startup_error .= 'magic_quotes_gpc must be disabled before running getID3(). Surround getid3 block by set_magic_quotes_gpc(0) and set_magic_quotes_gpc(1).'."\n";451				}452			}453		}454 455		// Load support library456		if (!include_once(GETID3_INCLUDEPATH.'getid3.lib.php')) {457			$this->startup_error .= 'getid3.lib.php is missing or corrupt'."\n";458		}459 460		if ($this->option_max_2gb_check === null) {461			$this->option_max_2gb_check = (PHP_INT_MAX <= 2147483647);462		}463 464 465		// Needed for Windows only:466		// Define locations of helper applications for Shorten, VorbisComment, MetaFLAC467		//   as well as other helper functions such as head, etc468		// This path cannot contain spaces, but the below code will attempt to get the469		//   8.3-equivalent path automatically470		// IMPORTANT: This path must include the trailing slash471		if (GETID3_OS_ISWINDOWS && !defined('GETID3_HELPERAPPSDIR')) {472 473			$helperappsdir = GETID3_INCLUDEPATH.'..'.DIRECTORY_SEPARATOR.'helperapps'; // must not have any space in this path474 475			if (!is_dir($helperappsdir)) {476				$this->startup_warning .= '"'.$helperappsdir.'" cannot be defined as GETID3_HELPERAPPSDIR because it does not exist'."\n";477			} elseif (strpos(realpath($helperappsdir), ' ') !== false) {478				$DirPieces = explode(DIRECTORY_SEPARATOR, realpath($helperappsdir));

Changelog

Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/ID3/getid3.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.