Zend_Pdf_FileParser Class Reference

Inheritance diagram for Zend_Pdf_FileParser:

Public Member Functions
	screen ()
	parse ()
	__construct (Zend_Pdf_FileParserDataSource $dataSource)
	__destruct ()
	isScreened ()
	isParsed ()
	getDataSource ()
	moveToOffset ($offset)
	getOffset ()
	getSize ()
	readBytes ($byteCount)
	skipBytes ($byteCount)
	readInt ($size, $byteOrder=Zend_Pdf_FileParser::BYTE_ORDER_BIG_ENDIAN)
	readUInt ($size, $byteOrder=Zend_Pdf_FileParser::BYTE_ORDER_BIG_ENDIAN)
	isBitSet ($bit, $bitField)
	readFixed ($mantissaBits, $fractionBits, $byteOrder=Zend_Pdf_FileParser::BYTE_ORDER_BIG_ENDIAN)
	readStringUTF16 ($byteCount, $byteOrder=Zend_Pdf_FileParser::BYTE_ORDER_BIG_ENDIAN, $characterSet='')
	readStringMacRoman ($byteCount, $characterSet='')
	readStringPascal ($characterSet='', $lengthBytes=1)

Data Fields
const	BYTE_ORDER_LITTLE_ENDIAN = 0
const	BYTE_ORDER_BIG_ENDIAN = 1

Protected Attributes
	$_isScreened = false
	$_isParsed = false
	$_dataSource = null

Detailed Description

Definition at line 39 of file FileParser.php.

Constructor & Destructor Documentation

__construct()

__construct

(

Zend_Pdf_FileParserDataSource

$dataSource

)

Object constructor.

Verifies that the data source has been properly initialized.

Parameters

Zend_Pdf_FileParserDataSource

$dataSource

Exceptions

Zend_Pdf_Exception

Definition at line 113 of file FileParser.php.

    {
        if ($dataSource->getSize() == 0) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('The data source has not been properly initialized',
                                         Zend_Pdf_Exception::BAD_DATA_SOURCE);
        }
        $this->_dataSource = $dataSource;
    }

__destruct()

__destruct

(

)

Object destructor.

Discards the data source object.

Definition at line 128 of file FileParser.php.

    {
        $this->_dataSource = null;
    }

Member Function Documentation

getDataSource()

getDataSource

(

)

Returns the data source object representing the file being parsed.

Returns

Zend_Pdf_FileParserDataSource

Definition at line 161 of file FileParser.php.

    {
        return $this->_dataSource;
    }

getOffset()

getOffset

(

)

Definition at line 180 of file FileParser.php.

                                {
       return $this->_dataSource->getOffset();
    }

getSize()

getSize

(

)

Definition at line 184 of file FileParser.php.

                              {
       return $this->_dataSource->getSize();
    }

isBitSet()

isBitSet	(		$bit,
			$bitField
	)

Returns true if the specified bit is set in the integer bitfield.

Parameters

integer	$bit	Bit number to test (i.e. - 0-31)
integer	$bitField

Returns

boolean

Definition at line 339 of file FileParser.php.

    {
        $bitMask = 1 << $bit;
        $isSet = (($bitField & $bitMask) == $bitMask);
        return $isSet;
    }

isParsed()

isParsed

(

)

Returns true if the file has been successfully parsed.

Returns

boolean

Definition at line 151 of file FileParser.php.

    {
        return $this->_isParsed;
    }

isScreened()

isScreened

(

)

Returns true if the file has passed a cursory validation check.

Returns

boolean

Definition at line 141 of file FileParser.php.

    {
        return $this->_isScreened;
    }

moveToOffset()

moveToOffset

(

$offset

)

Convenience wrapper for the data source object's moveToOffset() method.

Parameters

integer

$offset

Destination byte offset.

Exceptions

Zend_Pdf_Exception

