Pdf/FileParser/Font.php

Show: PublicProtectedPrivateinherited
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 license@zend.com 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: Font.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Pdf_FileParser_Font

Package: Zend\Pdf\FileParser
Abstract helper class for {@link Zend_Pdf_Font} that parses font files.

Defines the public interface for concrete subclasses which are responsible for parsing the raw binary data from the font file on disk. Also provides a debug logging interface and a couple of shared utility methods.

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

Constants

>VConstant  BYTE_ORDER_LITTLE_ENDIAN = 0
inherited
Little-endian byte order (0x04 0x03 0x02 0x01).
Inherited from: \Zend_Pdf_FileParser::BYTE_ORDER_LITTLE_ENDIAN
>VConstant  BYTE_ORDER_BIG_ENDIAN = 1
inherited
Big-endian byte order (0x01 0x02 0x03 0x04).
Inherited from: \Zend_Pdf_FileParser::BYTE_ORDER_BIG_ENDIAN

Properties

>VPropertyprotected\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  
>VPropertyprivateboolean $_debug = false
Flag indicating whether or not debug logging is active.
Default valuefalseDetails
Type
boolean
>VPropertyprivatearray $_fontProperties = array()
Array of parsed font properties.

Used with __get() and __set().

Default valuearray()Details
Type
array
>VPropertyprotectedboolean $_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  
>VPropertyprotectedboolean $_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  

Methods

methodpublic__construct(\Zend_Pdf_FileParserDataSource $dataSource) : void

Object constructor.

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

Parameters
NameTypeDescription
$dataSource\Zend_Pdf_FileParserDataSource
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpublic__destruct() : void
inherited

Object destructor.

Inherited from: \Zend_Pdf_FileParser::__destruct()

Discards the data source object.

methodpublic__get(string $property) : mixed

Get handler

Parameters
NameTypeDescription
$propertystring
Returns
TypeDescription
mixed
methodpublic__set(string $property, mixed $value) : void

Set handler

NOTE: This method is protected. Other classes may freely interrogate the font properties, but only this and its subclasses may set them.

Parameters
NameTypeDescription
$propertystring
$valuemixed
methodprotected_debugLog(string $message) : void

If debug logging is enabled, writes the log message.

The log message is a sprintf() style string and any number of arguments may accompany it as additional parameters.

Parameters
NameTypeDescription
$messagestring
methodpublicgetDataSource() : \Zend_Pdf_FileParserDataSource
inherited

Returns the data source object representing the file being parsed.

Inherited from: \Zend_Pdf_FileParser::getDataSource()
Returns
TypeDescription
\Zend_Pdf_FileParserDataSource
methodpublicgetOffset() : void
inherited

Inherited from: \Zend_Pdf_FileParser::getOffset()
methodpublicgetSize() : void
inherited

Inherited from: \Zend_Pdf_FileParser::getSize()
methodpublicisBitSet(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
NameTypeDescription
$bitinteger

Bit number to test (i.e. - 0-31)

$bitFieldinteger
Returns
TypeDescription
boolean
methodpublicisParsed() : boolean
inherited

Returns true if the file has been successfully parsed.

Inherited from: \Zend_Pdf_FileParser::isParsed()
Returns
TypeDescription
boolean
methodpublicisScreened() : boolean
inherited

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

Inherited from: \Zend_Pdf_FileParser::isScreened()
Returns
TypeDescription
boolean
methodpublicmoveToOffset(integer $offset) : void
inherited

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

Inherited from: \Zend_Pdf_FileParser::moveToOffset()
Parameters
NameTypeDescription
$offsetinteger

Destination byte offset.

Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpublicparse() : void
abstractinherited

Reads and parses the complete binary file.

Inherited from: \Zend_Pdf_FileParser::parse()

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

Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpublicreadBytes(integer $byteCount) : string
inherited

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

Inherited from: \Zend_Pdf_FileParser::readBytes()
Parameters
NameTypeDescription
$byteCountinteger

Number of bytes to read.

Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpublicreadFixed(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
NameTypeDescription
$mantissaBitsinteger

Number of bits in the mantissa

$fractionBitsinteger

Number of bits in the fraction

$byteOrderinteger

(optional) Big- or little-endian byte order. Use the BYTE_ORDER_ constants defined in {@link Zend_Pdf_FileParser}. If omitted, uses big-endian.

Returns
TypeDescription
float
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpublicreadInt(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
NameTypeDescription
$sizeinteger

Size of integer in bytes: 1-4

$byteOrderinteger

(optional) Big- or little-endian byte order. Use the BYTE_ORDER_ constants defined in {@link Zend_Pdf_FileParser}. If omitted, uses big-endian.

Returns
TypeDescription
integer
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpublicreadStringMacRoman(integer $byteCount, string $characterSet = '') : string

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

Overridden to fix return character set at UTF-16BE.

Parameters
NameTypeDescription
$byteCountinteger

Number of bytes (characters) to return.

$characterSetstring

(optional) --Ignored--

Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpublicreadStringPascal(string $characterSet = '', integer $lengthBytes = 1) : string

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

Overridden to fix return character set at UTF-16BE.

Parameters
NameTypeDescription
$characterSetstring

(optional) --Ignored--

$lengthBytesinteger

(optional) Number of bytes that make up the length. Default is 1.

Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpublicreadStringUTF16(integer $byteCount, integer $byteOrder = \Zend_Pdf_FileParser::BYTE_ORDER_BIG_ENDIAN, string $characterSet = '') : string

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

Overridden to fix return character set at UTF-16BE.

Parameters
NameTypeDescription
$byteCountinteger

Number of bytes (characters * 2) to return.

$byteOrderinteger

(optional) Big- or little-endian byte order. Use the BYTE_ORDER_ constants defined in {@link Zend_Pdf_FileParser}. If omitted, uses big-endian.

$characterSetstring

(optional) --Ignored--

Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Pdf_Exception
Details
Todo
Deal with to-dos in the parent method.  
methodpublicreadUInt(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
NameTypeDescription
$sizeinteger

Size of integer in bytes: 1-4

$byteOrderinteger

(optional) Big- or little-endian byte order. Use the BYTE_ORDER_ constants defined in {@link Zend_Pdf_FileParser}. If omitted, uses big-endian.

Returns
TypeDescription
integer
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpublicscreen() : 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
ExceptionDescription
\Zend_Pdf_Exception
methodpublicskipBytes(integer $byteCount) : void
inherited

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

Inherited from: \Zend_Pdf_FileParser::skipBytes()
Parameters
NameTypeDescription
$byteCountinteger

Number of bytes to skip.

Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpublicwriteDebug() : void

Writes the entire font properties array to STDOUT.

Used only for debugging.

Documentation was generated by phpDocumentor 2.0.0a12.