GetId3\Handler\BaseHandler Class Reference

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

Inheritance diagram for GetId3\Handler\BaseHandler:

Collaboration diagram for GetId3\Handler\BaseHandler:

Public Member Functions
	__construct (GetId3Core $getid3, $call_module=null)
	analyze ()
	Analyze from file pointer. More...
	AnalyzeString (&$string)
	Analyze from string instead. More...
	saveAttachment (&$ThisFileInfoIndex, $filename, $offset, $length)

Protected Member Functions
	ftell ()
	fread ($bytes)
	fseek ($bytes, $whence=SEEK_SET)
	feof ()
	isDependencyFor ($module)
	error ($text)
	warning ($text)

Protected Attributes
	$getid3
	$data_string_flag = false
	$data_string = ''
	$data_string_position = 0
	$data_string_length = 0

Private Attributes
	$dependency_to

Detailed Description

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

Author

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

Definition at line 25 of file BaseHandler.php.

Constructor & Destructor Documentation

__construct()

GetId3\Handler\BaseHandler::__construct	(	GetId3Core	$getid3,
			$call_module = null
	)

Parameters

GetId3\GetId3	$getid3
type	$call_module

Definition at line 69 of file BaseHandler.php.

References GetId3\Handler\BaseHandler\$getid3, and GetId3\Handler\BaseHandler\analyze().

    {
        $this->getid3 = $getid3;

        if (null !== $call_module) {
            $this->dependency_to = $call_module;
        }
    }

Here is the call graph for this function:

Member Function Documentation

analyze()

GetId3\Handler\BaseHandler::analyze ( )

abstract

Analyze from file pointer.

Referenced by GetId3\Handler\BaseHandler\__construct(), and GetId3\Handler\BaseHandler\AnalyzeString().

Here is the caller graph for this function:

AnalyzeString()

GetId3\Handler\BaseHandler::AnalyzeString

(

&

$string

)

Analyze from string instead.

Definition at line 86 of file BaseHandler.php.

References GetId3\Handler\BaseHandler\analyze().

    {
        // Enter string mode
        $this->data_string_flag = true;
        $this->data_string = $string;

        // Save info
        $saved_avdataoffset = $this->getid3->info['avdataoffset'];
        $saved_avdataend = $this->getid3->info['avdataend'];
        $saved_filesize = (isset($this->getid3->info['filesize']) ? $this->getid3->info['filesize'] : null); // may be not set if called as dependency without openfile() call
        // Reset some info
        $this->getid3->info['avdataoffset'] = 0;
        $this->getid3->info['avdataend'] = $this->getid3->info['filesize'] = $this->data_string_length = strlen($string);

        // Analyze
        $this->analyze();

        // Restore some info
        $this->getid3->info['avdataoffset'] = $saved_avdataoffset;
        $this->getid3->info['avdataend'] = $saved_avdataend;
        $this->getid3->info['filesize'] = $saved_filesize;

        // Exit string mode
        $this->data_string_flag = false;
    }

Here is the call graph for this function:

error()

GetId3\Handler\BaseHandler::error (   $text )

protected

Parameters

type

$text

Returns

boolean

Definition at line 199 of file BaseHandler.php.

References $text.

Referenced by GetId3\Module\Audio\Dts\analyze(), GetId3\Module\Audio\Flac\analyze(), GetId3\Module\Audio\Ac3\analyze(), GetId3\Module\Audio\Flac\parseMETAdata(), and GetId3\Module\Audio\Flac\parseSTREAMINFO().

    {
        $this->getid3->info['error'][] = $text;

        return false;
    }

Here is the caller graph for this function:

feof()

GetId3\Handler\BaseHandler::feof ( )

protected

Returns

type

Definition at line 175 of file BaseHandler.php.

References GetId3\Handler\BaseHandler\$data_string_length.

