Pdf/FileParser/Image.php

Show:

inherited

Classes
- \Zend_Pdf_FileParser_Image

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Pdf
Subpackage: FileParser
Version: $Id: Image.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Pdf_FileParser_Image
jump to top

Package: Zend\Pdf\FileParser

FileParser for Zend_Pdf_Image subclasses.

Provides a library of methods to quickly navigate and extract various data types (signed and unsigned integers, floating- and fixed-point numbers, strings, etc.) from the file.

File access is managed via a Zend_Pdf_FileParserDataSource object. This allows the same parser code to work with many different data sources: in-memory objects, filesystem files, etc.

Parent(s): \Zend_Pdf_FileParser
Children: \Zend_Pdf_FileParser_Image_Png
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                BYTE_ORDER_LITTLE_ENDIAN
                = 0

inherited

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

Inherited from: \Zend_Pdf_FileParser::BYTE_ORDER_LITTLE_ENDIAN

Inherited_from: \Zend_Pdf_FileParser::BYTE_ORDER_LITTLE_ENDIAN

 
                BYTE_ORDER_BIG_ENDIAN
                = 1

inherited

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

Inherited from: \Zend_Pdf_FileParser::BYTE_ORDER_BIG_ENDIAN

Inherited_from: \Zend_Pdf_FileParser::BYTE_ORDER_BIG_ENDIAN

Properties

\Zend_Pdf_FileParserDataSource $_dataSource = null

inherited

Object representing the data source to be parsed.

Inherited from: \Zend_Pdf_FileParser::$$_dataSource

Default valuenullDetails

Type: \Zend_Pdf_FileParserDataSource
Inherited_from: \Zend_Pdf_FileParser::$$_dataSource

boolean $_isParsed = false

inherited

Flag indicating that the file has been sucessfully parsed.

Inherited from: \Zend_Pdf_FileParser::$$_isParsed

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Pdf_FileParser::$$_isParsed

boolean $_isScreened = false

inherited

Flag indicating that the file has passed a cursory validation check.

Inherited from: \Zend_Pdf_FileParser::$$_isScreened

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Pdf_FileParser::$$_isScreened

integer $imageType =

Image Type

Details

Type: integer

Methods

__construct(\Zend_Pdf_FileParserDataSource $dataSource) : void

Object constructor.

Validates the data source and enables debug logging if so configured.

Parameters

Name	Type	Description
$dataSource	\Zend_Pdf_FileParserDataSource

Throws

Exception	Description
\Zend_Pdf_Exception

__destruct() : void

inherited

Object destructor.

Inherited from: \Zend_Pdf_FileParser::__destruct()

Discards the data source object.

getDataSource() : \Zend_Pdf_FileParserDataSource

inherited

Returns the data source object representing the file being parsed.

Inherited from: \Zend_Pdf_FileParser::getDataSource()

Returns

Type	Description
\Zend_Pdf_FileParserDataSource

getOffset() : void

inherited

Inherited from: \Zend_Pdf_FileParser::getOffset()

getSize() : void

inherited

Inherited from: \Zend_Pdf_FileParser::getSize()

isBitSet(integer $bit, integer $bitField) : boolean

inherited

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

Inherited from: \Zend_Pdf_FileParser::isBitSet()

Parameters

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

Returns

Type	Description
boolean

isParsed() : boolean

inherited

Returns true if the file has been successfully parsed.

Inherited from: \Zend_Pdf_FileParser::isParsed()

Returns

Type	Description
boolean

isScreened() : boolean

inherited

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

Inherited from: \Zend_Pdf_FileParser::isScreened()

Returns

Type	Description
boolean

moveToOffset(integer $offset) : void

inherited

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

Inherited from: \Zend_Pdf_FileParser::moveToOffset()

Parameters

Name	Type	Description
$offset	integer	Destination byte offset.

Throws

Exception	Description
\Zend_Pdf_Exception

parse() : void

abstractinherited

Reads and parses the complete binary file.

Inherited from: \Zend_Pdf_FileParser::parse()

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

Throws

Exception	Description
\Zend_Pdf_Exception

readBytes(integer $byteCount) : string

inherited

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

Inherited from: \Zend_Pdf_FileParser::readBytes()

Parameters

Name	Type	Description
$byteCount	integer	Number of bytes to read.

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Pdf_Exception

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

inherited

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

Inherited from: \Zend_Pdf_FileParser::readFixed()

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

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

Returns

Type	Description
float

Throws

Exception	Description
\Zend_Pdf_Exception

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

inherited

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

Inherited from: \Zend_Pdf_FileParser::readInt()

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

Parameters

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

Returns

Type	Description
integer

Throws

Exception	Description
\Zend_Pdf_Exception

readStringMacRoman(integer $byteCount, string $characterSet = '') : string

inherited

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

Inherited from: \Zend_Pdf_FileParser::readStringMacRoman()

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

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

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Pdf_Exception

readStringPascal(string $characterSet = '', integer $lengthBytes = 1) : string

inherited

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

Inherited from: \Zend_Pdf_FileParser::readStringPascal()

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

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

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Pdf_Exception

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

inherited

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

Inherited from: \Zend_Pdf_FileParser::readStringUTF16()

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.

Parameters

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

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Pdf_Exception

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

inherited

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

Inherited from: \Zend_Pdf_FileParser::readUInt()

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

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

Returns

Type	Description
integer

Throws

Exception	Description
\Zend_Pdf_Exception

screen() : void

abstractinherited

Performs a cursory check to verify that the binary file is in the expected format.

Inherited from: \Zend_Pdf_FileParser::screen()

Intended to quickly weed out obviously bogus files.

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

Throws

Exception	Description
\Zend_Pdf_Exception

skipBytes(integer $byteCount) : void

inherited

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

Inherited from: \Zend_Pdf_FileParser::skipBytes()

Parameters

Name	Type	Description
$byteCount	integer	Number of bytes to skip.

Throws

Exception	Description
\Zend_Pdf_Exception

Pdf/FileParser/Image.php

\Zend_Pdf_FileParser_Imagejump to top

Constants

Properties

Methods

\Zend_Pdf_FileParser_Image
jump to top