GetId3\Lib\Helper Class Reference

GetId3() by James Heinrich info@.nosp@m.geti.nosp@m.d3.or.nosp@m.g //. More...

Collaboration diagram for GetId3\Lib\Helper:

Static Public Member Functions
static	PrintHexBytes ($string, $hex=true, $spaces=true, $htmlencoding='UTF-8')
static	trunc ($floatnumber)
static	safe_inc (&$variable, $increment=1)
static	CastAsInt ($floatnum)
static	intValueSupported ($num)
	@staticvar null $hasINT64 More...
static	DecimalizeFraction ($fraction)
static	DecimalBinary2Float ($binarynumerator)
static	NormalizeBinaryPoint ($binarypointnumber, $maxbits=52)
static	Float2BinaryDecimal ($floatvalue)
static	Float2String ($floatvalue, $bits)
static	LittleEndian2Float ($byteword)
static	BigEndian2Float ($byteword)
	ANSI/IEEE Standard 754-1985, Standard for Binary Floating Point Arithmetic. More...
static	BigEndian2Int ($byteword, $synchsafe=false, $signed=false)
static	LittleEndian2Int ($byteword, $signed=false)
static	BigEndian2Bin ($byteword)
static	BigEndian2String ($number, $minbytes=1, $synchsafe=false, $signed=false)
static	Dec2Bin ($number)
static	Bin2Dec ($binstring, $signed=false)
static	Bin2String ($binstring)
static	LittleEndian2String ($number, $minbytes=1, $synchsafe=false)
static	array_merge_clobber ($array1, $array2)
static	array_merge_noclobber ($array1, $array2)
static	ksort_recursive (&$theArray)
static	fileextension ($filename, $numextensions=1)
static	PlaytimeString ($seconds)
static	DateMac2Unix ($macdate)
static	FixedPoint8_8 ($rawdata)
static	FixedPoint16_16 ($rawdata)
static	FixedPoint2_30 ($rawdata)
static	CreateDeepArray ($ArrayPath, $Separator, $Value)
static	array_max ($arraydata, $returnkey=false)
static	array_min ($arraydata, $returnkey=false)
static	XML2array ($XMLstring)
static	SimpleXMLelement2array ($XMLobject)
static	hash_data ($file, $offset, $end, $algorithm)
	self::md5_data() - returns md5sum for a file from startuing position to absolute end position More...
static	CopyFileParts ($filename_source, $filename_dest, $offset, $length)
static	iconv_fallback_int_utf8 ($charval)
static	iconv_fallback_iso88591_utf8 ($string, $bom=false)
	ISO-8859-1 => UTF-8. More...
static	iconv_fallback_iso88591_utf16be ($string, $bom=false)
	ISO-8859-1 => UTF-16BE. More...
static	iconv_fallback_iso88591_utf16le ($string, $bom=false)
	ISO-8859-1 => UTF-16LE. More...
static	iconv_fallback_iso88591_utf16 ($string)
	ISO-8859-1 => UTF-16LE (BOM) More...
static	iconv_fallback_utf8_iso88591 ($string)
	UTF-8 => ISO-8859-1. More...
static	iconv_fallback_utf8_utf16be ($string, $bom=false)
	UTF-8 => UTF-16BE. More...
static	iconv_fallback_utf8_utf16le ($string, $bom=false)
	UTF-8 => UTF-16LE. More...
static	iconv_fallback_utf8_utf16 ($string)
	UTF-8 => UTF-16LE (BOM) More...
static	iconv_fallback_utf16be_utf8 ($string)
	UTF-16BE => UTF-8. More...
static	iconv_fallback_utf16le_utf8 ($string)
	UTF-16LE => UTF-8. More...
static	iconv_fallback_utf16be_iso88591 ($string)
	UTF-16BE => ISO-8859-1. More...
static	iconv_fallback_utf16le_iso88591 ($string)
	UTF-16LE => ISO-8859-1. More...
static	iconv_fallback_utf16_iso88591 ($string)
	UTF-16 (BOM) => ISO-8859-1. More...
static	iconv_fallback_utf16_utf8 ($string)
	UTF-16 (BOM) => UTF-8. More...
static	iconv_fallback ($in_charset, $out_charset, $string)
	@staticvar array $ConversionFunctionList More...
static	MultiByteCharString2HTML ($string, $charset='ISO-8859-1')
static	RGADnameLookup ($namecode)
	@staticvar array $RGADname More...
static	RGADoriginatorLookup ($originatorcode)
	@staticvar array $RGADoriginator More...
static	RGADadjustmentLookup ($rawadjustment, $signbit)
static	RGADgainString ($namecode, $originatorcode, $replaygain)
static	RGADamplitude2dB ($amplitude)
static	GetDataImageSize ($imgData, &$imageinfo)
	@staticvar string $tempdir More...
static	ImageTypesLookup ($imagetypeid)
	@staticvar array $ImageTypesLookup More...
static	CopyTagsToComments (&$ThisFileInfo)
static	EmbeddedLookup ($key, $begin, $end, $file, $name)
	@staticvar type $cache More...
static	trimNullByte ($string)
static	toCamelCase ($origin, $cahrToReplace='_', $capitaliseFirstChar=false)

Detailed Description

GetId3() by James Heinrich info@.nosp@m.geti.nosp@m.d3.or.nosp@m.g //.

module for analyzing Ogg Vorbis, OggFLAC and Speex files

Author

James Heinrich info@.nosp@m.geti.nosp@m.d3.or.nosp@m.g http://www.getid3.org

Definition at line 26 of file Helper.php.

Member Function Documentation

array_max()

static GetId3\Lib\Helper::array_max (   $arraydata,   $returnkey = false  )

static

Parameters

type	$arraydata
type	$returnkey

Returns

type

Definition at line 755 of file Helper.php.

    {
        $maxvalue = false;
        $maxkey = false;
        foreach ($arraydata as $key => $value) {
            if (!is_array($value)) {
                if ($value > $maxvalue) {
                    $maxvalue = $value;
                    $maxkey = $key;
                }
            }
        }
 
        return ($returnkey ? $maxkey : $maxvalue);
    }

Referenced by GetId3\Module\Audio\Mp3\getOnlyMPEGaudioInfoBruteForce().

Here is the caller graph for this function:

array_merge_clobber()

static GetId3\Lib\Helper::array_merge_clobber (   $array1,   $array2  )

static

Parameters

type	$array1
type	$array2

Returns

boolean

Definition at line 561 of file Helper.php.

    {
        // written by kcØhireability*com
        // taken from http://www.php.net/manual/en/function.array-merge-recursive.php
        if (!is_array($array1) || !is_array($array2)) {
            return false;
        }
        $newarray = $array1;
        foreach ($array2 as $key => $val) {
            if (is_array($val) && isset($newarray[$key]) && is_array($newarray[$key])) {
                $newarray[$key] = self::array_merge_clobber($newarray[$key],
                                                            $val);
            } else {
                $newarray[$key] = $val;
            }
        }
 
        return $newarray;
    }

References GetId3\Lib\Helper\array_merge_clobber().

Referenced by GetId3\Module\Archive\Gzip\analyze(), GetId3\Module\Archive\Rar\analyze(), GetId3\Module\Archive\Tar\analyze(), GetId3\Module\Archive\Zip\analyze(), GetId3\Lib\Helper\array_merge_clobber(), and GetId3\Module\Misc\Iso\ParseDirectoryRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

array_merge_noclobber()

static GetId3\Lib\Helper::array_merge_noclobber (   $array1,   $array2  )

static

Parameters

type	$array1
type	$array2

Returns

boolean

Definition at line 587 of file Helper.php.

    {
        if (!is_array($array1) || !is_array($array2)) {
            return false;
        }
        $newarray = $array1;
        foreach ($array2 as $key => $val) {
            if (is_array($val) && isset($newarray[$key]) && is_array($newarray[$key])) {
                $newarray[$key] = self::array_merge_noclobber($newarray[$key],
                                                              $val);
            } elseif (!isset($newarray[$key])) {
                $newarray[$key] = $val;
            }
        }
 
        return $newarray;
    }

References GetId3\Lib\Helper\array_merge_noclobber().

Referenced by GetId3\Module\AudioVideo\Asf\analyze(), GetId3\Module\AudioVideo\Riff\analyze(), GetId3\Module\Tag\Id3v2\analyze(), and GetId3\Lib\Helper\array_merge_noclobber().

Here is the call graph for this function:

Here is the caller graph for this function:

array_min()

static GetId3\Lib\Helper::array_min (   $arraydata,   $returnkey = false  )

static

Parameters

type	$arraydata
type	$returnkey

Returns

type

Definition at line 777 of file Helper.php.

    {
        $minvalue = false;
        $minkey = false;
        foreach ($arraydata as $key => $value) {
            if (!is_array($value)) {
                if ($value > $minvalue) {
                    $minvalue = $value;
                    $minkey = $key;
                }
            }
        }
 
        return ($returnkey ? $minkey : $minvalue);
    }

BigEndian2Bin()

static GetId3\Lib\Helper::BigEndian2Bin (   $byteword )

static

Parameters

type

$byteword

Returns

type

Definition at line 423 of file Helper.php.

    {
        $binvalue = '';
        $bytewordlen = strlen($byteword);
        for ($i = 0; $i < $bytewordlen; $i++) {
            $binvalue .= str_pad(decbin(ord($byteword{$i})), 8, '0',
                                            STR_PAD_LEFT);
        }
 
        return $binvalue;
    }

Referenced by GetId3\Module\Audio\Ac3\analyze(), GetId3\Module\Audio\Dts\analyze(), GetId3\Module\AudioVideo\Mpeg\analyze(), GetId3\Lib\Helper\BigEndian2Float(), GetId3\Lib\Helper\FixedPoint2_30(), GetId3\Module\Audio\Aac\getAACADIFheaderFilepointer(), GetId3\Module\Tag\Id3v2\ParseID3v2Frame(), and GetId3\Module\Audio\Flac\parseSTREAMINFO().

Here is the caller graph for this function:

BigEndian2Float()

static GetId3\Lib\Helper::BigEndian2Float (   $byteword )

static

ANSI/IEEE Standard 754-1985, Standard for Binary Floating Point Arithmetic.

Parameters

type

$byteword

Returns

int|boolean http://www.scri.fsu.edu/~jac/MAD3401/Backgrnd/ieee.html