Referenced by GetId3\Module\Archive\Szip\analyze(), GetId3\Module\Audio\Voc\analyze(), GetId3\Module\Audio\Wavpack\analyze(), GetId3\Module\Archive\Tar\analyze(), GetId3\Module\AudioVideo\Matroska\EnsureBufferHasEnoughData(), GetId3\Module\Audio\Mp3\getOnlyMPEGaudioInfo(), GetId3\Module\Audio\Bonk\HandleBonkTags(), GetId3\Module\Audio\Ogg\ParseOggPageHeader(), and GetId3\Module\Audio\Optimfrog\ParseOptimFROGheader45().

    {
        if ($this->data_string_flag) {
            return $this->data_string_position >= $this->data_string_length;
        }

        return feof($this->getid3->fp);
    }

Here is the caller graph for this function:

fread()

GetId3\Handler\BaseHandler::fread (   $bytes )

protected

Parameters

type

$bytes

Returns

type

Definition at line 130 of file BaseHandler.php.

Referenced by GetId3\Module\Audio\Avr\analyze(), GetId3\Module\Graphic\Svg\analyze(), GetId3\Module\Archive\Zip\analyze(), GetId3\Module\Audio\Dss\analyze(), GetId3\Module\Audio\Aac\analyze(), GetId3\Module\Audio\Dts\analyze(), GetId3\Module\Tag\Id3v1\analyze(), GetId3\Module\Archive\Szip\analyze(), GetId3\Module\Audio\Mod\analyze(), GetId3\Module\Audio\Vqf\analyze(), GetId3\Module\AudioVideo\Ts\analyze(), GetId3\Module\Graphic\Efax\analyze(), GetId3\Module\Graphic\Gif\analyze(), GetId3\Module\Audio\Mpc\analyze(), GetId3\Module\Graphic\Png\analyze(), GetId3\Module\Audio\Aa\analyze(), GetId3\Module\Graphic\Tiff\analyze(), GetId3\Module\Misc\Exe\analyze(), GetId3\Module\Misc\Iso\analyze(), GetId3\Module\Audio\Rkau\analyze(), GetId3\Module\Misc\Msoffice\analyze(), GetId3\Module\Audio\Voc\analyze(), GetId3\Module\Audio\Tta\analyze(), GetId3\Module\AudioVideo\Bink\analyze(), GetId3\Module\Audio\Au\analyze(), GetId3\Module\AudioVideo\Nsv\analyze(), GetId3\Module\Audio\Monkey\analyze(), GetId3\Module\Audio\Flac\analyze(), GetId3\Module\Audio\Bonk\analyze(), GetId3\Module\AudioVideo\Real\analyze(), GetId3\Module\Audio\La\analyze(), GetId3\Module\Tag\Lyrics3\analyze(), GetId3\Module\Audio\Lpac\analyze(), GetId3\Module\Audio\Wavpack\analyze(), GetId3\Module\Graphic\Pcd\analyze(), GetId3\Module\Audio\Optimfrog\analyze(), GetId3\Module\Audio\Shorten\analyze(), GetId3\Module\AudioVideo\Swf\analyze(), GetId3\Module\Graphic\Jpg\analyze(), GetId3\Module\Audio\Ogg\analyze(), GetId3\Module\Archive\Tar\analyze(), GetId3\Module\Audio\Midi\analyze(), GetId3\Module\Tag\Apetag\analyze(), GetId3\Module\Graphic\Bmp\analyze(), GetId3\Module\Tag\Id3v2\analyze(), GetId3\Module\AudioVideo\Mpeg\analyze(), GetId3\Module\Audio\Ac3\analyze(), GetId3\Module\AudioVideo\Riff\analyze(), GetId3\Module\AudioVideo\Quicktime\analyze(), GetId3\Module\Audio\Mp3\analyze(), GetId3\Module\AudioVideo\Flv\analyze(), GetId3\Module\AudioVideo\Asf\analyze(), GetId3\Module\Audio\Mp3\decodeMPEGaudioHeader(), GetId3\Write\Apetag\DeleteAPEtag(), GetId3\Write\Lyrics3\DeleteLyrics3(), GetId3\Module\AudioVideo\Matroska\EnsureBufferHasEnoughData(), GetId3\Module\Audio\Mp3\FreeFormatFrameLength(), GetId3\Module\Audio\Aac\getAACADIFheaderFilepointer(), GetId3\Module\Audio\Aac\getAACADTSheaderFilepointer(), GetId3\Module\Audio\Mod\getITheaderFilepointer(), GetId3\Module\Graphic\Gif\GetLSBits(), GetId3\Module\Tag\Lyrics3\getLyrics3Data(), GetId3\Module\Audio\Mod\getMODheaderFilepointer(), GetId3\Module\AudioVideo\Nsv\getNSVfHeaderFilepointer(), GetId3\Module\AudioVideo\Nsv\getNSVsHeaderFilepointer(), GetId3\Module\Audio\Mp3\getOnlyMPEGaudioInfo(), GetId3\Module\Audio\Mp3\getOnlyMPEGaudioInfoBruteForce(), GetId3\Module\Audio\Mod\getS3MheaderFilepointer(), GetId3\Module\Audio\Mod\getXMheaderFilepointer(), GetId3\Module\Audio\Bonk\HandleBonkTags(), GetId3\Module\AudioVideo\Bink\ParseBink(), GetId3\Module\Misc\Iso\ParseDirectoryRecord(), GetId3\Module\Audio\Flac\parseMETAdata(), GetId3\Module\Audio\Mpc\ParseMPCsv6(), GetId3\Module\Audio\Mpc\ParseMPCsv7(), GetId3\Module\Audio\Mpc\ParseMPCsv8(), GetId3\Module\Audio\Ogg\ParseOggPageHeader(), GetId3\Module\Audio\Optimfrog\ParseOptimFROGheader42(), GetId3\Module\Audio\Optimfrog\ParseOptimFROGheader45(), GetId3\Module\Misc\Iso\ParsePathTable(), GetId3\Module\Audio\Flac\parsePICTURE(), GetId3\Module\AudioVideo\Riff\ParseRIFF(), GetId3\Module\Audio\Ogg\ParseVorbisComments(), GetId3\Write\Id3v1\RemoveID3v1(), GetId3\Write\Id3v2\RemoveID3v2(), GetId3\Handler\BaseHandler\saveAttachment(), GetId3\Write\Apetag\WriteAPEtag(), GetId3\Write\Id3v1\WriteID3v1(), GetId3\Write\Id3v2\WriteID3v2(), GetId3\Module\Archive\Zip\ZIPparseCentralDirectory(), GetId3\Module\Archive\Zip\ZIPparseEndOfCentralDirectory(), and GetId3\Module\Archive\Zip\ZIPparseLocalFileHeader().

    {
        if ($this->data_string_flag) {
            $this->data_string_position += $bytes;

            return substr($this->data_string,
                          $this->data_string_position - $bytes, $bytes);
        }

        return fread($this->getid3->fp, $bytes);
    }

