getID3::HandleAllTags(): bool

Compatibility

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

Return value

bool

Performance profile

How much work a call to getID3::HandleAllTags() 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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

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

Instructions

9–40

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What one call costs · 1 distinct outcome

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

Uses · 2

• getID3::CharConvert()Converts array to $encoding charset from $this->encoding.
• getid3_lib::recursiveMultiByteCharString2HTML()

Used by · 1

• getID3::analyze()analyze file

Source code

View on Trac ↗View on GitHub ↗

1627	public function HandleAllTags() {1628 1629		// key name => array (tag name, character encoding)1630		static $tags;1631		if (empty($tags)) {1632			$tags = array(1633				'asf'       => array('asf'           , 'UTF-16LE'),1634				'midi'      => array('midi'          , 'ISO-8859-1'),1635				'nsv'       => array('nsv'           , 'ISO-8859-1'),1636				'ogg'       => array('vorbiscomment' , 'UTF-8'),1637				'png'       => array('png'           , 'UTF-8'),1638				'tiff'      => array('tiff'          , 'ISO-8859-1'),1639				'quicktime' => array('quicktime'     , 'UTF-8'),1640				'real'      => array('real'          , 'ISO-8859-1'),1641				'vqf'       => array('vqf'           , 'ISO-8859-1'),1642				'zip'       => array('zip'           , 'ISO-8859-1'),1643				'riff'      => array('riff'          , 'ISO-8859-1'),1644				'lyrics3'   => array('lyrics3'       , 'ISO-8859-1'),1645				'id3v1'     => array('id3v1'         , $this->encoding_id3v1),1646				'id3v2'     => array('id3v2'         , 'UTF-8'), // not according to the specs (every frame can have a different encoding), but getID3() force-converts all encodings to UTF-81647				'ape'       => array('ape'           , 'UTF-8'),1648				'cue'       => array('cue'           , 'ISO-8859-1'),1649				'matroska'  => array('matroska'      , 'UTF-8'),1650				'flac'      => array('vorbiscomment' , 'UTF-8'),1651				'divxtag'   => array('divx'          , 'ISO-8859-1'),1652				'iptc'      => array('iptc'          , 'ISO-8859-1'),1653				'dsdiff'    => array('dsdiff'        , 'ISO-8859-1'),1654			);1655		}1656 1657		// loop through comments array1658		foreach ($tags as $comment_name => $tagname_encoding_array) {1659			list($tag_name, $encoding) = $tagname_encoding_array;1660 1661			// fill in default encoding type if not already present1662			if (isset($this->info[$comment_name]) && !isset($this->info[$comment_name]['encoding'])) {1663				$this->info[$comment_name]['encoding'] = $encoding;1664			}1665 1666			// copy comments if key name set1667			if (!empty($this->info[$comment_name]['comments'])) {1668				foreach ($this->info[$comment_name]['comments'] as $tag_key => $valuearray) {1669					foreach ($valuearray as $key => $value) {1670						if (is_string($value)) {1671							$value = trim($value, " \r\n\t"); // do not trim nulls from $value!! Unicode characters will get mangled if trailing nulls are removed!1672						}1673						if (isset($value) && $value !== "") {1674							if (!is_numeric($key)) {1675								$this->info['tags'][trim($tag_name)][trim($tag_key)][$key] = $value;1676							} else {1677								$this->info['tags'][trim($tag_name)][trim($tag_key)][]     = $value;1678							}1679						}1680					}1681					if ($tag_key == 'picture') {1682						// pictures can take up a lot of space, and we don't need multiple copies of them; let there be a single copy in [comments][picture], and not elsewhere1683						unset($this->info[$comment_name]['comments'][$tag_key]);1684					}1685				}1686 1687				if (!isset($this->info['tags'][$tag_name])) {1688					// comments are set but contain nothing but empty strings, so skip1689					continue;1690				}1691 1692				$this->CharConvert($this->info['tags'][$tag_name], $this->info[$comment_name]['encoding']);           // only copy gets converted!1693 1694				if ($this->option_tags_html) {1695					foreach ($this->info['tags'][$tag_name] as $tag_key => $valuearray) {1696						if ($tag_key == 'picture') {1697							// Do not to try to convert binary picture data to HTML1698							// https://github.com/JamesHeinrich/getID3/issues/1781699							continue;1700						}1701						$this->info['tags_html'][$tag_name][$tag_key] = getid3_lib::recursiveMultiByteCharString2HTML($valuearray, $this->info[$comment_name]['encoding']);1702					}1703				}1704 1705			}1706

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.