Zend_Pdf_Resource_Font_CidFont Class Reference

Inheritance diagram for Zend_Pdf_Resource_Font_CidFont:

Public Member Functions
	__construct (Zend_Pdf_FileParser_Font_OpenType $fontParser)
	glyphNumbersForCharacters ($characterCodes)
	glyphNumberForCharacter ($characterCode)
	getCoveredPercentage ($string, $charEncoding='')
	widthsForChars ($charCodes)
	widthForChar ($charCode)
	widthsForGlyphs ($glyphNumbers)
	widthForGlyph ($glyphNumber)
	encodeString ($string, $charEncoding)
	decodeString ($string, $charEncoding)
Public Member Functions inherited from Zend_Pdf_Resource_Font
	__construct ()
	__toString ()
	getFontType ()
	getFontName ($nameType, $language, $characterSet=null)
	getFontNames ()
	isBold ()
	isItalic ()
	isMonospace ()
	getUnderlinePosition ()
	getUnderlineThickness ()
	getStrikePosition ()
	getStrikeThickness ()
	getUnitsPerEm ()
	getAscent ()
	getDescent ()
	getLineGap ()
	getLineHeight ()
	glyphNumbersForCharacters ($characterCodes)
	glyphNumberForCharacter ($characterCode)
	getCoveredPercentage ($string, $charEncoding='')
	widthsForGlyphs ($glyphNumbers)
	widthForGlyph ($glyphNumber)
	encodeString ($string, $charEncoding)
	decodeString ($string, $charEncoding)
	toEmSpace ($value)
Public Member Functions inherited from Zend_Pdf_Resource
	__construct ($resource)
	__clone ()
	cloneResource ($factory, &$processed)
	getResource ()
	getFactory ()

Protected Attributes
	$_cmap = null
	$_charWidths = null
	$_missingCharWidth = 0
Protected Attributes inherited from Zend_Pdf_Resource_Font
	$_fontType = Zend_Pdf_Font::TYPE_UNKNOWN
	$_fontNames = array()
	$_isBold = false
	$_isItalic = false
	$_isMonospace = false
	$_underlinePosition = 0
	$_underlineThickness = 0
	$_strikePosition = 0
	$_strikeThickness = 0
	$_unitsPerEm = 0
	$_ascent = 0
	$_descent = 0
	$_lineGap = 0
Protected Attributes inherited from Zend_Pdf_Resource
	$_objectFactory
	$_resource

Detailed Description

Definition at line 57 of file CidFont.php.

Constructor & Destructor Documentation

__construct()

__construct

(

Zend_Pdf_FileParser_Font_OpenType

$fontParser

)

Object constructor

Parameters

Zend_Pdf_FileParser_Font_OpenType	$fontParser	Font parser object containing OpenType file.
integer	$embeddingOptions	Options for font embedding.

Exceptions

Zend_Pdf_Exception

Prepare widths array.