Definition at line 290 of file Helper.php.

    {
        $bitword = self::BigEndian2Bin($byteword);
        if (!$bitword) {
            return 0;
        }
        $signbit = $bitword{0};
 
        switch (strlen($byteword) * 8) {
            case 32:
                $exponentbits = 8;
                $fractionbits = 23;
                break;
 
            case 64:
                $exponentbits = 11;
                $fractionbits = 52;
                break;
 
            case 80:
                // 80-bit Apple SANE format
                // http://www.mactech.com/articles/mactech/Vol.06/06.01/SANENormalized/
                $exponentstring = substr($bitword, 1, 15);
                $isnormalized = intval($bitword{16});
                $fractionstring = substr($bitword, 17, 63);
                $exponent = pow(2, self::Bin2Dec($exponentstring) - 16383);
                $fraction = $isnormalized + self::DecimalBinary2Float($fractionstring);
                $floatvalue = $exponent * $fraction;
                if ($signbit == '1') {
                    $floatvalue *= -1;
                }
 
                return $floatvalue;
                break;
 
            default:
                return false;
                break;
        }
        $exponentstring = substr($bitword, 1, $exponentbits);
        $fractionstring = substr($bitword, $exponentbits + 1, $fractionbits);
        $exponent = self::Bin2Dec($exponentstring);
        $fraction = self::Bin2Dec($fractionstring);
 
        if (($exponent == (pow(2, $exponentbits) - 1)) && ($fraction != 0)) {
            // Not a Number
            $floatvalue = false;
        } elseif (($exponent == (pow(2, $exponentbits) - 1)) && ($fraction == 0)) {
            if ($signbit == '1') {
                $floatvalue = '-infinity';
            } else {
                $floatvalue = '+infinity';
            }
        } elseif (($exponent == 0) && ($fraction == 0)) {
            if ($signbit == '1') {
                $floatvalue = -0;
            } else {
                $floatvalue = 0;
            }
            $floatvalue = ($signbit ? 0 : -0);
        } elseif (($exponent == 0) && ($fraction != 0)) {
            // These are 'unnormalized' values
            $floatvalue = pow(2, (-1 * (pow(2, $exponentbits - 1) - 2))) * self::DecimalBinary2Float($fractionstring);
            if ($signbit == '1') {
                $floatvalue *= -1;
            }
        } elseif ($exponent != 0) {
            $floatvalue = pow(2, ($exponent - (pow(2, $exponentbits - 1) - 1))) * (1 + self::DecimalBinary2Float($fractionstring));
            if ($signbit == '1') {
                $floatvalue *= -1;
            }
        }
 
        return (float) $floatvalue;
    }

References GetId3\Lib\Helper\BigEndian2Bin(), GetId3\Lib\Helper\Bin2Dec(), and GetId3\Lib\Helper\DecimalBinary2Float().

Referenced by GetId3\Module\AudioVideo\Riff\analyze(), GetId3\Lib\Helper\LittleEndian2Float(), GetId3\Module\AudioVideo\Matroska\parseEBML(), GetId3\Module\Tag\Id3v2\ParseID3v2Frame(), and GetId3\Module\AudioVideo\AMFStream\readDouble().

Here is the call graph for this function:

Here is the caller graph for this function:

BigEndian2Int()

static GetId3\Lib\Helper::BigEndian2Int (   $byteword,   $synchsafe = false,   $signed = false  )

static

Parameters

type	$byteword
type	$synchsafe
type	$signed

Returns

boolean

Exceptions

Exception

Definition at line 374 of file Helper.php.

    {
        $intvalue = 0;
        $bytewordlen = strlen($byteword);
        if ($bytewordlen == 0) {
            return false;
        }
        for ($i = 0; $i < $bytewordlen; $i++) {
            if ($synchsafe) { // disregard MSB, effectively 7-bit bytes
                //$intvalue = $intvalue | (ord($byteword{$i}) & 0x7F) << (($bytewordlen - 1 - $i) * 7); // faster, but runs into problems past 2^31 on 32-bit systems
                $intvalue += (ord($byteword{$i}) & 0x7F) * pow(2,
                                                               ($bytewordlen - 1 - $i) * 7);
            } else {
                $intvalue += ord($byteword{$i}) * pow(256,
                                                      ($bytewordlen - 1 - $i));
            }
        }
        if ($signed && !$synchsafe) {
            // synchsafe ints are not allowed to be signed
            if ($bytewordlen <= PHP_INT_SIZE) {
                $signMaskBit = 0x80 << (8 * ($bytewordlen - 1));
                if ($intvalue & $signMaskBit) {
                    $intvalue = 0 - ($intvalue & ($signMaskBit - 1));
                }
            } else {
                throw new DefaultException('ERROR: Cannot have signed integers larger than ' . (8 * PHP_INT_SIZE) . '-bits (' . strlen($byteword) . ') in self::BigEndian2Int()');
            }
        }
 
        return self::CastAsInt($intvalue);
    }

References GetId3\Lib\Helper\CastAsInt().

Referenced by GetId3\Module\Archive\Szip\analyze(), GetId3\Module\Audio\Aa\analyze(), GetId3\Module\Audio\Au\analyze(), GetId3\Module\Audio\Avr\analyze(), GetId3\Module\Audio\Lpac\analyze(), GetId3\Module\Audio\Midi\analyze(), GetId3\Module\Audio\Vqf\analyze(), GetId3\Module\AudioVideo\Flv\analyze(), GetId3\Module\AudioVideo\Mpeg\analyze(), GetId3\Module\AudioVideo\Quicktime\analyze(), GetId3\Module\AudioVideo\Real\analyze(), GetId3\Module\AudioVideo\Riff\analyze(), GetId3\Module\AudioVideo\Swf\analyze(), GetId3\Module\AudioVideo\Ts\analyze(), GetId3\Module\Graphic\Png\analyze(), GetId3\Module\Tag\Id3v2\analyze(), GetId3\Module\Audio\Mp3\decodeMPEGaudioHeader(), GetId3\Module\AudioVideo\Matroska\EBML2Int(), GetId3\Module\AudioVideo\Riff\EitherEndian2Int(), GetId3\Lib\Helper\FixedPoint16_16(), GetId3\Lib\Helper\FixedPoint8_8(), GetId3\Module\Audio\Aac\getAACADTSheaderFilepointer(), GetId3\Module\AudioVideo\AVCSequenceParameterSetReader\getBit(), GetId3\Module\AudioVideo\Matroska\HandleEMBLClusterBlock(), GetId3\Module\AudioVideo\Matroska\HandleEMBLSimpleTag(), GetId3\Lib\Helper\iconv_fallback_utf16be_iso88591(), GetId3\Lib\Helper\iconv_fallback_utf16be_utf8(), GetId3\Lib\Helper\LittleEndian2Int(), GetId3\Module\Audio\Mp3\MPEGaudioHeaderDecode(), GetId3\Lib\Helper\MultiByteCharString2HTML(), GetId3\Module\Audio\Flac\parseAPPLICATION(), GetId3\Module\Audio\Flac\parseCUESHEET(), GetId3\Module\AudioVideo\Matroska\parseEBML(), GetId3\Module\Tag\Id3v2\ParseID3v2Frame(), GetId3\Module\Audio\Flac\parseMETAdata(), GetId3\Module\Audio\Mpc\ParseMPCsv8(), GetId3\Module\AudioVideo\Real\ParseOldRAheader(), GetId3\Module\Audio\Flac\parsePICTURE(), GetId3\Module\Audio\Flac\parseSEEKTABLE(), GetId3\Module\Audio\Flac\parseSTREAMINFO(), GetId3\Module\AudioVideo\Quicktime\QuicktimeParseAtom(), GetId3\Module\AudioVideo\Quicktime\QuicktimeParseContainerAtom(), GetId3\Module\AudioVideo\Quicktime\QuicktimeParseNikonNCTG(), GetId3\Module\AudioVideo\AMFStream\readByte(), and GetId3\Module\Graphic\Tiff\TIFFendian2Int().

Here is the call graph for this function:

Here is the caller graph for this function:

BigEndian2String()

static GetId3\Lib\Helper::BigEndian2String (   $number,   $minbytes = 1,   $synchsafe = false,   $signed = false  )

static

Parameters

type	$number
type	$minbytes
type	$synchsafe
type	$signed

Returns

type

Exceptions

Exception

Definition at line 444 of file Helper.php.

    {
        if ($number < 0) {
            throw new DefaultException('ERROR: self::BigEndian2String() does not support negative numbers');
        }
        $maskbyte = (($synchsafe || $signed) ? 0x7F : 0xFF);
        $intstring = '';
        if ($signed) {
            if ($minbytes > PHP_INT_SIZE) {
                throw new DefaultException('ERROR: Cannot have signed integers larger than ' . (8 * PHP_INT_SIZE) . '-bits in self::BigEndian2String()');
            }
            $number = $number & (0x80 << (8 * ($minbytes - 1)));
        }
        while ($number != 0) {
            $quotient = ($number / ($maskbyte + 1));
            $intstring = chr(ceil(($quotient - floor($quotient)) * $maskbyte)) . $intstring;
            $number = floor($quotient);
        }
 
        return str_pad($intstring, $minbytes, "\x00", STR_PAD_LEFT);
    }

Referenced by GetId3\Lib\Helper\Float2String(), GetId3\Write\Real\GenerateCONTchunk(), GetId3\Write\Id3v2\GenerateID3v2FrameData(), GetId3\Write\Id3v2\GenerateID3v2Tag(), GetId3\Write\Real\GeneratePROPchunk(), and GetId3\Write\Real\GenerateRMFchunk().

Here is the caller graph for this function:

Bin2Dec()

static GetId3\Lib\Helper::Bin2Dec (   $binstring,   $signed = false  )

static

Parameters

type	$binstring
type	$signed

Returns

type

Definition at line 496 of file Helper.php.

    {
        $signmult = 1;
        if ($signed) {
            if ($binstring{0} == '1') {
                $signmult = -1;
            }
            $binstring = substr($binstring, 1);
        }
        $decvalue = 0;
        for ($i = 0; $i < strlen($binstring); $i++) {
            $decvalue += ((int) substr($binstring, strlen($binstring) - $i - 1,
                                                          1)) * pow(2, $i);
        }
 
        return self::CastAsInt($decvalue * $signmult);
    }

References GetId3\Lib\Helper\CastAsInt().

Referenced by GetId3\Module\AudioVideo\Mpeg\analyze(), GetId3\Module\AudioVideo\Riff\analyze(), GetId3\Module\AudioVideo\Swf\analyze(), GetId3\Lib\Helper\BigEndian2Float(), GetId3\Lib\Helper\DecimalBinary2Float(), GetId3\Lib\Helper\FixedPoint2_30(), GetId3\Module\Audio\Aac\getAACADIFheaderFilepointer(), GetId3\Module\Tag\Id3v2\ParseID3v2Frame(), and GetId3\Module\Audio\Flac\parseSTREAMINFO().

Here is the call graph for this function:

Here is the caller graph for this function:

Bin2String()

static GetId3\Lib\Helper::Bin2String (   $binstring )

static

Parameters

type

$binstring

Returns

string

Definition at line 519 of file Helper.php.

    {
        // return 'hi' for input of '0110100001101001'
        $string = '';
        $binstringreversed = strrev($binstring);
        for ($i = 0; $i < strlen($binstringreversed); $i += 8) {
            $string = chr(self::Bin2Dec(strrev(substr($binstringreversed, $i, 8)))) . $string;
        }
 
        return $string;
    }

Referenced by GetId3\Module\Audio\Aac\getAACADIFheaderFilepointer().

Here is the caller graph for this function:

CastAsInt()

static GetId3\Lib\Helper::CastAsInt (   $floatnum )

static

Parameters

type

$floatnum

Returns

type

Definition at line 107 of file Helper.php.

    {
        // convert to float if not already
        $floatnum = (float) $floatnum;
 
        // convert a float to type int, only if possible
        if (self::trunc($floatnum) == $floatnum) {
            // it's not floating point
            if (self::intValueSupported($floatnum)) {
                // it's within int range
                $floatnum = (int) $floatnum;
            }
        }
 
        return $floatnum;
    }