Here is the caller graph for this function:

fseek()

GetId3\Handler\BaseHandler::fseek (   $bytes,   $whence = SEEK_SET  )

protected

Parameters

type	$bytes
type	$whence

Returns

int

Definition at line 148 of file BaseHandler.php.

Referenced by GetId3\Module\Audio\Avr\analyze(), GetId3\Module\Graphic\Svg\analyze(), GetId3\Module\Archive\Zip\analyze(), GetId3\Module\Audio\Aac\analyze(), GetId3\Module\Audio\Dss\analyze(), GetId3\Module\Audio\Dts\analyze(), GetId3\Module\Tag\Id3v1\analyze(), GetId3\Module\Audio\Mod\analyze(), GetId3\Module\Audio\Vqf\analyze(), GetId3\Module\Archive\Szip\analyze(), GetId3\Module\Graphic\Efax\analyze(), GetId3\Module\Graphic\Gif\analyze(), GetId3\Module\Audio\Mpc\analyze(), GetId3\Module\Graphic\Png\analyze(), GetId3\Module\Graphic\Tiff\analyze(), GetId3\Module\Misc\Exe\analyze(), GetId3\Module\Audio\Aa\analyze(), GetId3\Module\Misc\Iso\analyze(), GetId3\Module\Misc\Msoffice\analyze(), GetId3\Module\Audio\Rkau\analyze(), GetId3\Module\Audio\Tta\analyze(), GetId3\Module\Audio\Voc\analyze(), GetId3\Module\AudioVideo\Bink\analyze(), GetId3\Module\AudioVideo\Nsv\analyze(), GetId3\Module\Audio\Au\analyze(), GetId3\Module\Audio\Monkey\analyze(), GetId3\Module\AudioVideo\Ts\analyze(), GetId3\Module\Audio\Flac\analyze(), GetId3\Module\AudioVideo\Real\analyze(), GetId3\Module\Audio\Bonk\analyze(), GetId3\Module\Audio\Lpac\analyze(), GetId3\Module\Tag\Lyrics3\analyze(), GetId3\Module\Audio\La\analyze(), GetId3\Module\Audio\Wavpack\analyze(), GetId3\Module\Graphic\Pcd\analyze(), GetId3\Module\Audio\Optimfrog\analyze(), GetId3\Module\Audio\Shorten\analyze(), GetId3\Module\Graphic\Jpg\analyze(), GetId3\Module\AudioVideo\Swf\analyze(), GetId3\Module\Audio\Ogg\analyze(), GetId3\Module\Archive\Tar\analyze(), GetId3\Module\Audio\Midi\analyze(), GetId3\Module\Tag\Apetag\analyze(), GetId3\Module\Tag\Id3v2\analyze(), GetId3\Module\AudioVideo\Mpeg\analyze(), GetId3\Module\Graphic\Bmp\analyze(), GetId3\Module\Audio\Ac3\analyze(), GetId3\Module\AudioVideo\Riff\analyze(), GetId3\Module\AudioVideo\Quicktime\analyze(), GetId3\Module\Audio\Mp3\analyze(), GetId3\Module\AudioVideo\Flv\analyze(), GetId3\Module\AudioVideo\Asf\analyze(), GetId3\Module\Audio\Mp3\decodeMPEGaudioHeader(), GetId3\Write\Apetag\DeleteAPEtag(), GetId3\Write\Lyrics3\DeleteLyrics3(), GetId3\Module\AudioVideo\Matroska\EnsureBufferHasEnoughData(), GetId3\Module\Audio\Mp3\FreeFormatFrameLength(), GetId3\Module\Audio\Aac\getAACADIFheaderFilepointer(), GetId3\Module\Audio\Aac\getAACADTSheaderFilepointer(), GetId3\Module\Audio\Mod\getITheaderFilepointer(), GetId3\Module\Tag\Lyrics3\getLyrics3Data(), GetId3\Module\Audio\Mod\getMODheaderFilepointer(), GetId3\Module\AudioVideo\Nsv\getNSVfHeaderFilepointer(), GetId3\Module\AudioVideo\Nsv\getNSVsHeaderFilepointer(), GetId3\Module\Audio\Mp3\getOnlyMPEGaudioInfo(), GetId3\Module\Audio\Mp3\getOnlyMPEGaudioInfoBruteForce(), GetId3\Module\Audio\Mod\getS3MheaderFilepointer(), GetId3\Module\Audio\Mod\getXMheaderFilepointer(), GetId3\Module\Audio\Bonk\HandleBonkTags(), GetId3\Module\Misc\Iso\ParseDirectoryRecord(), GetId3\Module\Audio\Mpc\ParseMPCsv6(), GetId3\Module\Audio\Mpc\ParseMPCsv8(), GetId3\Module\Audio\Ogg\ParseOggPageHeader(), GetId3\Module\Audio\Optimfrog\ParseOptimFROGheader42(), GetId3\Module\Audio\Optimfrog\ParseOptimFROGheader45(), GetId3\Module\Misc\Iso\ParsePathTable(), GetId3\Module\AudioVideo\Riff\ParseRIFF(), GetId3\Module\Audio\Ogg\ParseVorbisComments(), GetId3\Write\Id3v1\RemoveID3v1(), GetId3\Write\Id3v2\RemoveID3v2(), GetId3\Handler\BaseHandler\saveAttachment(), GetId3\Write\Apetag\WriteAPEtag(), GetId3\Write\Id3v1\WriteID3v1(), GetId3\Write\Id3v2\WriteID3v2(), GetId3\Module\Archive\Zip\ZIPparseCentralDirectory(), GetId3\Module\Archive\Zip\ZIPparseEndOfCentralDirectory(), and GetId3\Module\Archive\Zip\ZIPparseLocalFileHeader().

    {
        if ($this->data_string_flag) {
            switch ($whence) {
                case SEEK_SET:
                    $this->data_string_position = $bytes;
                    break;

                case SEEK_CUR:
                    $this->data_string_position += $bytes;
                    break;

                case SEEK_END:
                    $this->data_string_position = $this->data_string_length + $bytes;
                    break;
            }

            return 0;
        }

        return fseek($this->getid3->fp, $bytes, $whence);
    }