Definition at line 88 of file CidFont.php.

    {
        parent::__construct();

        $fontParser->parse();


        /* Object properties */

        $this->_fontNames = $fontParser->names;

        $this->_isBold       = $fontParser->isBold;
        $this->_isItalic     = $fontParser->isItalic;
        $this->_isMonospaced = $fontParser->isMonospaced;

        $this->_underlinePosition  = $fontParser->underlinePosition;
        $this->_underlineThickness = $fontParser->underlineThickness;
        $this->_strikePosition     = $fontParser->strikePosition;
        $this->_strikeThickness    = $fontParser->strikeThickness;

        $this->_unitsPerEm = $fontParser->unitsPerEm;

        $this->_ascent  = $fontParser->ascent;
        $this->_descent = $fontParser->descent;
        $this->_lineGap = $fontParser->lineGap;


        $this->_cmap = $fontParser->cmap;


        /* Resource dictionary */

        $baseFont = $this->getFontName(Zend_Pdf_Font::NAME_POSTSCRIPT, 'en', 'UTF-8');
        $this->_resource->BaseFont = new Zend_Pdf_Element_Name($baseFont);


        /* Constract characters widths array using font CMap and glyphs widths array */
        $glyphWidths = $fontParser->glyphWidths;
        $charGlyphs  = $this->_cmap->getCoveredCharactersGlyphs();
        $charWidths  = array();
        foreach ($charGlyphs as $charCode => $glyph) {
            if(isset($glyphWidths[$glyph]) && !is_null($glyphWidths[$glyph])) {
                $charWidths[$charCode] = $glyphWidths[$glyph];
            }
        }
        $this->_charWidths       = $charWidths;
        $this->_missingCharWidth = $glyphWidths[0];

        /* Width array optimization. Step1: extract default value */
        $widthFrequencies = array_count_values($charWidths);
        $defaultWidth          = null;
        $defaultWidthFrequency = -1;
        foreach ($widthFrequencies as $width => $frequency) {
            if ($frequency > $defaultWidthFrequency) {
                $defaultWidth          = $width;
                $defaultWidthFrequency = $frequency;
            }
        }

        // Store default value in the font dictionary
        $this->_resource->DW = new Zend_Pdf_Element_Numeric($this->toEmSpace($defaultWidth));

        // Remove characters which corresponds to default width from the widths array
        $defWidthChars = array_keys($charWidths, $defaultWidth);
        foreach ($defWidthChars as $charCode) {
            unset($charWidths[$charCode]);
        }

        // Order cheracter widths aray by character codes
        ksort($charWidths, SORT_NUMERIC);

        /* Width array optimization. Step2: Compact character codes sequences */
        $lastCharCode = -1;
        $widthsSequences = array();
        foreach ($charWidths as $charCode => $width) {
            if ($lastCharCode == -1) {
                $charCodesSequense = array();
                $sequenceStartCode = $charCode;
            } else if ($charCode != $lastCharCode + 1) {
                // New chracters sequence detected
                $widthsSequences[$sequenceStartCode] = $charCodesSequense;
                $charCodesSequense = array();
                $sequenceStartCode = $charCode;
            }
            $charCodesSequense[] = $width;
            $lastCharCode = $charCode;
        }
        // Save last sequence, if widths array is not empty (it may happens for monospaced fonts)
        if (count($charWidths) != 0) {
            $widthsSequences[$sequenceStartCode] = $charCodesSequense;
        }

        $pdfCharsWidths = array();
        foreach ($widthsSequences as $startCode => $widthsSequence) {
            /* Width array optimization. Step3: Compact widths sequences */
            $pdfWidths        = array();
            $lastWidth        = -1;
            $widthsInSequence = 0;
            foreach ($widthsSequence as $width) {
                if ($lastWidth != $width) {
                    // New width is detected
                    if ($widthsInSequence != 0) {
                        // Previous width value was a part of the widths sequence. Save it as 'c_1st c_last w'.
                        $pdfCharsWidths[] = new Zend_Pdf_Element_Numeric($startCode);                         // First character code
                        $pdfCharsWidths[] = new Zend_Pdf_Element_Numeric($startCode + $widthsInSequence - 1); // Last character code
                        $pdfCharsWidths[] = new Zend_Pdf_Element_Numeric($this->toEmSpace($lastWidth));       // Width

                        // Reset widths sequence
                        $startCode = $startCode + $widthsInSequence;
                        $widthsInSequence = 0;
                    }

                    // Collect new width
                    $pdfWidths[] = new Zend_Pdf_Element_Numeric($this->toEmSpace($width));

                    $lastWidth = $width;
                } else {
                    // Width is equal to previous
                    if (count($pdfWidths) != 0) {
                        // We already have some widths collected
                        // So, we've just detected new widths sequence

                        // Remove last element from widths list, since it's a part of widths sequence
                        array_pop($pdfWidths);

                        // and write the rest if it's not empty
                        if (count($pdfWidths) != 0) {
                            // Save it as 'c_1st [w1 w2 ... wn]'.
                            $pdfCharsWidths[] = new Zend_Pdf_Element_Numeric($startCode); // First character code
                            $pdfCharsWidths[] = new Zend_Pdf_Element_Array($pdfWidths);   // Widths array

                            // Reset widths collection
                            $startCode += count($pdfWidths);
                            $pdfWidths = array();
                        }

                        $widthsInSequence = 2;
                    } else {
                        // Continue widths sequence
                        $widthsInSequence++;
                    }
                }
            }

            // Check if we have widths collection or widths sequence to wite it down
            if (count($pdfWidths) != 0) {
                // We have some widths collected
                // Save it as 'c_1st [w1 w2 ... wn]'.
                $pdfCharsWidths[] = new Zend_Pdf_Element_Numeric($startCode); // First character code
                $pdfCharsWidths[] = new Zend_Pdf_Element_Array($pdfWidths);   // Widths array
            } else if ($widthsInSequence != 0){
                // We have widths sequence
                // Save it as 'c_1st c_last w'.
                $pdfCharsWidths[] = new Zend_Pdf_Element_Numeric($startCode);                         // First character code
                $pdfCharsWidths[] = new Zend_Pdf_Element_Numeric($startCode + $widthsInSequence - 1); // Last character code
                $pdfCharsWidths[] = new Zend_Pdf_Element_Numeric($this->toEmSpace($lastWidth));       // Width
            }
        }

        /* Create the Zend_Pdf_Element_Array object and add it to the font's
         * object factory and resource dictionary.
         */
        $widthsArrayElement = new Zend_Pdf_Element_Array($pdfCharsWidths);
        $widthsObject = $this->_objectFactory->newObject($widthsArrayElement);
        $this->_resource->W = $widthsObject;


        /* CIDSystemInfo dictionary */
        $cidSystemInfo = new Zend_Pdf_Element_Dictionary();
        $cidSystemInfo->Registry   = new Zend_Pdf_Element_String('Adobe');
        $cidSystemInfo->Ordering   = new Zend_Pdf_Element_String('UCS');
        $cidSystemInfo->Supplement = new Zend_Pdf_Element_Numeric(0);
        $cidSystemInfoObject            = $this->_objectFactory->newObject($cidSystemInfo);
        $this->_resource->CIDSystemInfo = $cidSystemInfoObject;
    }