Referenced by GetId3\Module\Audio\Voc\analyze(), GetId3\Module\AudioVideo\Flv\analyze(), GetId3\Module\AudioVideo\Riff\analyze(), GetId3\Module\Tag\Id3v2\analyze(), GetId3\Lib\Helper\BigEndian2Int(), GetId3\Lib\Helper\Bin2Dec(), GetId3\Module\Graphic\Jpg\CastAsAppropriate(), GetId3\Lib\Helper\DateMac2Unix(), GetId3\Module\Audio\Mp3\getOnlyMPEGaudioInfo(), and GetId3\Module\Audio\Mpc\ParseMPCsv7().

Here is the caller graph for this function:

CopyFileParts()

static GetId3\Lib\Helper::CopyFileParts (   $filename_source,   $filename_dest,   $offset,   $length  )

static

Parameters

type	$filename_source
type	$filename_dest
type	$offset
type	$length

Returns

boolean

Exceptions

Exception

Definition at line 938 of file Helper.php.

    {
        if (!self::intValueSupported($offset + $length)) {
            throw new DefaultException('cannot copy file portion, it extends beyond the ' . round(PHP_INT_MAX / 1073741824) . 'GB limit');
        }
        if (is_readable($filename_source) && is_file($filename_source) && ($fp_src = fopen($filename_source,
                                                                                           'rb'))) {
            if (($fp_dest = fopen($filename_dest, 'wb'))) {
                if (fseek($fp_src, $offset, SEEK_SET) == 0) {
                    $byteslefttowrite = $length;
                    while (($byteslefttowrite > 0) && ($buffer = fread($fp_src,
                                                                       min($byteslefttowrite,
                                                                           GetId3Core::FREAD_BUFFER_SIZE)))) {
                        $byteswritten = fwrite($fp_dest, $buffer,
                                               $byteslefttowrite);
                        $byteslefttowrite -= $byteswritten;
                    }
 
                    return true;
                } else {
                    throw new DefaultException('failed to seek to offset ' . $offset . ' in ' . $filename_source);
                }
                fclose($fp_dest);
            } else {
                throw new DefaultException('failed to create file for writing ' . $filename_dest);
            }
            fclose($fp_src);
        } else {
            throw new DefaultException('failed to open file for reading ' . $filename_source);
        }
 
        return false;
    }

References GetId3\GetId3Core\FREAD_BUFFER_SIZE.

Referenced by GetId3\Lib\Helper\hash_data().

Here is the caller graph for this function:

CopyTagsToComments()

static GetId3\Lib\Helper::CopyTagsToComments ( &  $ThisFileInfo )

static

Parameters

type

$ThisFileInfo

Returns

boolean

Definition at line 1679 of file Helper.php.

    {
 
        // Copy all entries from ['tags'] into common ['comments']
        if (!empty($ThisFileInfo['tags'])) {
            foreach ($ThisFileInfo['tags'] as $tagtype => $tagarray) {
                foreach ($tagarray as $tagname => $tagdata) {
                    foreach ($tagdata as $key => $value) {
                        if (!empty($value)) {
                            if (empty($ThisFileInfo['comments'][$tagname])) {
 
                                // fall through and append value
                            } elseif ($tagtype == 'id3v1') {
 
                                $newvaluelength = strlen(trim($value));
                                foreach ($ThisFileInfo['comments'][$tagname] as $existingkey => $existingvalue) {
                                    $oldvaluelength = strlen(trim($existingvalue));
                                    if (($newvaluelength <= $oldvaluelength) && (substr($existingvalue,
                                                                                        0,
                                                                                        $newvaluelength) == trim($value))) {
                                        // new value is identical but shorter-than (or equal-length to) one already in comments - skip
                                        break 2;
                                    }
                                }
                            } elseif (!is_array($value)) {
 
                                $newvaluelength = strlen(trim($value));
                                foreach ($ThisFileInfo['comments'][$tagname] as $existingkey => $existingvalue) {
                                    $oldvaluelength = strlen(trim($existingvalue));
                                    if (($newvaluelength > $oldvaluelength) && (substr(trim($value),
                                                                                            0,
                                                                                            strlen($existingvalue)) == $existingvalue)) {
                                        $ThisFileInfo['comments'][$tagname][$existingkey] = trim($value);
                                        break 2;
                                    }
                                }
                            }
                            if (is_array($value) || empty($ThisFileInfo['comments'][$tagname]) || !in_array(trim($value),
                                                                                                                 $ThisFileInfo['comments'][$tagname])) {
                                $value = (is_string($value) ? trim($value) : $value);
                                $ThisFileInfo['comments'][$tagname][] = $value;
                            }
                        }
                    }
                }
            }
 
            // Copy to ['comments_html']
            foreach ($ThisFileInfo['comments'] as $field => $values) {
                if ($field == 'picture') {
                    // 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 elsewhere
                    continue;
                }
                foreach ($values as $index => $value) {
                    if (is_array($value)) {
                        $ThisFileInfo['comments_html'][$field][$index] = $value;
                    } else {
                        $ThisFileInfo['comments_html'][$field][$index] = str_replace('&#0;',
                                                                                     '',
                                                                                     self::MultiByteCharString2HTML($value,
                                                                                                                    $ThisFileInfo['encoding']));
                    }
                }
            }
        }
 
        return true;
    }

CreateDeepArray()

static GetId3\Lib\Helper::CreateDeepArray (   $ArrayPath,   $Separator,   $Value  )

static

Parameters

type	$ArrayPath
type	$Separator
type	$Value

Returns

type

Definition at line 726 of file Helper.php.

    {
        // assigns $Value to a nested array path:
        //   $foo = self::CreateDeepArray('/path/to/my', '/', 'file.txt')
        // is the same as:
        //   $foo = array('path'=>array('to'=>'array('my'=>array('file.txt'))));
        // or
        //   $foo['path']['to']['my'] = 'file.txt';
        while ($ArrayPath && ($ArrayPath{0} == $Separator)) {
            $ArrayPath = substr($ArrayPath, 1);
        }
        if (($pos = strpos($ArrayPath, $Separator)) !== false) {
            $ReturnedArray[substr($ArrayPath, 0, $pos)] = self::CreateDeepArray(substr($ArrayPath,
                                                                                       $pos + 1),
                                                                                       $Separator,
                                                                                       $Value);
        } else {
            $ReturnedArray[$ArrayPath] = $Value;
        }
 
        return $ReturnedArray;
    }

References GetId3\Lib\Helper\CreateDeepArray().

Referenced by GetId3\Module\Archive\Gzip\analyze(), GetId3\Module\Archive\Rar\analyze(), GetId3\Module\Archive\Tar\analyze(), GetId3\Module\Archive\Zip\analyze(), GetId3\Lib\Helper\CreateDeepArray(), and GetId3\Module\Misc\Iso\ParseDirectoryRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

DateMac2Unix()

static GetId3\Lib\Helper::DateMac2Unix (   $macdate )

static

Parameters

type

$macdate

Returns

type

Definition at line 671 of file Helper.php.

    {
        // Macintosh timestamp: seconds since 00:00h January 1, 1904
        // UNIX timestamp:      seconds since 00:00h January 1, 1970
        return self::CastAsInt($macdate - 2082844800);
    }

References GetId3\Lib\Helper\CastAsInt().

Referenced by GetId3\Module\AudioVideo\Riff\analyze(), and GetId3\Module\AudioVideo\Quicktime\QuicktimeParseAtom().

Here is the call graph for this function:

Here is the caller graph for this function:

Dec2Bin()

static GetId3\Lib\Helper::Dec2Bin (   $number )

static

Parameters

type

$number

Returns

string

Definition at line 472 of file Helper.php.

    {
        while ($number >= 256) {
            $bytes[] = (($number / 256) - (floor($number / 256))) * 256;
            $number = floor($number / 256);
        }
        $bytes[] = $number;
        $binstring = '';
        for ($i = 0; $i < count($bytes); $i++) {
            $binstring = (($i == count($bytes) - 1) ? decbin($bytes[$i]) : str_pad(decbin($bytes[$i]),
                                                                                          8,
                                                                                          '0',
                                                                                          STR_PAD_LEFT)) . $binstring;
        }
 
        return $binstring;
    }

Referenced by GetId3\Module\AudioVideo\Riff\analyze(), GetId3\Write\Id3v2\GenerateID3v2FrameData(), and GetId3\Module\Tag\Id3v2\ParseID3v2Frame().

Here is the caller graph for this function:

DecimalBinary2Float()

static GetId3\Lib\Helper::DecimalBinary2Float (   $binarynumerator )

static

Parameters

type

$binarynumerator

Returns

type

Definition at line 165 of file Helper.php.

    {
        $numerator = self::Bin2Dec($binarynumerator);
        $denominator = self::Bin2Dec('1' . str_repeat('0',
                                                      strlen($binarynumerator)));
 
        return ($numerator / $denominator);
    }

References GetId3\Lib\Helper\Bin2Dec().

Referenced by GetId3\Lib\Helper\BigEndian2Float().

Here is the call graph for this function:

Here is the caller graph for this function:

DecimalizeFraction()

static GetId3\Lib\Helper::DecimalizeFraction (   $fraction )

static

Parameters

type

$fraction

Returns

type

Definition at line 153 of file Helper.php.

    {
        list($numerator, $denominator) = explode('/', $fraction);
 
        return $numerator / ($denominator ? $denominator : 1);
    }

Referenced by GetId3\Module\Graphic\Jpg\analyze(), and GetId3\Module\Graphic\Jpg\CastAsAppropriate().

Here is the caller graph for this function:

EmbeddedLookup()

static GetId3\Lib\Helper::EmbeddedLookup (   $key,   $begin,   $end,   $file,   $name  )

static

@staticvar type $cache

Parameters

type	$key
type	$begin
type	$end
type	$file
type	$name

Returns

type

Definition at line 1759 of file Helper.php.

    {
 
        // Cached
        static $cache;
        if (isset($cache[$file][$name])) {
            return (isset($cache[$file][$name][$key]) ? $cache[$file][$name][$key] : '');
        }
 
        // Init
        $keylength = strlen($key);
        $line_count = $end - $begin - 7;
 
        // Open php file
        $fp = fopen($file, 'r');
 
        // Discard $begin lines
        for ($i = 0; $i < ($begin + 3); $i++) {
            fgets($fp, 1024);
        }
 
        // Loop thru line
        while (0 < $line_count--) {
 
            // Read line
            $line = ltrim(fgets($fp, 1024), "\t ");
 
            // METHOD A: only cache the matching key - less memory but slower on next lookup of not-previously-looked-up key
            //$keycheck = substr($line, 0, $keylength);
            //if ($key == $keycheck) {
            //  $cache[$file][$name][$keycheck] = substr($line, $keylength + 1);
            //  break;
            //}
            // 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] : '');
            $ThisValue = (isset($explodedLine[1]) ? $explodedLine[1] : '');
            $cache[$file][$name][$ThisKey] = trim($ThisValue);
        }
 
        // Close and return
        fclose($fp);
 
        return (isset($cache[$file][$name][$key]) ? $cache[$file][$name][$key] : '');
    }

References $file.

Referenced by GetId3\Module\Tag\Id3v2\FrameNameLongLookup(), GetId3\Module\Tag\Id3v2\FrameNameShortLookup(), GetId3\Module\Audio\Midi\GeneralMIDIinstrumentLookup(), GetId3\Module\Audio\Midi\GeneralMIDIpercussionLookup(), GetId3\Module\Tag\Id3v2\LanguageLookup(), GetId3\Module\Tag\Id3v2\LookupCurrencyCountry(), GetId3\Module\Tag\Id3v2\LookupCurrencyUnits(), GetId3\Module\AudioVideo\Riff\RIFFfourccLookup(), GetId3\Module\AudioVideo\Riff\RIFFwaveSNDMtagLookup(), and GetId3\Module\AudioVideo\Riff\RIFFwFormatTagLookup().