Definition at line 175 of file FileParser.php.

    {
        $this->_dataSource->moveToOffset($offset);
    }

parse()

parse ( )

abstract

Reads and parses the complete binary file.

Must set $this->_isParsed to true if successful.

Exceptions

Zend_Pdf_Exception

readBytes()

readBytes

(

$byteCount

)

Convenience wrapper for the data source object's readBytes() method.

Parameters

integer

$byteCount

Number of bytes to read.

Returns

string

Exceptions

Zend_Pdf_Exception

Definition at line 195 of file FileParser.php.

    {
        return $this->_dataSource->readBytes($byteCount);
    }

readFixed()

readFixed	(		$mantissaBits,
			$fractionBits,
			$byteOrder = Zend_Pdf_FileParser::BYTE_ORDER_BIG_ENDIAN
	)

Reads the signed fixed-point number from the binary file at the current byte offset.

Common fixed-point sizes are 2.14 and 16.16.

Advances the offset by the number of bytes read. Throws an exception if an error occurs.

Parameters

integer	$mantissaBits	Number of bits in the mantissa
integer	$fractionBits	Number of bits in the fraction
integer	$byteOrder	(optional) Big- or little-endian byte order. Use the BYTE_ORDER_ constants defined in Zend_Pdf_FileParser. If omitted, uses big-endian.

Returns

float

Exceptions

Zend_Pdf_Exception

Definition at line 363 of file FileParser.php.

    {
        $bitsToRead = $mantissaBits + $fractionBits;
        if (($bitsToRead % 8) !== 0) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Fixed-point numbers are whole bytes',
                                         Zend_Pdf_Exception::BAD_FIXED_POINT_SIZE);
        }
        $number = $this->readInt(($bitsToRead >> 3), $byteOrder) / (1 << $fractionBits);
        return $number;
    }

readInt()

readInt	(		$size,
			$byteOrder = Zend_Pdf_FileParser::BYTE_ORDER_BIG_ENDIAN
	)

Reads the signed integer value from the binary file at the current byte offset.

Advances the offset by the number of bytes read. Throws an exception if an error occurs.

Parameters

integer	$size	Size of integer in bytes: 1-4
integer	$byteOrder	(optional) Big- or little-endian byte order. Use the BYTE_ORDER_ constants defined in Zend_Pdf_FileParser. If omitted, uses big-endian.

Returns

integer

Exceptions

Zend_Pdf_Exception

Definition at line 228 of file FileParser.php.

    {
        if (($size < 1) || ($size > 4)) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception("Invalid signed integer size: $size",
                                         Zend_Pdf_Exception::INVALID_INTEGER_SIZE);
        }
        $bytes = $this->_dataSource->readBytes($size);
        /* unpack() will not work for this method because it always works in
         * the host byte order for signed integers. It also does not allow for
         * variable integer sizes.
         */
        if ($byteOrder == Zend_Pdf_FileParser::BYTE_ORDER_BIG_ENDIAN) {
            $number = ord($bytes[0]);
            if (($number & 0x80) == 0x80) {
                /* This number is negative. Extract the positive equivalent.
                 */
                $number = (~ $number) & 0xff;
                for ($i = 1; $i < $size; $i++) {
                    $number = ($number << 8) | ((~ ord($bytes[$i])) & 0xff);
                }
                /* Now turn this back into a negative number by taking the
                 * two's complement (we didn't add one above so won't
                 * subtract it below). This works reliably on both 32- and
                 * 64-bit systems.
                 */
                $number = ~$number;
            } else {
                for ($i = 1; $i < $size; $i++) {
                    $number = ($number << 8) | ord($bytes[$i]);
                }
            }
        } else if ($byteOrder == Zend_Pdf_FileParser::BYTE_ORDER_LITTLE_ENDIAN) {
            $number = ord($bytes[$size - 1]);
            if (($number & 0x80) == 0x80) {
                /* Negative number. See discussion above.
                 */
                $number = 0;
                for ($i = --$size; $i >= 0; $i--) {
                    $number |= ((~ ord($bytes[$i])) & 0xff) << ($i * 8);
                }
                $number = ~$number;
            } else {
                $number = 0;
                for ($i = --$size; $i >= 0; $i--) {
                    $number |= ord($bytes[$i]) << ($i * 8);
                }
            }
        } else {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception("Invalid byte order: $byteOrder",
                                         Zend_Pdf_Exception::INVALID_BYTE_ORDER);
        }
        return $number;
    }