Member Function Documentation

decodeString()

decodeString	(		$string,
			$charEncoding
	)

Convert string from the font encoding.

Parameters

string	$string
string	$charEncoding	Character encoding of resulting text.

Returns

string

Exceptions

Zend_Pdf_Exception

CIDFont object is not actually a font. It does not have an Encoding entry, it cannot be listed in the Font subdictionary of a resource dictionary, and it cannot be used as the operand of the Tf operator.

Throw an exception.

Definition at line 480 of file CidFont.php.

    {
        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception('CIDFont PDF objects could not be used as the operand of the text drawing operators');
    }

encodeString()

encodeString	(		$string,
			$charEncoding
	)

Convert string to the font encoding.

Parameters

string	$string
string	$charEncoding	Character encoding of source text.

Returns

string

Exceptions

Zend_Pdf_Exception

CIDFont object is not actually a font. It does not have an Encoding entry, it cannot be listed in the Font subdictionary of a resource dictionary, and it cannot be used as the operand of the Tf operator.

Throw an exception.

Definition at line 459 of file CidFont.php.

    {
        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception('CIDFont PDF objects could not be used as the operand of the text drawing operators');
    }

getCoveredPercentage()

getCoveredPercentage	(		$string,
			$charEncoding = ''
	)

Returns a number between 0 and 1 inclusive that indicates the percentage of characters in the string which are covered by glyphs in this font.

Since no one font will contain glyphs for the entire Unicode character range, this method can be used to help locate a suitable font when the actual contents of the string are not known.

Note that some fonts lie about the characters they support. Additionally, fonts don't usually contain glyphs for control characters such as tabs and line breaks, so it is rare that you will get back a full 1.0 score. The resulting value should be considered informational only.

Parameters

string	$string
string	$charEncoding	(optional) Character encoding of source text. If omitted, uses 'current locale'.

Returns

float

Todo:

Properly handle characters encoded as surrogate pairs.