Here is the caller graph for this function:

fileextension()

static GetId3\Lib\Helper::fileextension (   $filename,   $numextensions = 1  )

static

Parameters

type	$filename
type	$numextensions

Returns

string

Definition at line 628 of file Helper.php.

    {
        if (strstr($filename, '.')) {
            $reversedfilename = strrev($filename);
            $offset = 0;
            for ($i = 0; $i < $numextensions; $i++) {
                $offset = strpos($reversedfilename, '.', $offset + 1);
                if ($offset === false) {
                    return '';
                }
            }
 
            return strrev(substr($reversedfilename, 0, $offset));
        }
 
        return '';
    }

References $filename.

Referenced by GetId3\Module\Audio\Optimfrog\ParseOptimFROGheader45().

Here is the caller graph for this function:

FixedPoint16_16()

static GetId3\Lib\Helper::FixedPoint16_16 (   $rawdata )

static

Parameters

type

$rawdata

Returns

type

Definition at line 696 of file Helper.php.

    {
        return self::BigEndian2Int(substr($rawdata, 0, 2)) + (float) (self::BigEndian2Int(substr($rawdata,
                                                                                                 2,
                                                                                                 2)) / pow(2,
                                                                                                           16));
    }

References GetId3\Lib\Helper\BigEndian2Int().

Referenced by GetId3\Module\AudioVideo\Riff\analyze(), and GetId3\Module\AudioVideo\Quicktime\QuicktimeParseAtom().

Here is the call graph for this function:

Here is the caller graph for this function:

FixedPoint2_30()

static GetId3\Lib\Helper::FixedPoint2_30 (   $rawdata )

static

Parameters

type

$rawdata

Returns

type

Definition at line 709 of file Helper.php.

    {
        $binarystring = self::BigEndian2Bin($rawdata);
 
        return self::Bin2Dec(substr($binarystring, 0, 2)) + (float) (self::Bin2Dec(substr($binarystring,
                                                                                          2,
                                                                                          30)) / pow(2,
                                                                                                     30));
    }

References GetId3\Lib\Helper\BigEndian2Bin(), and GetId3\Lib\Helper\Bin2Dec().

Referenced by GetId3\Module\Graphic\Bmp\analyze(), and GetId3\Module\AudioVideo\Quicktime\QuicktimeParseAtom().

Here is the call graph for this function:

Here is the caller graph for this function:

FixedPoint8_8()

static GetId3\Lib\Helper::FixedPoint8_8 (   $rawdata )

static

Parameters

type

$rawdata

Returns

type

Definition at line 683 of file Helper.php.

    {
        return self::BigEndian2Int(substr($rawdata, 0, 1)) + (float) (self::BigEndian2Int(substr($rawdata,
                                                                                                 1,
                                                                                                 1)) / pow(2,
                                                                                                           8));
    }

References GetId3\Lib\Helper\BigEndian2Int().

Referenced by GetId3\Module\AudioVideo\Quicktime\QuicktimeParseAtom().

Here is the call graph for this function:

Here is the caller graph for this function:

Float2BinaryDecimal()

static GetId3\Lib\Helper::Float2BinaryDecimal (   $floatvalue )

static

Parameters

type

$floatvalue

Returns

string

Definition at line 214 of file Helper.php.

    {
        // http://www.scri.fsu.edu/~jac/MAD3401/Backgrnd/binary.html
        $maxbits = 128; // to how many bits of precision should the calculations be taken?
        $intpart = self::trunc($floatvalue);
        $floatpart = abs($floatvalue - $intpart);
        $pointbitstring = '';
        while (($floatpart != 0) && (strlen($pointbitstring) < $maxbits)) {
            $floatpart *= 2;
            $pointbitstring .= (string) self::trunc($floatpart);
            $floatpart -= self::trunc($floatpart);
        }
        $binarypointnumber = decbin($intpart) . '.' . $pointbitstring;
 
        return $binarypointnumber;
    }

References GetId3\Lib\Helper\trunc().

Here is the call graph for this function:

Float2String()

static GetId3\Lib\Helper::Float2String (   $floatvalue,   $bits  )

static

Parameters

type	$floatvalue
type	$bits

Returns

boolean

Definition at line 237 of file Helper.php.

    {
        // http://www.scri.fsu.edu/~jac/MAD3401/Backgrnd/ieee-expl.html
        switch ($bits) {
            case 32:
                $exponentbits = 8;
                $fractionbits = 23;
                break;
 
            case 64:
                $exponentbits = 11;
                $fractionbits = 52;
                break;
 
            default:
                return false;
                break;
        }
        if ($floatvalue >= 0) {
            $signbit = '0';
        } else {
            $signbit = '1';
        }
        $normalizedbinary = self::NormalizeBinaryPoint(self::Float2BinaryDecimal($floatvalue),
                                                                                 $fractionbits);
        $biasedexponent = pow(2, $exponentbits - 1) - 1 + $normalizedbinary['exponent']; // (127 or 1023) +/- exponent
        $exponentbitstring = str_pad(decbin($biasedexponent), $exponentbits,
                                            '0', STR_PAD_LEFT);
        $fractionbitstring = str_pad(substr($normalizedbinary['normalized'], 2),
                                            $fractionbits, '0', STR_PAD_RIGHT);
 
        return self::BigEndian2String(self::Bin2Dec($signbit . $exponentbitstring . $fractionbitstring),
                                                    $bits % 8, false);
    }

References GetId3\Lib\Helper\BigEndian2String(), and GetId3\Lib\Helper\NormalizeBinaryPoint().

Referenced by GetId3\Write\Id3v2\GenerateID3v2FrameData().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDataImageSize()

static GetId3\Lib\Helper::GetDataImageSize (   $imgData, &  $imageinfo  )

static

@staticvar string $tempdir

Parameters

type	$imgData
type	$imageinfo

Returns

type

Definition at line 1622 of file Helper.php.

    {
        static $tempdir = '';
        if (empty($tempdir)) {
            // yes this is ugly, feel free to suggest a better way
            $getid3_temp = new GetId3Core();
            $tempdir = $getid3_temp->tempdir;
            unset($getid3_temp);
        }
        $GetDataImageSize = false;
        if ($tempfilename = tempnam($tempdir, 'gI3')) {
            if (is_writable($tempfilename) && is_file($tempfilename) && ($tmp = fopen($tempfilename,
                                                                                      'wb'))) {
                fwrite($tmp, $imgData);
                fclose($tmp);
                $GetDataImageSize = @GetImageSize($tempfilename, $imageinfo);
            }
            unlink($tempfilename);
        }
 
        return $GetDataImageSize;
    }

Referenced by GetId3\Module\Graphic\Jpg\analyze(), GetId3\Module\Tag\Apetag\analyze(), GetId3\Module\AudioVideo\Asf\ASF_WMpicture(), GetId3\Module\Tag\Id3v2\ParseID3v2Frame(), and GetId3\Module\Audio\Ogg\ParseVorbisComments().

Here is the caller graph for this function:

hash_data()

static GetId3\Lib\Helper::hash_data (   $file,   $offset,   $end,   $algorithm  )

static

self::md5_data() - returns md5sum for a file from startuing position to absolute end position

@staticvar string $tempdir

Parameters

type	$file
type	$offset
type	$end
type	$algorithm

Returns

boolean

Exceptions

Exception

Author

Allan Hansen <ahØartemis*dk>

Definition at line 841 of file Helper.php.

    {
        static $tempdir = '';
        if (!self::intValueSupported($end)) {
            return false;
        }
        switch ($algorithm) {
            case 'md5':
                $hash_function = 'md5_file';
                $unix_call = 'md5sum';
                $windows_call = 'md5sum.exe';
                $hash_length = 32;
                break;
 
            case 'sha1':
                $hash_function = 'sha1_file';
                $unix_call = 'sha1sum';
                $windows_call = 'sha1sum.exe';
                $hash_length = 40;
                break;
 
            default:
                throw new DefaultException('Invalid algorithm (' . $algorithm . ') in self::hash_data()');
                break;
        }
        $size = $end - $offset;
        while (true) {
            if (GetId3Core::environmentIsWindows()) {
 
                // It seems that sha1sum.exe for Windows only works on physical files, does not accept piped data
                // Fall back to create-temp-file method:
                if ($algorithm == 'sha1') {
                    break;
                }
 
                $RequiredFiles = array('cygwin1.dll', 'head.exe', 'tail.exe', $windows_call);
                foreach ($RequiredFiles as $required_file) {
                    if (!is_readable(GetId3Core::getHelperAppsDir() . $required_file)) {
                        // helper apps not available - fall back to old method
                        break 2;
                    }
                }
                $commandline = GetId3Core::getHelperAppsDir() . 'head.exe -c ' . $end . ' ' . escapeshellarg(str_replace('/',
                                                                                                                            DIRECTORY_SEPARATOR,
                                                                                                                            $file)) . ' | ';
                $commandline .= GetId3Core::getHelperAppsDir() . 'tail.exe -c ' . $size . ' | ';
                $commandline .= GetId3Core::getHelperAppsDir() . $windows_call;
            } else {
 
                $commandline = 'head -c' . $end . ' ' . escapeshellarg($file) . ' | ';
                $commandline .= 'tail -c' . $size . ' | ';
                $commandline .= $unix_call;
            }
            if (preg_match('#(1|ON)#i', ini_get('safe_mode'))) {
                //throw new DefaultException('PHP running in Safe Mode - backtick operator not available, using slower non-system-call '.$algorithm.' algorithm');
                break;
            }
 
            return substr(`$commandline`, 0, $hash_length);
        }
 
        if (empty($tempdir)) {
            // yes this is ugly, feel free to suggest a better way
            $getid3_temp = new GetId3Core();
            $tempdir = $getid3_temp->tempdir;
            unset($getid3_temp);
        }
        // try to create a temporary file in the system temp directory - invalid dirname should force to system temp dir
        if (($data_filename = tempnam($tempdir, 'gI3')) === false) {
            // can't find anywhere to create a temp file, just fail
            return false;
        }
 
        // Init
        $result = false;
 
        // copy parts of file
        try {
            self::CopyFileParts($file, $data_filename, $offset, $end - $offset);
            $result = $hash_function($data_filename);
        } catch (DefaultException $e) {
            throw new DefaultException('self::CopyFileParts() failed in getid_lib::hash_data(): ' . $e->getMessage());
        }
        unlink($data_filename);
 
        return $result;
    }

References $file, $result, $size, GetId3\Lib\Helper\CopyFileParts(), GetId3\GetId3Core\environmentIsWindows(), and GetId3\GetId3Core\getHelperAppsDir().

Here is the call graph for this function:

iconv_fallback()

static GetId3\Lib\Helper::iconv_fallback (   $in_charset,   $out_charset,   $string  )

static

@staticvar array $ConversionFunctionList

Parameters

type	$in_charset
type	$out_charset
type	$string

Returns

type

Exceptions

Exception

