Zend_Pdf_Cmap_TrimmedTable Class Reference

Inheritance diagram for Zend_Pdf_Cmap_TrimmedTable:

Public Member Functions
	glyphNumbersForCharacters ($characterCodes)
	glyphNumberForCharacter ($characterCode)
	getCoveredCharacters ()
	getCoveredCharactersGlyphs ()
	__construct ($cmapData)
Public Member Functions inherited from Zend_Pdf_Cmap
	__construct ($cmapData)
	glyphNumbersForCharacters ($characterCodes)
	glyphNumberForCharacter ($characterCode)
	getCoveredCharacters ()
	getCoveredCharactersGlyphs ()

Protected Attributes
	$_startCode = 0
	$_endCode = 0
	$_glyphIndexArray = array()

Additional Inherited Members
Static Public Member Functions inherited from Zend_Pdf_Cmap
static	cmapWithTypeData ($cmapType, $cmapData)
Data Fields inherited from Zend_Pdf_Cmap
const	TYPE_BYTE_ENCODING = 0x00
const	TYPE_HIGH_BYTE_MAPPING = 0x02
const	TYPE_SEGMENT_TO_DELTA = 0x04
const	TYPE_TRIMMED_TABLE = 0x06
const	TYPE_MIXED_COVERAGE = 0x08
const	TYPE_TRIMMED_ARRAY = 0x0a
const	TYPE_SEGMENTED_COVERAGE = 0x0c
const	TYPE_BYTE_ENCODING_STATIC = 0xf1
const	TYPE_UNKNOWN = 0xff
const	MISSING_CHARACTER_GLYPH = 0x00
Protected Member Functions inherited from Zend_Pdf_Cmap
	_extractInt2 (&$data, $index)
	_extractUInt2 (&$data, $index)
	_extractUInt4 (&$data, $index)

Detailed Description

Definition at line 39 of file TrimmedTable.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$cmapData

)

Object constructor

Parses the raw binary table data. Throws an exception if the table is malformed.

Parameters

string

$cmapData

Raw binary cmap table data.

Exceptions

Zend_Pdf_Exception

Definition at line 167 of file TrimmedTable.php.

    {
        /* Sanity check: The table should be at least 9 bytes in size.
         */
        $actualLength = strlen($cmapData);
        if ($actualLength < 9) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Insufficient table data',
                                         Zend_Pdf_Exception::CMAP_TABLE_DATA_TOO_SMALL);
        }

        /* Sanity check: Make sure this is right data for this table type.
         */
        $type = $this->_extractUInt2($cmapData, 0);
        if ($type != Zend_Pdf_Cmap::TYPE_TRIMMED_TABLE) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Wrong cmap table type',
                                         Zend_Pdf_Exception::CMAP_WRONG_TABLE_TYPE);
        }

        $length = $this->_extractUInt2($cmapData, 2);
        if ($length != $actualLength) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception("Table length ($length) does not match actual length ($actualLength)",
                                         Zend_Pdf_Exception::CMAP_WRONG_TABLE_LENGTH);
        }

        /* Mapping tables should be language-independent. The font may not work
         * as expected if they are not. Unfortunately, many font files in the
         * wild incorrectly record a language ID in this field, so we can't
         * call this a failure.
         */
        $language = $this->_extractUInt2($cmapData, 4);
        if ($language != 0) {
            // Record a warning here somehow?
        }

        $this->_startCode = $this->_extractUInt2($cmapData, 6);

        $entryCount = $this->_extractUInt2($cmapData, 8);
        $expectedCount = ($length - 10) >> 1;
        if ($entryCount != $expectedCount) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception("Entry count is wrong; expected: $expectedCount; actual: $entryCount",
                                         Zend_Pdf_Exception::CMAP_WRONG_ENTRY_COUNT);
        }

        $this->_endCode = $this->_startCode + $entryCount - 1;

        $offset = 10;
        for ($i = 0; $i < $entryCount; $i++, $offset += 2) {
            $this->_glyphIndexArray[] = $this->_extractUInt2($cmapData, $offset);
        }

        /* Sanity check: After reading all of the data, we should be at the end
         * of the table.
         */
        if ($offset != $length) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception("Ending offset ($offset) does not match length ($length)",
                                         Zend_Pdf_Exception::CMAP_FINAL_OFFSET_NOT_LENGTH);
        }
    }

Member Function Documentation

getCoveredCharacters()

getCoveredCharacters

(

)

Returns an array containing the Unicode characters that have entries in this character map.

Returns

array Unicode character codes.

Definition at line 124 of file TrimmedTable.php.

    {
        $characterCodes = array();
        for ($code = $this->_startCode; $code <= $this->_endCode; $code++) {
            $characterCodes[] = $code;
        }
        return $characterCodes;
    }

getCoveredCharactersGlyphs()

getCoveredCharactersGlyphs

(

)

Returns an array containing the glyphs numbers that have entries in this character map. Keys are Unicode character codes (integers)

This functionality is partially covered by glyphNumbersForCharacters(getCoveredCharacters()) call, but this method do it in more effective way (prepare complete list instead of searching glyph for each character code).

Definition at line 145 of file TrimmedTable.php.

    {
        $glyphNumbers = array();
        for ($code = $this->_startCode; $code <= $this->_endCode; $code++) {
            $glyphNumbers[$code] = $this->_glyphIndexArray[$code - $this->_startCode];
        }

        return $glyphNumbers;
    }

glyphNumberForCharacter()

glyphNumberForCharacter

(

$characterCode

)

Returns the glyph number corresponding to the Unicode character.

If a particular character doesn't exist in this font, the special 'missing character glyph' will be substituted.

See also glyphNumbersForCharacters() which is optimized for bulk operations.

Parameters

integer

$characterCode

Unicode character code (code point).

Returns

integer Glyph number.

Definition at line 109 of file TrimmedTable.php.

    {
        if (($characterCode < $this->_startCode) || ($characterCode > $this->_endCode)) {
            return Zend_Pdf_Cmap::MISSING_CHARACTER_GLYPH;
        }
        $glyphIndex = $characterCode - $this->_startCode;
        return $this->_glyphIndexArray[$glyphIndex];
    }

glyphNumbersForCharacters()

glyphNumbersForCharacters

(

$characterCodes

)

Returns an array of glyph numbers corresponding to the Unicode characters.

If a particular character doesn't exist in this font, the special 'missing character glyph' will be substituted.

See also glyphNumberForCharacter().

Parameters

array

$characterCodes

Array of Unicode character codes (code points).

Returns

array Array of glyph numbers.

Definition at line 80 of file TrimmedTable.php.

    {
        $glyphNumbers = array();
        foreach ($characterCodes as $key => $characterCode) {

            if (($characterCode < $this->_startCode) || ($characterCode > $this->_endCode)) {
                $glyphNumbers[$key] = Zend_Pdf_Cmap::MISSING_CHARACTER_GLYPH;
                continue;
            }

            $glyphIndex = $characterCode - $this->_startCode;
            $glyphNumbers[$key] = $this->_glyphIndexArray[$glyphIndex];

        }
        return $glyphNumbers;
    }

Field Documentation

$_endCode

$_endCode = 0

protected

Definition at line 54 of file TrimmedTable.php.

$_glyphIndexArray

$_glyphIndexArray = array()

protected

Definition at line 60 of file TrimmedTable.php.

$_startCode

$_startCode = 0

protected

Definition at line 48 of file TrimmedTable.php.

---

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

• vendor/magento/zendframework1/library/Zend/Pdf/Cmap/TrimmedTable.php