readStringMacRoman()

readStringMacRoman	(		$byteCount,
			$characterSet = ''
	)

Reads the Mac Roman-encoded string from the binary file at the current byte offset.

You must supply the desired resulting character set.

Advances the offset by the number of bytes read. Throws an exception if an error occurs.

Parameters

integer	$byteCount	Number of bytes (characters) to return.
string	$characterSet	(optional) Desired resulting character set. You may use any character set supported by iconv(). If omitted, uses 'current locale'.

Returns

string

Exceptions

Zend_Pdf_Exception

Definition at line 442 of file FileParser.php.

    {
        if ($byteCount == 0) {
            return '';
        }
        $bytes = $this->_dataSource->readBytes($byteCount);
        if ($characterSet == 'MacRoman') {
            return $bytes;
        }
        return iconv('MacRoman', $characterSet, $bytes);
    }

readStringPascal()

readStringPascal	(		$characterSet = '',
			$lengthBytes = 1
	)

Reads the Pascal string from the binary file at the current byte offset.

The length of the Pascal string is determined by reading the length bytes which preceed the character data. You must supply the desired resulting character set.

Advances the offset by the number of bytes read. Throws an exception if an error occurs.

Parameters

string	$characterSet	(optional) Desired resulting character set. You may use any character set supported by iconv(). If omitted, uses 'current locale'.
integer	$lengthBytes	(optional) Number of bytes that make up the length. Default is 1.

Returns

string

Exceptions

Zend_Pdf_Exception

Definition at line 472 of file FileParser.php.

    {
        $byteCount = $this->readUInt($lengthBytes);
        if ($byteCount == 0) {
            return '';
        }
        $bytes = $this->_dataSource->readBytes($byteCount);
        if ($characterSet == 'ASCII') {
            return $bytes;
        }
        return iconv('ASCII', $characterSet, $bytes);
    }

readStringUTF16()

readStringUTF16	(		$byteCount,
			$byteOrder = Zend_Pdf_FileParser::BYTE_ORDER_BIG_ENDIAN,
			$characterSet = ''
	)

Reads the Unicode UTF-16-encoded string from the binary file at the current byte offset.

The byte order of the UTF-16 string must be specified. You must also supply the desired resulting character set.

Advances the offset by the number of bytes read. Throws an exception if an error occurs.

Todo:

Consider changing $byteCount to a character count. They are not always equivalent (in the case of surrogates).

Make $byteOrder optional if there is a byte-order mark (BOM) in the string being extracted.

Parameters

integer	$byteCount	Number of bytes (characters * 2) to return.
integer	$byteOrder	(optional) Big- or little-endian byte order. Use the BYTE_ORDER_ constants defined in Zend_Pdf_FileParser. If omitted, uses big-endian.
string	$characterSet	(optional) Desired resulting character set. You may use any character set supported by iconv(). If omitted, uses 'current locale'.

Returns

string

Exceptions

Zend_Pdf_Exception