Definition at line 1375 of file Helper.php.

    {
 
        if ($in_charset == $out_charset) {
            return $string;
        }
 
        // iconv() availble
        if (function_exists('iconv')) {
            if ($converted_string = @iconv($in_charset,
                                           $out_charset . '//TRANSLIT', $string)) {
                switch ($out_charset) {
                    case 'ISO-8859-1':
                        $converted_string = rtrim($converted_string, "\x00");
                        break;
                }
 
                return $converted_string;
            }
 
            // iconv() may sometimes fail with "illegal character in input string" error message
            // and return an empty string, but returning the unconverted string is more useful
            return $string;
        }
 
 
        // iconv() not available
        static $ConversionFunctionList = array();
        if (empty($ConversionFunctionList)) {
            $ConversionFunctionList['ISO-8859-1']['UTF-8'] = 'iconv_fallback_iso88591_utf8';
            $ConversionFunctionList['ISO-8859-1']['UTF-16'] = 'iconv_fallback_iso88591_utf16';
            $ConversionFunctionList['ISO-8859-1']['UTF-16BE'] = 'iconv_fallback_iso88591_utf16be';
            $ConversionFunctionList['ISO-8859-1']['UTF-16LE'] = 'iconv_fallback_iso88591_utf16le';
            $ConversionFunctionList['UTF-8']['ISO-8859-1'] = 'iconv_fallback_utf8_iso88591';
            $ConversionFunctionList['UTF-8']['UTF-16'] = 'iconv_fallback_utf8_utf16';
            $ConversionFunctionList['UTF-8']['UTF-16BE'] = 'iconv_fallback_utf8_utf16be';
            $ConversionFunctionList['UTF-8']['UTF-16LE'] = 'iconv_fallback_utf8_utf16le';
            $ConversionFunctionList['UTF-16']['ISO-8859-1'] = 'iconv_fallback_utf16_iso88591';
            $ConversionFunctionList['UTF-16']['UTF-8'] = 'iconv_fallback_utf16_utf8';
            $ConversionFunctionList['UTF-16LE']['ISO-8859-1'] = 'iconv_fallback_utf16le_iso88591';
            $ConversionFunctionList['UTF-16LE']['UTF-8'] = 'iconv_fallback_utf16le_utf8';
            $ConversionFunctionList['UTF-16BE']['ISO-8859-1'] = 'iconv_fallback_utf16be_iso88591';
            $ConversionFunctionList['UTF-16BE']['UTF-8'] = 'iconv_fallback_utf16be_utf8';
        }
        if (isset($ConversionFunctionList[strtoupper($in_charset)][strtoupper($out_charset)])) {
            $ConversionFunction = $ConversionFunctionList[strtoupper($in_charset)][strtoupper($out_charset)];
 
            return self::$ConversionFunction($string);
        }
        throw new DefaultException('PHP does not have iconv() support - cannot convert from ' . $in_charset . ' to ' . $out_charset);
    }

Referenced by GetId3\Write\Tags\FormatDataForAPE(), GetId3\Write\Tags\FormatDataForID3v1(), GetId3\Write\Tags\FormatDataForID3v2(), GetId3\Write\Tags\FormatDataForReal(), GetId3\Write\Tags\FormatDataForVorbisComment(), GetId3\Module\Misc\Iso\ParseDirectoryRecord(), GetId3\Module\Tag\Id3v2\ParseID3v2Frame(), GetId3\Module\Misc\Iso\ParsePathTable(), GetId3\Module\AudioVideo\Asf\TrimConvert(), and GetId3\Module\AudioVideo\Asf\WMpictureTypeLookup().

Here is the caller graph for this function:

iconv_fallback_int_utf8()

static GetId3\Lib\Helper::iconv_fallback_int_utf8 (   $charval )

static

Parameters

type

$charval

Returns

type

Definition at line 978 of file Helper.php.

    {
        if ($charval < 128) {
            // 0bbbbbbb
            $newcharstring = chr($charval);
        } elseif ($charval < 2048) {
            // 110bbbbb 10bbbbbb
            $newcharstring = chr(($charval >> 6) | 0xC0);
            $newcharstring .= chr(($charval & 0x3F) | 0x80);
        } elseif ($charval < 65536) {
            // 1110bbbb 10bbbbbb 10bbbbbb
            $newcharstring = chr(($charval >> 12) | 0xE0);
            $newcharstring .= chr(($charval >> 6) | 0xC0);
            $newcharstring .= chr(($charval & 0x3F) | 0x80);
        } else {
            // 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb
            $newcharstring = chr(($charval >> 18) | 0xF0);
            $newcharstring .= chr(($charval >> 12) | 0xC0);
            $newcharstring .= chr(($charval >> 6) | 0xC0);
            $newcharstring .= chr(($charval & 0x3F) | 0x80);
        }
 
        return $newcharstring;
    }

Referenced by GetId3\Lib\Helper\iconv_fallback_iso88591_utf8(), GetId3\Lib\Helper\iconv_fallback_utf16be_utf8(), and GetId3\Lib\Helper\iconv_fallback_utf16le_utf8().

Here is the caller graph for this function:

iconv_fallback_iso88591_utf16()

static GetId3\Lib\Helper::iconv_fallback_iso88591_utf16 (   $string )

static

ISO-8859-1 => UTF-16LE (BOM)

Parameters

type

$string

Returns

type

Definition at line 1074 of file Helper.php.

    {
        return self::iconv_fallback_iso88591_utf16le($string, true);
    }

References GetId3\Lib\Helper\iconv_fallback_iso88591_utf16le().

Here is the call graph for this function:

iconv_fallback_iso88591_utf16be()

static GetId3\Lib\Helper::iconv_fallback_iso88591_utf16be (   $string,   $bom = false  )

static

ISO-8859-1 => UTF-16BE.

Parameters

type	$string
type	$bom

Returns

string

Definition at line 1035 of file Helper.php.

    {
        $newcharstring = '';
        if ($bom) {
            $newcharstring .= "\xFE\xFF";
        }
        for ($i = 0; $i < strlen($string); $i++) {
            $newcharstring .= "\x00" . $string{$i};
        }
 
        return $newcharstring;
    }

iconv_fallback_iso88591_utf16le()

static GetId3\Lib\Helper::iconv_fallback_iso88591_utf16le (   $string,   $bom = false  )

static

ISO-8859-1 => UTF-16LE.

Parameters

type	$string
type	$bom

Returns

string

Definition at line 1055 of file Helper.php.

    {
        $newcharstring = '';
        if ($bom) {
            $newcharstring .= "\xFF\xFE";
        }
        for ($i = 0; $i < strlen($string); $i++) {
            $newcharstring .= $string{$i} . "\x00";
        }
 
        return $newcharstring;
    }

Referenced by GetId3\Lib\Helper\iconv_fallback_iso88591_utf16().

Here is the caller graph for this function:

iconv_fallback_iso88591_utf8()

static GetId3\Lib\Helper::iconv_fallback_iso88591_utf8 (   $string,   $bom = false  )

static

ISO-8859-1 => UTF-8.

Parameters

type	$string
type	$bom

Returns

type

Definition at line 1010 of file Helper.php.

    {
        if (function_exists('utf8_encode')) {
            return utf8_encode($string);
        }
        // utf8_encode() unavailable, use GetId3Core()'s iconv_fallback() conversions (possibly PHP is compiled without XML support)
        $newcharstring = '';
        if ($bom) {
            $newcharstring .= "\xEF\xBB\xBF";
        }
        for ($i = 0; $i < strlen($string); $i++) {
            $charval = ord($string{$i});
            $newcharstring .= self::iconv_fallback_int_utf8($charval);
        }
 
        return $newcharstring;
    }

References GetId3\Lib\Helper\iconv_fallback_int_utf8().

Here is the call graph for this function:

iconv_fallback_utf16_iso88591()

static GetId3\Lib\Helper::iconv_fallback_utf16_iso88591 (   $string )

static

UTF-16 (BOM) => ISO-8859-1.

Parameters

type

$string

Returns

type

Definition at line 1336 of file Helper.php.

    {
        $bom = substr($string, 0, 2);
        if ($bom == "\xFE\xFF") {
            return self::iconv_fallback_utf16be_iso88591(substr($string, 2));
        } elseif ($bom == "\xFF\xFE") {
            return self::iconv_fallback_utf16le_iso88591(substr($string, 2));
        }
 
        return $string;
    }

References GetId3\Lib\Helper\iconv_fallback_utf16be_iso88591(), and GetId3\Lib\Helper\iconv_fallback_utf16le_iso88591().

Here is the call graph for this function:

iconv_fallback_utf16_utf8()

static GetId3\Lib\Helper::iconv_fallback_utf16_utf8 (   $string )

static

UTF-16 (BOM) => UTF-8.

Parameters

type

$string

Returns

type

Definition at line 1354 of file Helper.php.

    {
        $bom = substr($string, 0, 2);
        if ($bom == "\xFE\xFF") {
            return self::iconv_fallback_utf16be_utf8(substr($string, 2));
        } elseif ($bom == "\xFF\xFE") {
            return self::iconv_fallback_utf16le_utf8(substr($string, 2));
        }
 
        return $string;
    }

References GetId3\Lib\Helper\iconv_fallback_utf16be_utf8(), and GetId3\Lib\Helper\iconv_fallback_utf16le_utf8().

Here is the call graph for this function:

iconv_fallback_utf16be_iso88591()

static GetId3\Lib\Helper::iconv_fallback_utf16be_iso88591 (   $string )

static

UTF-16BE => ISO-8859-1.

Parameters

type

$string

Returns

type

Definition at line 1294 of file Helper.php.

    {
        if (substr($string, 0, 2) == "\xFE\xFF") {
            // strip BOM
            $string = substr($string, 2);
        }
        $newcharstring = '';
        for ($i = 0; $i < strlen($string); $i += 2) {
            $charval = self::BigEndian2Int(substr($string, $i, 2));
            $newcharstring .= (($charval < 256) ? chr($charval) : '?');
        }
 
        return $newcharstring;
    }

References GetId3\Lib\Helper\BigEndian2Int().

Referenced by GetId3\Lib\Helper\iconv_fallback_utf16_iso88591().

Here is the call graph for this function:

Here is the caller graph for this function:

iconv_fallback_utf16be_utf8()

static GetId3\Lib\Helper::iconv_fallback_utf16be_utf8 (   $string )

static

UTF-16BE => UTF-8.

Parameters

type

$string

Returns

type

Definition at line 1252 of file Helper.php.

    {
        if (substr($string, 0, 2) == "\xFE\xFF") {
            // strip BOM
            $string = substr($string, 2);
        }
        $newcharstring = '';
        for ($i = 0; $i < strlen($string); $i += 2) {
            $charval = self::BigEndian2Int(substr($string, $i, 2));
            $newcharstring .= self::iconv_fallback_int_utf8($charval);
        }
 
        return $newcharstring;
    }

References GetId3\Lib\Helper\BigEndian2Int(), and GetId3\Lib\Helper\iconv_fallback_int_utf8().

Referenced by GetId3\Lib\Helper\iconv_fallback_utf16_utf8().

Here is the call graph for this function:

Here is the caller graph for this function:

iconv_fallback_utf16le_iso88591()

static GetId3\Lib\Helper::iconv_fallback_utf16le_iso88591 (   $string )

static

UTF-16LE => ISO-8859-1.

Parameters

type

$string

Returns

type

Definition at line 1315 of file Helper.php.

    {
        if (substr($string, 0, 2) == "\xFF\xFE") {
            // strip BOM
            $string = substr($string, 2);
        }
        $newcharstring = '';
        for ($i = 0; $i < strlen($string); $i += 2) {
            $charval = self::LittleEndian2Int(substr($string, $i, 2));
            $newcharstring .= (($charval < 256) ? chr($charval) : '?');
        }
 
        return $newcharstring;
    }