Here is the caller graph for this function:

ftell()

GetId3\Handler\BaseHandler::ftell ( )

protected

Returns

type

Definition at line 116 of file BaseHandler.php.

References GetId3\Handler\BaseHandler\$data_string_position.

Referenced by GetId3\Module\Audio\Vqf\analyze(), GetId3\Module\Graphic\Png\analyze(), GetId3\Module\Audio\Voc\analyze(), GetId3\Module\AudioVideo\Real\analyze(), GetId3\Module\Audio\Bonk\analyze(), GetId3\Module\Audio\Wavpack\analyze(), GetId3\Module\Audio\Ogg\analyze(), GetId3\Module\Tag\Apetag\analyze(), GetId3\Module\AudioVideo\Mpeg\analyze(), GetId3\Module\AudioVideo\Flv\analyze(), GetId3\Module\AudioVideo\Asf\analyze(), GetId3\Module\Audio\Mp3\getOnlyMPEGaudioInfo(), GetId3\Module\Audio\Mp3\getOnlyMPEGaudioInfoBruteForce(), GetId3\Module\Audio\Flac\parseMETAdata(), GetId3\Module\Audio\Mpc\ParseMPCsv8(), GetId3\Module\Audio\Ogg\ParseOggPageHeader(), GetId3\Module\Audio\Optimfrog\ParseOptimFROGheader45(), GetId3\Module\Audio\Flac\parsePICTURE(), GetId3\Module\AudioVideo\Riff\ParseRIFF(), GetId3\Module\Audio\Ogg\ParseVorbisComments(), GetId3\Write\Apetag\WriteAPEtag(), GetId3\Module\Archive\Zip\ZIPparseCentralDirectory(), GetId3\Module\Archive\Zip\ZIPparseEndOfCentralDirectory(), and GetId3\Module\Archive\Zip\ZIPparseLocalFileHeader().

    {
        if ($this->data_string_flag) {
            return $this->data_string_position;
        }

        return ftell($this->getid3->fp);
    }

