getid3_lib::CopyTagsToComments( array $ThisFileInfo, bool $option_tags_html = true ): bool

Compatibility

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

Parameters

$ThisFileInfoarray

$option_tags_htmlbooloptional

default true (just as in the main getID3 class)Default: true

Return value

bool

Performance profile

How much work a call to getid3_lib::CopyTagsToComments() 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 what you pass in.

Instructions

5–24

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

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_lib::CopyTagsToComments() can have, taken from its control-flow graph on PHP 8.5.

Uses · 3

• mb_strlen()Compat function to mimic mb_strlen().
• getid3_lib::iconv_fallback()
• getid3_lib::MultiByteCharString2HTML()

Used by · 1

• getID3::CopyTagsToComments()Calls getid3_lib::CopyTagsToComments() but passes in the option_tags_html setting from this instance of getID3

Source code

View on Trac ↗View on GitHub ↗

1570	public static function CopyTagsToComments(&$ThisFileInfo, $option_tags_html=true) {1571		// Copy all entries from ['tags'] into common ['comments']1572		if (!empty($ThisFileInfo['tags'])) {1573 1574			// Some tag types can only support limited character sets and may contain data in non-standard encoding (usually ID3v1)1575			// and/or poorly-transliterated tag values that are also in tag formats that do support full-range character sets1576			// To make the output more user-friendly, process the potentially-problematic tag formats last to enhance the chance that1577			// the first entries in [comments] are the most correct and the "bad" ones (if any) come later.1578			// https://github.com/JamesHeinrich/getID3/issues/3381579			$processLastTagTypes = array('id3v1','riff');1580			foreach ($processLastTagTypes as $processLastTagType) {1581				if (isset($ThisFileInfo['tags'][$processLastTagType])) {1582					// bubble ID3v1 to the end, if present to aid in detecting bad ID3v1 encodings1583					$temp = $ThisFileInfo['tags'][$processLastTagType];1584					unset($ThisFileInfo['tags'][$processLastTagType]);1585					$ThisFileInfo['tags'][$processLastTagType] = $temp;1586					unset($temp);1587				}1588			}1589			foreach ($ThisFileInfo['tags'] as $tagtype => $tagarray) {1590				foreach ($tagarray as $tagname => $tagdata) {1591					foreach ($tagdata as $key => $value) {1592						if (!empty($value)) {1593							if (empty($ThisFileInfo['comments'][$tagname])) {1594 1595								// fall through and append value1596 1597							} elseif ($tagtype == 'id3v1') {1598 1599								$newvaluelength = strlen(trim($value));1600								foreach ($ThisFileInfo['comments'][$tagname] as $existingkey => $existingvalue) {1601									$oldvaluelength = strlen(trim($existingvalue));1602									if (($newvaluelength <= $oldvaluelength) && (substr($existingvalue, 0, $newvaluelength) == trim($value))) {1603										// new value is identical but shorter-than (or equal-length to) one already in comments - skip1604										break 2;1605									}1606 1607									if (function_exists('mb_convert_encoding')) {1608										if (trim($value) == trim(substr(mb_convert_encoding($existingvalue, $ThisFileInfo['id3v1']['encoding'], $ThisFileInfo['encoding']), 0, 30))) {1609											// value stored in ID3v1 appears to be probably the multibyte value transliterated (badly) into ISO-8859-1 in ID3v1.1610											// As an example, Foobar2000 will do this if you tag a file with Chinese or Arabic or Cyrillic or something that doesn't fit into ISO-8859-1 the ID3v1 will consist of mostly "?" characters, one per multibyte unrepresentable character1611											break 2;1612										}1613									}1614								}1615 1616							} elseif (!is_array($value)) {1617 1618								$newvaluelength   =    strlen(trim($value));1619								$newvaluelengthMB = mb_strlen(trim($value));1620								foreach ($ThisFileInfo['comments'][$tagname] as $existingkey => $existingvalue) {1621									$oldvaluelength   =    strlen(trim($existingvalue));1622									$oldvaluelengthMB = mb_strlen(trim($existingvalue));1623									if (($newvaluelengthMB == $oldvaluelengthMB) && ($existingvalue == getid3_lib::iconv_fallback('UTF-8', 'ASCII', $value))) {1624										// https://github.com/JamesHeinrich/getID3/issues/3381625										// check for tags containing extended characters that may have been forced into limited-character storage (e.g. UTF8 values into ASCII)1626										// which will usually display unrepresentable characters as "?"1627										$ThisFileInfo['comments'][$tagname][$existingkey] = trim($value);1628										break;1629									}1630									if ((strlen($existingvalue) > 10) && ($newvaluelength > $oldvaluelength) && (substr(trim($value), 0, strlen($existingvalue)) == $existingvalue)) {1631										$ThisFileInfo['comments'][$tagname][$existingkey] = trim($value);1632										break;1633									}1634								}1635 1636							}1637							if (is_array($value) || empty($ThisFileInfo['comments'][$tagname]) || !in_array(trim($value), $ThisFileInfo['comments'][$tagname])) {1638								$value = (is_string($value) ? trim($value) : $value);1639								if (!is_int($key) && !ctype_digit($key)) {1640									$ThisFileInfo['comments'][$tagname][$key] = $value;1641								} else {1642									if (!isset($ThisFileInfo['comments'][$tagname])) {1643										$ThisFileInfo['comments'][$tagname] = array($value);1644									} else {1645										$ThisFileInfo['comments'][$tagname][] = $value;1646									}1647								}1648							}1649						}

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.lib.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.