References GetId3\Lib\Helper\LittleEndian2Int().

Referenced by GetId3\Lib\Helper\iconv_fallback_utf16_iso88591().

Here is the call graph for this function:

Here is the caller graph for this function:

iconv_fallback_utf16le_utf8()

static GetId3\Lib\Helper::iconv_fallback_utf16le_utf8 (   $string )

static

UTF-16LE => UTF-8.

Parameters

type

$string

Returns

type

Definition at line 1273 of file Helper.php.

    {
        if (substr($string, 0, 2) == "\xFF\xFE") {
            // strip BOM
            $string = substr($string, 2);
        }
        $newcharstring = '';
        for ($i = 0; $i < strlen($string); $i += 2) {
            $charval = self::LittleEndian2Int(substr($string, $i, 2));
            $newcharstring .= self::iconv_fallback_int_utf8($charval);
        }
 
        return $newcharstring;
    }

References GetId3\Lib\Helper\iconv_fallback_int_utf8(), and GetId3\Lib\Helper\LittleEndian2Int().

Referenced by GetId3\Lib\Helper\iconv_fallback_utf16_utf8().

Here is the call graph for this function:

Here is the caller graph for this function:

iconv_fallback_utf8_iso88591()

static GetId3\Lib\Helper::iconv_fallback_utf8_iso88591 (   $string )

static

UTF-8 => ISO-8859-1.

Parameters

type

$string

Returns

type

Definition at line 1085 of file Helper.php.

    {
        if (function_exists('utf8_decode')) {
            return utf8_decode($string);
        }
        // utf8_decode() unavailable, use GetId3Core()'s iconv_fallback() conversions (possibly PHP is compiled without XML support)
        $newcharstring = '';
        $offset = 0;
        $stringlength = strlen($string);
        while ($offset < $stringlength) {
            if ((ord($string{$offset}) | 0x07) == 0xF7) {
                // 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb
                $charval = ((ord($string{($offset + 0)}) & 0x07) << 18) &
                    ((ord($string{($offset + 1)}) & 0x3F) << 12) &
                    ((ord($string{($offset + 2)}) & 0x3F) << 6) &
                    (ord($string{($offset + 3)}) & 0x3F);
                $offset += 4;
            } elseif ((ord($string{$offset}) | 0x0F) == 0xEF) {
                // 1110bbbb 10bbbbbb 10bbbbbb
                $charval = ((ord($string{($offset + 0)}) & 0x0F) << 12) &
                    ((ord($string{($offset + 1)}) & 0x3F) << 6) &
                    (ord($string{($offset + 2)}) & 0x3F);
                $offset += 3;
            } elseif ((ord($string{$offset}) | 0x1F) == 0xDF) {
                // 110bbbbb 10bbbbbb
                $charval = ((ord($string{($offset + 0)}) & 0x1F) << 6) &
                    (ord($string{($offset + 1)}) & 0x3F);
                $offset += 2;
            } elseif ((ord($string{$offset}) | 0x7F) == 0x7F) {
                // 0bbbbbbb
                $charval = ord($string{$offset});
                $offset += 1;
            } else {
                // error? throw some kind of warning here?
                $charval = false;
                $offset += 1;
            }
            if ($charval !== false) {
                $newcharstring .= (($charval < 256) ? chr($charval) : '?');
            }
        }
 
        return $newcharstring;
    }

iconv_fallback_utf8_utf16()

static GetId3\Lib\Helper::iconv_fallback_utf8_utf16 (   $string )

static

UTF-8 => UTF-16LE (BOM)

Parameters

type

$string

Returns

type

Definition at line 1241 of file Helper.php.

    {
        return self::iconv_fallback_utf8_utf16le($string, true);
    }

References GetId3\Lib\Helper\iconv_fallback_utf8_utf16le().

Here is the call graph for this function:

iconv_fallback_utf8_utf16be()

static GetId3\Lib\Helper::iconv_fallback_utf8_utf16be (   $string,   $bom = false  )

static

UTF-8 => UTF-16BE.

Parameters

type	$string
type	$bom

Returns

type

Definition at line 1138 of file Helper.php.

    {
        $newcharstring = '';
        if ($bom) {
            $newcharstring .= "\xFE\xFF";
        }
        $offset = 0;
        $stringlength = strlen($string);
        while ($offset < $stringlength) {
            if ((ord($string{$offset}) | 0x07) == 0xF7) {
                // 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb
                $charval = ((ord($string{($offset + 0)}) & 0x07) << 18) &
                    ((ord($string{($offset + 1)}) & 0x3F) << 12) &
                    ((ord($string{($offset + 2)}) & 0x3F) << 6) &
                    (ord($string{($offset + 3)}) & 0x3F);
                $offset += 4;
            } elseif ((ord($string{$offset}) | 0x0F) == 0xEF) {
                // 1110bbbb 10bbbbbb 10bbbbbb
                $charval = ((ord($string{($offset + 0)}) & 0x0F) << 12) &
                    ((ord($string{($offset + 1)}) & 0x3F) << 6) &
                    (ord($string{($offset + 2)}) & 0x3F);
                $offset += 3;
            } elseif ((ord($string{$offset}) | 0x1F) == 0xDF) {
                // 110bbbbb 10bbbbbb
                $charval = ((ord($string{($offset + 0)}) & 0x1F) << 6) &
                    (ord($string{($offset + 1)}) & 0x3F);
                $offset += 2;
            } elseif ((ord($string{$offset}) | 0x7F) == 0x7F) {
                // 0bbbbbbb
                $charval = ord($string{$offset});
                $offset += 1;
            } else {
                // error? throw some kind of warning here?
                $charval = false;
                $offset += 1;
            }
            if ($charval !== false) {
                $newcharstring .= (($charval < 65536) ? self::BigEndian2String($charval,
                                                                               2) : "\x00" . '?');
            }
        }
 
        return $newcharstring;
    }

iconv_fallback_utf8_utf16le()

static GetId3\Lib\Helper::iconv_fallback_utf8_utf16le (   $string,   $bom = false  )

static

UTF-8 => UTF-16LE.

Parameters

type	$string
type	$bom

Returns

type

Definition at line 1190 of file Helper.php.

    {
        $newcharstring = '';
        if ($bom) {
            $newcharstring .= "\xFF\xFE";
        }
        $offset = 0;
        $stringlength = strlen($string);
        while ($offset < $stringlength) {
            if ((ord($string{$offset}) | 0x07) == 0xF7) {
                // 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb
                $charval = ((ord($string{($offset + 0)}) & 0x07) << 18) &
                    ((ord($string{($offset + 1)}) & 0x3F) << 12) &
                    ((ord($string{($offset + 2)}) & 0x3F) << 6) &
                    (ord($string{($offset + 3)}) & 0x3F);
                $offset += 4;
            } elseif ((ord($string{$offset}) | 0x0F) == 0xEF) {
                // 1110bbbb 10bbbbbb 10bbbbbb
                $charval = ((ord($string{($offset + 0)}) & 0x0F) << 12) &
                    ((ord($string{($offset + 1)}) & 0x3F) << 6) &
                    (ord($string{($offset + 2)}) & 0x3F);
                $offset += 3;
            } elseif ((ord($string{$offset}) | 0x1F) == 0xDF) {
                // 110bbbbb 10bbbbbb
                $charval = ((ord($string{($offset + 0)}) & 0x1F) << 6) &
                    (ord($string{($offset + 1)}) & 0x3F);
                $offset += 2;
            } elseif ((ord($string{$offset}) | 0x7F) == 0x7F) {
                // 0bbbbbbb
                $charval = ord($string{$offset});
                $offset += 1;
            } else {
                // error? maybe throw some warning here?
                $charval = false;
                $offset += 1;
            }
            if ($charval !== false) {
                $newcharstring .= (($charval < 65536) ? self::LittleEndian2String($charval,
                                                                                  2) : '?' . "\x00");
            }
        }
 
        return $newcharstring;
    }

Referenced by GetId3\Lib\Helper\iconv_fallback_utf8_utf16().

Here is the caller graph for this function:

ImageTypesLookup()

static GetId3\Lib\Helper::ImageTypesLookup (   $imagetypeid )

static

@staticvar array $ImageTypesLookup

Parameters

type

$imagetypeid

Returns

type

Definition at line 1651 of file Helper.php.

    {
        static $ImageTypesLookup = array();
        if (empty($ImageTypesLookup)) {
            $ImageTypesLookup[1] = 'gif';
            $ImageTypesLookup[2] = 'jpeg';
            $ImageTypesLookup[3] = 'png';
            $ImageTypesLookup[4] = 'swf';
            $ImageTypesLookup[5] = 'psd';
            $ImageTypesLookup[6] = 'bmp';
            $ImageTypesLookup[7] = 'tiff (little-endian)';
            $ImageTypesLookup[8] = 'tiff (big-endian)';
            $ImageTypesLookup[9] = 'jpc';
            $ImageTypesLookup[10] = 'jp2';
            $ImageTypesLookup[11] = 'jpx';
            $ImageTypesLookup[12] = 'jb2';
            $ImageTypesLookup[13] = 'swc';
            $ImageTypesLookup[14] = 'iff';
        }
 
        return (isset($ImageTypesLookup[$imagetypeid]) ? $ImageTypesLookup[$imagetypeid] : '');
    }

intValueSupported()

static GetId3\Lib\Helper::intValueSupported (   $num )

static

@staticvar null $hasINT64

Parameters

type

$num

Returns

boolean

Definition at line 130 of file Helper.php.

    {
        // check if integers are 64-bit
        static $hasINT64 = null;
        if ($hasINT64 === null) { // 10x faster than is_null()
            $hasINT64 = is_int(pow(2, 31)); // 32-bit int are limited to (2^31)-1
            if (!$hasINT64 && !defined('PHP_INT_MIN')) {
                define('PHP_INT_MIN', ~PHP_INT_MAX);
            }
        }
        // if integers are 64-bit - no other check required
        if ($hasINT64 || (($num <= PHP_INT_MAX) && ($num >= PHP_INT_MIN))) {
            return true;
        }
 
        return false;
    }

References defined.

Referenced by GetId3\Module\Archive\Zip\analyze(), GetId3\Module\Audio\Bonk\analyze(), GetId3\Module\Audio\Ogg\analyze(), GetId3\Module\AudioVideo\Quicktime\analyze(), GetId3\Module\AudioVideo\Riff\analyze(), GetId3\Module\Tag\Apetag\analyze(), GetId3\Module\Tag\Id3v1\analyze(), GetId3\Module\Tag\Lyrics3\analyze(), GetId3\Module\AudioVideo\Matroska\EnsureBufferHasEnoughData(), GetId3\Module\Audio\Aac\getAACADTSheaderFilepointer(), GetId3\Module\Tag\Lyrics3\getLyrics3Data(), GetId3\Module\AudioVideo\Riff\ParseRIFF(), GetId3\Write\Id3v1\RemoveID3v1(), GetId3\Write\Id3v2\RemoveID3v2(), GetId3\Handler\BaseHandler\saveAttachment(), GetId3\Write\Id3v1\WriteID3v1(), and GetId3\Write\Id3v2\WriteID3v2().

Here is the caller graph for this function:

ksort_recursive()

