Zend_Pdf_FileParser_Font Class Reference

Inheritance diagram for Zend_Pdf_FileParser_Font:

Public Member Functions
	__construct (Zend_Pdf_FileParserDataSource $dataSource)
	__get ($property)
	readStringUTF16 ($byteCount, $byteOrder=Zend_Pdf_FileParser::BYTE_ORDER_BIG_ENDIAN, $characterSet='')
	readStringMacRoman ($byteCount, $characterSet='')
	readStringPascal ($characterSet='', $lengthBytes=1)
	writeDebug ()
	__set ($property, $value)
Public Member Functions inherited from Zend_Pdf_FileParser
	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)

Protected Member Functions
	_debugLog ($message)

Additional Inherited Members
Data Fields inherited from Zend_Pdf_FileParser
const	BYTE_ORDER_LITTLE_ENDIAN = 0
const	BYTE_ORDER_BIG_ENDIAN = 1
Protected Attributes inherited from Zend_Pdf_FileParser
	$_isScreened = false
	$_isParsed = false
	$_dataSource = null

Detailed Description

Definition at line 42 of file Font.php.

Constructor & Destructor Documentation

__construct()

__construct

(

Zend_Pdf_FileParserDataSource

$dataSource

)

Object constructor.

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

Parameters

Zend_Pdf_FileParserDataSource

$dataSource

Exceptions

Zend_Pdf_Exception

Definition at line 75 of file Font.php.

    {
        parent::__construct($dataSource);
        $this->fontType = Zend_Pdf_Font::TYPE_UNKNOWN;
    }

Member Function Documentation

__get()

__get

(

$property

)

Get handler

Parameters

string

$property

Returns

mixed

Definition at line 90 of file Font.php.

    {
        if (isset($this->_fontProperties[$property])) {
            return $this->_fontProperties[$property];
        } else {
            return null;
        }
    }

__set()

__set	(		$property,
			$value
	)

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

string	$property
mixed	$value

Definition at line 181 of file Font.php.

    {
        if ($value === null) {
            unset($this->_fontProperties[$property]);
        } else {
            $this->_fontProperties[$property] = $value;
        }
    }

_debugLog()

_debugLog (   $message )

protected

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

string	$message
	mixed	(optional, multiple) Additional arguments

Definition at line 202 of file Font.php.

    {
        if (! $this->_debug) {
            return;
        }
        if (func_num_args() > 1) {
            $args = func_get_args();
            $message = array_shift($args);
            $message = vsprintf($message, $args);
        }

        #require_once 'Zend/Log.php';
        $logger = new Zend_Log();
        $logger->log($message, Zend_Log::DEBUG);
    }

readStringMacRoman()

readStringMacRoman	(		$byteCount,
			$characterSet = ''
	)

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

integer	$byteCount	Number of bytes (characters) to return.
string	$characterSet	(optional) –Ignored–

Returns

string

Exceptions

Zend_Pdf_Exception

Definition at line 134 of file Font.php.

    {
        return parent::readStringMacRoman($byteCount, 'UTF-16BE');
    }

readStringPascal()

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

Reads the Pascal string from the binary file at the current offset location. Overridden to fix return character set at UTF-16BE.

Parameters

string	$characterSet	(optional) –Ignored–
integer	$lengthBytes	(optional) Number of bytes that make up the length. Default is 1.

Returns

string

Exceptions

Zend_Pdf_Exception

Definition at line 149 of file Font.php.

    {
        return parent::readStringPascal('UTF-16BE');
    }

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 offset location. Overridden to fix return character set at UTF-16BE.

Todo:

Deal with to-dos in the parent method.

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) –Ignored–

Returns

string

Exceptions

Zend_Pdf_Exception

Definition at line 118 of file Font.php.

    {
        return parent::readStringUTF16($byteCount, $byteOrder, 'UTF-16BE');
    }

writeDebug()

writeDebug

(

)

Writes the entire font properties array to STDOUT. Used only for debugging.

Definition at line 160 of file Font.php.

    {
        print_r($this->_fontProperties);
    }

---

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

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