Definition at line 337 of file CidFont.php.

    {
        /* Convert the string to UTF-16BE encoding so we can match the string's
         * character codes to those found in the cmap.
         */
        if ($charEncoding != 'UTF-16BE') {
            $string = iconv($charEncoding, 'UTF-16BE', $string);
        }

        $charCount = iconv_strlen($string, 'UTF-16BE');
        if ($charCount == 0) {
            return 0;
        }

        /* Calculate the score by doing a lookup for each character.
         */
        $score = 0;
        $maxIndex = strlen($string);
        for ($i = 0; $i < $maxIndex; $i++) {
            $charCode = (ord($string[$i]) << 8) | ord($string[++$i]);
            /* This could probably be optimized a bit with a binary search...
             */
            if (isset($this->_charWidths[$charCode])) {
                $score++;
            }
        }
        return $score / $charCount;
    }

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.

CIDFont object is not actually a font. It does not have an Encoding entry, it cannot be listed in the Font subdictionary of a resource dictionary, and it cannot be used as the operand of the Tf operator.

Throw an exception.

Definition at line 305 of file CidFont.php.

    {
        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception('CIDFont PDF objects could not be used as the operand of the text drawing operators');
    }

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.

CIDFont object is not actually a font. It does not have an Encoding entry, it cannot be listed in the Font subdictionary of a resource dictionary, and it cannot be used as the operand of the Tf operator.

Throw an exception.

Definition at line 280 of file CidFont.php.

    {
        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception('CIDFont PDF objects could not be used as the operand of the text drawing operators');
    }

widthForChar()

widthForChar

(

$charCode

)

Returns the width of the character.

Like widthsForChars() but used for one char at a time.

Parameters

integer

$charCode

Returns

integer

Definition at line 401 of file CidFont.php.

    {
        if (!isset($this->_charWidths[$charCode])) {
            return $this->_missingCharWidth;
        }
        return $this->_charWidths[$charCode];
    }

widthForGlyph()

widthForGlyph

(

$glyphNumber

)

Returns the width of the glyph.

Like widthsForGlyphs() but used for one glyph at a time.

Parameters

integer

$glyphNumber

Returns

integer

Exceptions

Zend_Pdf_Exception

CIDFont object is not actually a font. It does not have an Encoding entry, it cannot be listed in the Font subdictionary of a resource dictionary, and it cannot be used as the operand of the Tf operator.

Throw an exception.

Definition at line 438 of file CidFont.php.

    {
        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception('CIDFont PDF objects could not be used as the operand of the text drawing operators');
    }

widthsForChars()

widthsForChars

(

$charCodes

)

Returns the widths of the Chars.

The widths are expressed in the font's glyph space. You are responsible for converting to user space as necessary. See unitsPerEm().

See also widthForChar().

Parameters

array

&$glyphNumbers

Array of glyph numbers.

Returns

array Array of glyph widths (integers).

Definition at line 380 of file CidFont.php.

    {
        $widths = array();
        foreach ($charCodes as $key => $charCode) {
            if (!isset($this->_charWidths[$charCode])) {
                $widths[$key] = $this->_missingCharWidth;
            } else {
                $widths[$key] = $this->_charWidths[$charCode];
            }
        }
        return $widths;
    }

widthsForGlyphs()

widthsForGlyphs

(

$glyphNumbers

)

Returns the widths of the glyphs.

Parameters

array

&$glyphNumbers

Array of glyph numbers.

Returns

array Array of glyph widths (integers).

Exceptions

Zend_Pdf_Exception

CIDFont object is not actually a font. It does not have an Encoding entry, it cannot be listed in the Font subdictionary of a resource dictionary, and it cannot be used as the operand of the Tf operator.

Throw an exception.

Definition at line 416 of file CidFont.php.

    {
        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception('CIDFont PDF objects could not be used as the operand of the text drawing operators');
    }

Field Documentation

$_charWidths

$_charWidths = null

protected

Definition at line 70 of file CidFont.php.

$_cmap

$_cmap = null

protected

Definition at line 63 of file CidFont.php.

$_missingCharWidth

$_missingCharWidth = 0

protected

Definition at line 77 of file CidFont.php.

---

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

• vendor/magento/zendframework1/library/Zend/Pdf/Resource/Font/CidFont.php