static GetId3\Lib\Helper::ksort_recursive ( &  $theArray )

static

Parameters

type

$theArray

Returns

boolean

Definition at line 610 of file Helper.php.

    {
        ksort($theArray);
        foreach ($theArray as $key => $value) {
            if (is_array($value)) {
                self::ksort_recursive($theArray[$key]);
            }
        }
 
        return true;
    }

References GetId3\Lib\Helper\ksort_recursive().

Referenced by GetId3\Lib\Helper\ksort_recursive().

Here is the call graph for this function:

Here is the caller graph for this function:

LittleEndian2Float()

static GetId3\Lib\Helper::LittleEndian2Float (   $byteword )

static

Parameters

type

$byteword

Returns

type

Definition at line 277 of file Helper.php.

    {
        return self::BigEndian2Float(strrev($byteword));
    }

References GetId3\Lib\Helper\BigEndian2Float().

Referenced by GetId3\Module\AudioVideo\Riff\analyze(), and GetId3\Module\Audio\Mp3\decodeMPEGaudioHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

LittleEndian2Int()

static GetId3\Lib\Helper::LittleEndian2Int (   $byteword,   $signed = false  )

static

Parameters

type	$byteword
type	$signed

Returns

type

Definition at line 413 of file Helper.php.

    {
        return self::BigEndian2Int(strrev($byteword), false, $signed);
    }

References GetId3\Lib\Helper\BigEndian2Int().

Referenced by GetId3\Module\Archive\Gzip\analyze(), GetId3\Module\Audio\Ac3\analyze(), GetId3\Module\Audio\Bonk\analyze(), GetId3\Module\Audio\La\analyze(), GetId3\Module\Audio\Monkey\analyze(), GetId3\Module\Audio\Ogg\analyze(), GetId3\Module\Audio\Rkau\analyze(), GetId3\Module\Audio\Shorten\analyze(), GetId3\Module\Audio\Tta\analyze(), GetId3\Module\Audio\Voc\analyze(), GetId3\Module\Audio\Wavpack\analyze(), GetId3\Module\AudioVideo\Asf\analyze(), GetId3\Module\AudioVideo\Flv\analyze(), GetId3\Module\AudioVideo\Riff\analyze(), GetId3\Module\AudioVideo\Swf\analyze(), GetId3\Module\Graphic\Bmp\analyze(), GetId3\Module\Graphic\Efax\analyze(), GetId3\Module\Graphic\Gif\analyze(), GetId3\Module\Misc\Exe\analyze(), GetId3\Module\Tag\Apetag\analyze(), GetId3\Module\AudioVideo\Asf\ASF_HeaderExtensionObjectDataParse(), GetId3\Module\AudioVideo\Asf\ASF_WMpicture(), GetId3\Module\AudioVideo\Riff\EitherEndian2Int(), GetId3\Module\AudioVideo\Nsv\getNSVfHeaderFilepointer(), GetId3\Module\AudioVideo\Nsv\getNSVsHeaderFilepointer(), GetId3\Module\Audio\Bonk\HandleBonkTags(), GetId3\Lib\Helper\iconv_fallback_utf16le_iso88591(), GetId3\Lib\Helper\iconv_fallback_utf16le_utf8(), GetId3\Lib\Helper\MultiByteCharString2HTML(), GetId3\Module\Tag\Apetag\parseAPEheaderFooter(), GetId3\Module\AudioVideo\Bink\ParseBink(), GetId3\Module\Misc\Iso\ParseDirectoryRecord(), GetId3\Module\Audio\Mpc\ParseMPCsv6(), GetId3\Module\Audio\Mpc\ParseMPCsv7(), GetId3\Module\Audio\Ogg\ParseOggPageHeader(), GetId3\Module\Audio\Optimfrog\ParseOptimFROGheader42(), GetId3\Module\Audio\Optimfrog\ParseOptimFROGheader45(), GetId3\Module\Misc\Iso\ParsePathTable(), GetId3\Module\Misc\Iso\ParsePrimaryVolumeDescriptor(), GetId3\Module\AudioVideo\Riff\ParseRIFF(), GetId3\Module\Misc\Iso\ParseSupplementaryVolumeDescriptor(), GetId3\Module\Audio\Ogg\ParseVorbisComments(), GetId3\Module\Audio\Ogg\ParseVorbisPageHeader(), GetId3\Module\AudioVideo\Riff\RIFFparseWAVEFORMATex(), GetId3\Module\AudioVideo\Riff\RIFFparseWavPackHeader(), GetId3\Module\Graphic\Tiff\TIFFendian2Int(), GetId3\Module\Archive\Zip\ZIPparseCentralDirectory(), GetId3\Module\Archive\Zip\ZIPparseEndOfCentralDirectory(), and GetId3\Module\Archive\Zip\ZIPparseLocalFileHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

LittleEndian2String()

static GetId3\Lib\Helper::LittleEndian2String (   $number,   $minbytes = 1,   $synchsafe = false  )

static

Parameters

type	$number
type	$minbytes
type	$synchsafe

Returns

type

Definition at line 538 of file Helper.php.

    {
        $intstring = '';
        while ($number > 0) {
            if ($synchsafe) {
                $intstring = $intstring . chr($number & 127);
                $number >>= 7;
            } else {
                $intstring = $intstring . chr($number & 255);
                $number >>= 8;
            }
        }
 
        return str_pad($intstring, $minbytes, "\x00", STR_PAD_RIGHT);
    }

Referenced by GetId3\Write\Apetag\GenerateAPEtag(), GetId3\Write\Apetag\GenerateAPEtagHeaderFooter(), and GetId3\Module\AudioVideo\Riff\ParseRIFFdata().

Here is the caller graph for this function:

MultiByteCharString2HTML()

static GetId3\Lib\Helper::MultiByteCharString2HTML (   $string,   $charset = 'ISO-8859-1'  )

static

Parameters

type	$string
type	$charset

Returns

string

Definition at line 1433 of file Helper.php.

    {
        $string = (string) $string; // in case trying to pass a numeric (float, int) string, would otherwise return an empty string
        $HTMLstring = '';
 
        switch ($charset) {
            case '1251':
            case '1252':
            case '866':
            case '932':
            case '936':
            case '950':
            case 'BIG5':
            case 'BIG5-HKSCS':
            case 'cp1251':
            case 'cp1252':
            case 'cp866':
            case 'EUC-JP':
            case 'EUCJP':
            case 'GB2312':
            case 'ibm866':
            case 'ISO-8859-1':
            case 'ISO-8859-15':
            case 'ISO8859-1':
            case 'ISO8859-15':
            case 'KOI8-R':
            case 'koi8-ru':
            case 'koi8r':
            case 'Shift_JIS':
            case 'SJIS':
            case 'win-1251':
            case 'Windows-1251':
            case 'Windows-1252':
                $HTMLstring = htmlentities($string, ENT_COMPAT, $charset);
                break;
 
            case 'UTF-8':
                $strlen = strlen($string);
                for ($i = 0; $i < $strlen; $i++) {
                    $char_ord_val = ord($string{$i});
                    $charval = 0;
                    if ($char_ord_val < 0x80) {
                        $charval = $char_ord_val;
                    } elseif ((($char_ord_val & 0xF0) >> 4) == 0x0F && $i + 3 < $strlen) {
                        $charval = (($char_ord_val & 0x07) << 18);
                        $charval += ((ord($string{++$i}) & 0x3F) << 12);
                        $charval += ((ord($string{++$i}) & 0x3F) << 6);
                        $charval += (ord($string{++$i}) & 0x3F);
                    } elseif ((($char_ord_val & 0xE0) >> 5) == 0x07 && $i + 2 < $strlen) {
                        $charval = (($char_ord_val & 0x0F) << 12);
                        $charval += ((ord($string{++$i}) & 0x3F) << 6);
                        $charval += (ord($string{++$i}) & 0x3F);
                    } elseif ((($char_ord_val & 0xC0) >> 6) == 0x03 && $i + 1 < $strlen) {
                        $charval = (($char_ord_val & 0x1F) << 6);
                        $charval += (ord($string{++$i}) & 0x3F);
                    }
                    if (($charval >= 32) && ($charval <= 127)) {
                        $HTMLstring .= htmlentities(chr($charval));
                    } else {
                        $HTMLstring .= '&#' . $charval . ';';
                    }
                }
                break;
 
            case 'UTF-16LE':
                for ($i = 0; $i < strlen($string); $i += 2) {
                    $charval = self::LittleEndian2Int(substr($string, $i, 2));
                    if (($charval >= 32) && ($charval <= 127)) {
                        $HTMLstring .= chr($charval);
                    } else {
                        $HTMLstring .= '&#' . $charval . ';';
                    }
                }
                break;
 
            case 'UTF-16BE':
                for ($i = 0; $i < strlen($string); $i += 2) {
                    $charval = self::BigEndian2Int(substr($string, $i, 2));
                    if (($charval >= 32) && ($charval <= 127)) {
                        $HTMLstring .= chr($charval);
                    } else {
                        $HTMLstring .= '&#' . $charval . ';';
                    }
                }
                break;
 
            default:
                $HTMLstring = 'ERROR: Character set "' . $charset . '" not supported in MultiByteCharString2HTML()';
                break;
        }
 
        return $HTMLstring;
    }

References GetId3\Lib\Helper\BigEndian2Int(), and GetId3\Lib\Helper\LittleEndian2Int().

Here is the call graph for this function:

NormalizeBinaryPoint()

static GetId3\Lib\Helper::NormalizeBinaryPoint (   $binarypointnumber,   $maxbits = 52  )

static

Parameters

type	$binarypointnumber
type	$maxbits

Returns

type

Definition at line 180 of file Helper.php.

    {
        // http://www.scri.fsu.edu/~jac/MAD3401/Backgrnd/binary.html
        if (strpos($binarypointnumber, '.') === false) {
            $binarypointnumber = '0.' . $binarypointnumber;
        } elseif ($binarypointnumber{0} == '.') {
            $binarypointnumber = '0' . $binarypointnumber;
        }
        $exponent = 0;
        while (($binarypointnumber{0} != '1') || (substr($binarypointnumber, 1,
                                                         1) != '.')) {
            if (substr($binarypointnumber, 1, 1) == '.') {
                $exponent--;
                $binarypointnumber = substr($binarypointnumber, 2, 1) . '.' . substr($binarypointnumber,
                                                                                     3);
            } else {
                $pointpos = strpos($binarypointnumber, '.');
                $exponent += ($pointpos - 1);
                $binarypointnumber = str_replace('.', '', $binarypointnumber);
                $binarypointnumber = $binarypointnumber{0} . '.' . substr($binarypointnumber,
                                                                          1);
            }
        }
        $binarypointnumber = str_pad(substr($binarypointnumber, 0, $maxbits + 2),
                                            $maxbits + 2, '0', STR_PAD_RIGHT);
 
        return array('normalized' => $binarypointnumber, 'exponent' => (int) $exponent);
    }

Referenced by GetId3\Lib\Helper\Float2String().

Here is the caller graph for this function:

PlaytimeString()

static GetId3\Lib\Helper::PlaytimeString (   $seconds )

static

Parameters

type

$seconds

Returns

type