Definition at line 401 of file FileParser.php.

    {
        if ($byteCount == 0) {
            return '';
        }
        $bytes = $this->_dataSource->readBytes($byteCount);
        if ($byteOrder == Zend_Pdf_FileParser::BYTE_ORDER_BIG_ENDIAN) {
            if ($characterSet == 'UTF-16BE') {
                return $bytes;
            }
            return iconv('UTF-16BE', $characterSet, $bytes);
        } else if ($byteOrder == Zend_Pdf_FileParser::BYTE_ORDER_LITTLE_ENDIAN) {
            if ($characterSet == 'UTF-16LE') {
                return $bytes;
            }
            return iconv('UTF-16LE', $characterSet, $bytes);
        } else {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception("Invalid byte order: $byteOrder",
                                         Zend_Pdf_Exception::INVALID_BYTE_ORDER);
        }
    }

readUInt()

readUInt	(		$size,
			$byteOrder = Zend_Pdf_FileParser::BYTE_ORDER_BIG_ENDIAN
	)

Reads the unsigned integer value from the binary file at the current byte offset.

Advances the offset by the number of bytes read. Throws an exception if an error occurs.

NOTE: If you ask for a 4-byte unsigned integer on a 32-bit machine, the resulting value WILL BE SIGNED because PHP uses signed integers internally for everything. To guarantee portability, be sure to use bitwise operators operators on large unsigned integers!

Parameters

integer	$size	Size of integer in bytes: 1-4
integer	$byteOrder	(optional) Big- or little-endian byte order. Use the BYTE_ORDER_ constants defined in Zend_Pdf_FileParser. If omitted, uses big-endian.

Returns

integer

Exceptions

Zend_Pdf_Exception

Definition at line 303 of file FileParser.php.

    {
        if (($size < 1) || ($size > 4)) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception("Invalid unsigned integer size: $size",
                                         Zend_Pdf_Exception::INVALID_INTEGER_SIZE);
        }
        $bytes = $this->_dataSource->readBytes($size);
        /* unpack() is a bit heavyweight for this simple conversion. Just
         * work the bytes directly.
         */
        if ($byteOrder == Zend_Pdf_FileParser::BYTE_ORDER_BIG_ENDIAN) {
            $number = ord($bytes[0]);
            for ($i = 1; $i < $size; $i++) {
                $number = ($number << 8) | ord($bytes[$i]);
            }
        } else if ($byteOrder == Zend_Pdf_FileParser::BYTE_ORDER_LITTLE_ENDIAN) {
            $number = 0;
            for ($i = --$size; $i >= 0; $i--) {
                $number |= ord($bytes[$i]) << ($i * 8);
            }
        } else {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception("Invalid byte order: $byteOrder",
                                         Zend_Pdf_Exception::INVALID_BYTE_ORDER);
        }
        return $number;
    }

screen()

screen ( )

abstract

Performs a cursory check to verify that the binary file is in the expected format. Intended to quickly weed out obviously bogus files.

Must set $this->_isScreened to true if successful.

Exceptions

Zend_Pdf_Exception

skipBytes()

skipBytes

(

$byteCount

)

Convenience wrapper for the data source object's skipBytes() method.

Parameters

integer

$byteCount

Number of bytes to skip.

Exceptions

Zend_Pdf_Exception

Definition at line 206 of file FileParser.php.

    {
        $this->_dataSource->skipBytes($byteCount);
    }

Field Documentation

$_dataSource

$_dataSource = null

protected

Definition at line 74 of file FileParser.php.

$_isParsed

$_isParsed = false

protected

Definition at line 68 of file FileParser.php.

$_isScreened

$_isScreened = false

protected

Definition at line 62 of file FileParser.php.

BYTE_ORDER_BIG_ENDIAN

const BYTE_ORDER_BIG_ENDIAN = 1

Big-endian byte order (0x01 0x02 0x03 0x04).

Definition at line 51 of file FileParser.php.

BYTE_ORDER_LITTLE_ENDIAN

const BYTE_ORDER_LITTLE_ENDIAN = 0

Little-endian byte order (0x04 0x03 0x02 0x01).

Definition at line 46 of file FileParser.php.

---

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

• vendor/magento/zendframework1/library/Zend/Pdf/FileParser.php