Here is the caller graph for this function:

isDependencyFor()

GetId3\Handler\BaseHandler::isDependencyFor (   $module )

finalprotected

Parameters

type

$module

Returns

type

Definition at line 189 of file BaseHandler.php.

Referenced by GetId3\Module\Audio\Dts\analyze(), GetId3\Module\Audio\Ac3\analyze(), GetId3\Module\Audio\Flac\parseMETAdata(), GetId3\Module\Audio\Flac\parseSTREAMINFO(), and GetId3\Module\Audio\Flac\parseVORBIS_COMMENT().

    {
        return $this->dependency_to == $module;
    }

Here is the caller graph for this function:

saveAttachment()

GetId3\Handler\BaseHandler::saveAttachment	(	&	$ThisFileInfoIndex,
			$filename,
			$offset,
			$length
	)

Parameters

type	$ThisFileInfoIndex
type	$filename
type	$offset
type	$length

Returns

boolean

Exceptions

Exception

Definition at line 225 of file BaseHandler.php.

References $filename, array, GetId3\Handler\BaseHandler\fread(), GetId3\Handler\BaseHandler\fseek(), GetId3\Lib\Helper\intValueSupported(), and GetId3\Handler\BaseHandler\warning().

Referenced by GetId3\Module\AudioVideo\Matroska\parseEBML(), and GetId3\Module\Audio\Flac\parsePICTURE().

    {
        try {
            if (!Helper::intValueSupported($offset + $length)) {
                throw new DefaultException('it extends beyond the ' . round(PHP_INT_MAX / 1073741824) . 'GB limit');
            }

            // do not extract at all
            if ($this->getid3->option_save_attachments === self::ATTACHMENTS_NONE) {
                unset($ThisFileInfoIndex); // do not set any
            }

            // extract to return array
            else if ($this->getid3->option_save_attachments === self::ATTACHMENTS_INLINE) {

                // get whole data in one pass, till it is anyway stored in memory
                $this->fseek($offset);
                $ThisFileInfoIndex = $this->fread($length);
                if ($ThisFileInfoIndex === false || strlen($ThisFileInfoIndex) != $length) { // verify
                    throw new DefaultException('failed to read attachment data');
                }
            }

            // assume directory path is given
            else {

                // set up destination path
                $dir = rtrim(str_replace(array('/', '\\'), DIRECTORY_SEPARATOR,
                                         $this->getid3->option_save_attachments),
                                         DIRECTORY_SEPARATOR);
                if (!is_dir($dir) || !is_writable($dir)) { // check supplied directory
                    throw new DefaultException('supplied path (' . $dir . ') does not exist, or is not writable');
                }
                $dest = $dir . DIRECTORY_SEPARATOR . $filename;

                // create dest file
                if (($fp_dest = fopen($dest, 'wb')) == false) {
                    throw new DefaultException('failed to create file ' . $dest);
                }

                // copy data
                $this->fseek($offset);
                $buffersize = ($this->data_string_flag ? $length : $this->getid3->fread_buffer_size());
                $bytesleft = $length;
                while ($bytesleft > 0) {
                    if (($buffer = $this->fread(min($buffersize, $bytesleft))) === false || ($byteswritten = fwrite($fp_dest,
                                                                                                                    $buffer)) === false) {
                        fclose($fp_dest);
                        unlink($dest);
                        throw new DefaultException($buffer === false ? 'not enough data to read' : 'failed to write to destination file, may be not enough disk space');
                    }
                    $bytesleft -= $byteswritten;
                }

                fclose($fp_dest);
                $ThisFileInfoIndex = $dest;
            }
        } catch (DefaultException $e) {

            unset($ThisFileInfoIndex); // do not set any is case of error
            $this->warning('Failed to extract attachment ' . $filename . ': ' . $e->getMessage());

            return false;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

warning()

GetId3\Handler\BaseHandler::warning (   $text )

protected

Parameters

type

$text

Returns

type

Definition at line 211 of file BaseHandler.php.

References $text.

Referenced by GetId3\Module\Audio\Flac\parseMETAdata(), GetId3\Module\Audio\Flac\parseSTREAMINFO(), and GetId3\Handler\BaseHandler\saveAttachment().

    {
        return $this->getid3->warning($text);
    }

Here is the caller graph for this function:

Field Documentation

$data_string

GetId3\Handler\BaseHandler::$data_string = ''

protected

Definition at line 46 of file BaseHandler.php.

Referenced by GetId3\Module\Audio\Flac\parseVORBIS_COMMENT().

$data_string_flag

GetId3\Handler\BaseHandler::$data_string_flag = false

protected

Definition at line 39 of file BaseHandler.php.

$data_string_length

GetId3\Handler\BaseHandler::$data_string_length = 0

protected

Definition at line 60 of file BaseHandler.php.

Referenced by GetId3\Handler\BaseHandler\feof().

$data_string_position

GetId3\Handler\BaseHandler::$data_string_position = 0

protected

Definition at line 53 of file BaseHandler.php.

Referenced by GetId3\Handler\BaseHandler\ftell().

$dependency_to

GetId3\Handler\BaseHandler::$dependency_to

private

Definition at line 62 of file BaseHandler.php.

$getid3

GetId3\Handler\BaseHandler::$getid3

protected

Definition at line 32 of file BaseHandler.php.

Referenced by GetId3\Handler\BaseHandler\__construct(), and GetId3\Module\AudioVideo\Riff\analyze().

---

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

• libs/composer/vendor/phansys/getid3/GetId3/Handler/BaseHandler.php