Definition at line 651 of file Helper.php.

    {
        $sign = (($seconds < 0) ? '-' : '');
        $seconds = round(abs($seconds));
        $H = (int) floor($seconds / 3600);
        $M = (int) floor(($seconds - (3600 * $H) ) / 60);
        $S = (int) round($seconds - (3600 * $H) - (60 * $M));
 
        return $sign . ($H ? $H . ':' : '') . ($H ? str_pad($M, 2, '0',
                                                            STR_PAD_LEFT) : intval($M)) . ':' . str_pad($S,
                                                                                                        2,
                                                                                                        0,
                                                                                                        STR_PAD_LEFT);
    }

PrintHexBytes()

static GetId3\Lib\Helper::PrintHexBytes (   $string,   $hex = true,   $spaces = true,   $htmlencoding = 'UTF-8'  )

static

Parameters

type	$string
type	$hex
type	$spaces
string	$htmlencoding

Returns

type

Definition at line 36 of file Helper.php.

    {
        $returnstring = '';
        for ($i = 0; $i < strlen($string); $i++) {
            if ($hex) {
                $returnstring .= str_pad(dechex(ord($string{$i})), 2, '0',
                                                    STR_PAD_LEFT);
            } else {
                $returnstring .= ' ' . (preg_match("#[\x20-\x7E]#", $string{$i}) ? $string{$i} : '¤');
            }
            if ($spaces) {
                $returnstring .= ' ';
            }
        }
        if (!empty($htmlencoding)) {
            if ($htmlencoding === true) {
                $htmlencoding = 'UTF-8'; // prior to GetId3 v1.9.0 the function's 4th parameter was boolean
            }
            $returnstring = htmlentities($returnstring, ENT_QUOTES,
                                         $htmlencoding);
        }
 
        return $returnstring;
    }

Referenced by GetId3\Module\Archive\Szip\analyze(), GetId3\Module\Audio\Aa\analyze(), GetId3\Module\Audio\Ac3\analyze(), GetId3\Module\Audio\Au\analyze(), GetId3\Module\Audio\Avr\analyze(), GetId3\Module\Audio\Bonk\analyze(), GetId3\Module\Audio\Dss\analyze(), GetId3\Module\Audio\Dts\analyze(), GetId3\Module\Audio\Flac\analyze(), GetId3\Module\Audio\La\analyze(), GetId3\Module\Audio\Midi\analyze(), GetId3\Module\Audio\Monkey\analyze(), GetId3\Module\Audio\Mpc\analyze(), GetId3\Module\Audio\Optimfrog\analyze(), GetId3\Module\Audio\Rkau\analyze(), GetId3\Module\Audio\Shorten\analyze(), GetId3\Module\Audio\Tta\analyze(), GetId3\Module\Audio\Voc\analyze(), GetId3\Module\Audio\Vqf\analyze(), GetId3\Module\Audio\Wavpack\analyze(), GetId3\Module\AudioVideo\Asf\analyze(), GetId3\Module\AudioVideo\Bink\analyze(), GetId3\Module\AudioVideo\Flv\analyze(), GetId3\Module\AudioVideo\Nsv\analyze(), GetId3\Module\AudioVideo\Riff\analyze(), GetId3\Module\AudioVideo\Swf\analyze(), GetId3\Module\AudioVideo\Ts\analyze(), GetId3\Module\Graphic\Bmp\analyze(), GetId3\Module\Graphic\Gif\analyze(), GetId3\Module\Misc\Exe\analyze(), GetId3\Module\Misc\Msoffice\analyze(), GetId3\Module\Audio\Mp3\decodeMPEGaudioHeader(), GetId3\Module\Audio\Mp3\FreeFormatFrameLength(), GetId3\Module\Audio\Optimfrog\ParseOptimFROGheader45(), and GetId3\Module\AudioVideo\Quicktime\QuicktimeParseAtom().

Here is the caller graph for this function:

RGADadjustmentLookup()

static GetId3\Lib\Helper::RGADadjustmentLookup (   $rawadjustment,   $signbit  )

static

Parameters

type	$rawadjustment
type	$signbit

Returns

type

Definition at line 1571 of file Helper.php.

    {
        $adjustment = $rawadjustment / 10;
        if ($signbit == 1) {
            $adjustment *= -1;
        }
 
        return (float) $adjustment;
    }

Referenced by GetId3\Module\AudioVideo\Riff\analyze(), GetId3\Module\Audio\Mp3\decodeMPEGaudioHeader(), and GetId3\Module\Tag\Id3v2\ParseID3v2Frame().

Here is the caller graph for this function:

RGADamplitude2dB()

static GetId3\Lib\Helper::RGADamplitude2dB (   $amplitude )

static

Parameters

type

$amplitude

Returns

type

Definition at line 1610 of file Helper.php.

    {
        return 20 * log10($amplitude);
    }

Referenced by GetId3\Module\Audio\Mp3\decodeMPEGaudioHeader(), and GetId3\Module\Audio\Ac3\heavyCompression().

Here is the caller graph for this function:

RGADgainString()

static GetId3\Lib\Helper::RGADgainString (   $namecode,   $originatorcode,   $replaygain  )

static

Parameters

type	$namecode
type	$originatorcode
type	$replaygain

Returns

type

Definition at line 1588 of file Helper.php.

    {
        if ($replaygain < 0) {
            $signbit = '1';
        } else {
            $signbit = '0';
        }
        $storedreplaygain = intval(round($replaygain * 10));
        $gainstring = str_pad(decbin($namecode), 3, '0', STR_PAD_LEFT);
        $gainstring .= str_pad(decbin($originatorcode), 3, '0', STR_PAD_LEFT);
        $gainstring .= $signbit;
        $gainstring .= str_pad(decbin($storedreplaygain), 9, '0', STR_PAD_LEFT);
 
        return $gainstring;
    }

Referenced by GetId3\Write\Id3v2\GenerateID3v2FrameData().

Here is the caller graph for this function:

RGADnameLookup()

static GetId3\Lib\Helper::RGADnameLookup (   $namecode )

static

@staticvar array $RGADname

Parameters

type

$namecode

Returns

type

Definition at line 1534 of file Helper.php.

    {
        static $RGADname = array();
        if (empty($RGADname)) {
            $RGADname[0] = 'not set';
            $RGADname[1] = 'Track Gain Adjustment';
            $RGADname[2] = 'Album Gain Adjustment';
        }
 
        return (isset($RGADname[$namecode]) ? $RGADname[$namecode] : '');
    }

Referenced by GetId3\Module\AudioVideo\Riff\analyze(), GetId3\Module\Audio\Mp3\decodeMPEGaudioHeader(), and GetId3\Module\Tag\Id3v2\ParseID3v2Frame().

Here is the caller graph for this function:

RGADoriginatorLookup()

static GetId3\Lib\Helper::RGADoriginatorLookup (   $originatorcode )

static

@staticvar array $RGADoriginator

Parameters

type

$originatorcode

Returns

type

Definition at line 1552 of file Helper.php.

    {
        static $RGADoriginator = array();
        if (empty($RGADoriginator)) {
            $RGADoriginator[0] = 'unspecified';
            $RGADoriginator[1] = 'pre-set by artist/producer/mastering engineer';
            $RGADoriginator[2] = 'set by user';
            $RGADoriginator[3] = 'determined automatically';
        }
 
        return (isset($RGADoriginator[$originatorcode]) ? $RGADoriginator[$originatorcode] : '');
    }

Referenced by GetId3\Module\AudioVideo\Riff\analyze(), GetId3\Module\Audio\Mp3\decodeMPEGaudioHeader(), and GetId3\Module\Tag\Id3v2\ParseID3v2Frame().

Here is the caller graph for this function:

safe_inc()

static GetId3\Lib\Helper::safe_inc ( &  $variable,   $increment = 1  )

static

Parameters

type	$variable
type	$increment

Returns

boolean

Definition at line 91 of file Helper.php.

    {
        if (isset($variable)) {
            $variable += $increment;
        } else {
            $variable = $increment;
        }
 
        return true;
    }

Referenced by GetId3\Module\Audio\Voc\analyze(), GetId3\Module\Audio\Aac\getAACADTSheaderFilepointer(), GetId3\Module\Audio\Mp3\getOnlyMPEGaudioInfo(), GetId3\Module\Audio\Mp3\getOnlyMPEGaudioInfoBruteForce(), and GetId3\Module\Audio\Flac\parseSEEKTABLE().

Here is the caller graph for this function:

SimpleXMLelement2array()

static GetId3\Lib\Helper::SimpleXMLelement2array (   $XMLobject )

static

Parameters

type

$XMLobject

Returns

type

Definition at line 816 of file Helper.php.

    {
        if (!is_object($XMLobject) && !is_array($XMLobject)) {
            return $XMLobject;
        }
        $XMLarray = (is_object($XMLobject) ? get_object_vars($XMLobject) : $XMLobject);
        foreach ($XMLarray as $key => $value) {
            $XMLarray[$key] = self::SimpleXMLelement2array($value);
        }
 
        return $XMLarray;
    }

References GetId3\Lib\Helper\SimpleXMLelement2array().

Referenced by GetId3\Lib\Helper\SimpleXMLelement2array(), and GetId3\Lib\Helper\XML2array().

Here is the call graph for this function:

Here is the caller graph for this function:

toCamelCase()

static GetId3\Lib\Helper::toCamelCase (   $origin,   $cahrToReplace = '_',   $capitaliseFirstChar = false  )

static

Parameters

type	$origin
type	$cahrToReplace
type	$capitaliseFirstChar

Returns

type

Definition at line 1823 of file Helper.php.

    {
        if ($capitaliseFirstChar) {
            $origin = ucfirst($origin);
        }
        $func = create_function('$c', 'return strtoupper($c[1]);');
 
        return preg_replace_callback('/' . $cahrToReplace . '([a-z])/', $func, $origin);
    }

trimNullByte()

static GetId3\Lib\Helper::trimNullByte (   $string )

static

Parameters

type

$string

Returns

type

Definition at line 1811 of file Helper.php.

    {
        return trim($string, "\x00");
    }

Referenced by GetId3\Module\AudioVideo\Matroska\parseEBML().

Here is the caller graph for this function:

trunc()

static GetId3\Lib\Helper::trunc (   $floatnumber )

static

Parameters

type

$floatnumber

Returns

type

Definition at line 67 of file Helper.php.

    {
        // truncates a floating-point number at the decimal point
        // returns int (if possible, otherwise float)
        if ($floatnumber >= 1) {
            $truncatednumber = floor($floatnumber);
        } elseif ($floatnumber <= -1) {
            $truncatednumber = ceil($floatnumber);
        } else {
            $truncatednumber = 0;
        }
        if (self::intValueSupported($truncatednumber)) {
            $truncatednumber = (int) $truncatednumber;
        }
 
        return $truncatednumber;
    }

Referenced by GetId3\Module\Audio\Voc\analyze(), and GetId3\Lib\Helper\Float2BinaryDecimal().

Here is the caller graph for this function:

XML2array()

static GetId3\Lib\Helper::XML2array (   $XMLstring )

static

Parameters

type

$XMLstring

Returns

boolean

Definition at line 798 of file Helper.php.

    {
        if (function_exists('simplexml_load_string')) {
            if (function_exists('get_object_vars')) {
                $XMLobject = simplexml_load_string($XMLstring);
 
                return self::SimpleXMLelement2array($XMLobject);
            }
        }
 
        return false;
    }

References GetId3\Lib\Helper\SimpleXMLelement2array().

Referenced by GetId3\Module\AudioVideo\Riff\analyze().

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/phansys/getid3/GetId3/Lib/Helper.php