Zend_Pdf_Resource_Font_Extracted Class Reference

Inheritance diagram for Zend_Pdf_Resource_Font_Extracted:

Public Member Functions
	__construct ($fontDictionary)
	glyphNumbersForCharacters ($characterCodes)
	glyphNumberForCharacter ($characterCode)
	getCoveredPercentage ($string, $charEncoding='')
	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 ()

Data Fields
const	TYPE_NOT_SUPPORTED = 'Unsupported font type.'
const	ENCODING_NOT_SUPPORTED = 'Font encoding is not supported'
const	OPERATION_NOT_SUPPORTED = 'Operation is not supported for extracted fonts'

Protected Attributes
	$_encoding = null
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 38 of file Extracted.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$fontDictionary

)

Object constructor

$fontDictionary is a Zend_Pdf_Element_Reference or Zend_Pdf_Element_Object object

Parameters

mixed

$fontDictionary

Exceptions

Zend_Pdf_Exception

Definition at line 64 of file Extracted.php.

    {
        // Extract object factory and resource object from font dirctionary object
        $this->_objectFactory = $fontDictionary->getFactory();
        $this->_resource      = $fontDictionary;

        if ($fontDictionary->Encoding !== null) {
            $this->_encoding = $fontDictionary->Encoding->value;
        }

        switch ($fontDictionary->Subtype->value) {
            case 'Type0':
                // Composite type 0 font
                if (count($fontDictionary->DescendantFonts->items) != 1) {
                    // Multiple descendant fonts are not supported
                    #require_once 'Zend/Pdf/Exception.php';
                    throw new Zend_Pdf_Exception(self::TYPE_NOT_SUPPORTED);
                }

                $fontDictionaryIterator = $fontDictionary->DescendantFonts->items->getIterator();
                $fontDictionaryIterator->rewind();
                $descendantFont = $fontDictionaryIterator->current();
                $fontDescriptor = $descendantFont->FontDescriptor;
                break;

            case 'Type1':
                if ($fontDictionary->FontDescriptor === null) {
                    // That's one of the standard fonts
                    $standardFont = Zend_Pdf_Font::fontWithName($fontDictionary->BaseFont->value);

                    $this->_fontNames          = $standardFont->getFontNames();
                    $this->_isBold             = $standardFont->isBold();
                    $this->_isItalic           = $standardFont->isItalic();
                    $this->_isMonospace        = $standardFont->isMonospace();
                    $this->_underlinePosition  = $standardFont->getUnderlinePosition();
                    $this->_underlineThickness = $standardFont->getUnderlineThickness();
                    $this->_strikePosition     = $standardFont->getStrikePosition();
                    $this->_strikeThickness    = $standardFont->getStrikeThickness();
                    $this->_unitsPerEm         = $standardFont->getUnitsPerEm();
                    $this->_ascent             = $standardFont->getAscent();
                    $this->_descent            = $standardFont->getDescent();
                    $this->_lineGap            = $standardFont->getLineGap();

                    return;
                }

                $fontDescriptor = $fontDictionary->FontDescriptor;
                break;

            case 'TrueType':
                $fontDescriptor = $fontDictionary->FontDescriptor;
                break;

            default:
                #require_once 'Zend/Pdf/Exception.php';
                throw new Zend_Pdf_Exception(self::TYPE_NOT_SUPPORTED);
        }

        $this->_fontNames[Zend_Pdf_Font::NAME_POSTSCRIPT]['en'] = iconv('UTF-8', 'UTF-16BE', $fontDictionary->BaseFont->value);

        $this->_isBold             = false; // this property is actually not used anywhere
        $this->_isItalic           = ( ($fontDescriptor->Flags->value & (1 << 6)) != 0 ); // Bit-7 is set
        $this->_isMonospace        = ( ($fontDescriptor->Flags->value & (1 << 0)) != 0 ); // Bit-1 is set
        $this->_underlinePosition  = null; // Can't be extracted
        $this->_underlineThickness = null; // Can't be extracted
        $this->_strikePosition     = null; // Can't be extracted
        $this->_strikeThickness    = null; // Can't be extracted
        $this->_unitsPerEm         = null; // Can't be extracted
        $this->_ascent             = $fontDescriptor->Ascent->value;
        $this->_descent            = $fontDescriptor->Descent->value;
        $this->_lineGap            = null; // Can't be extracted
    }

Member Function Documentation

decodeString()

decodeString	(		$string,
			$charEncoding
	)

Convert string from the font encoding.

The method is used to convert strings retrieved from existing content streams

Parameters

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

Returns

string

Definition at line 261 of file Extracted.php.

    {
        if ($this->_encoding == 'Identity-H') {
            return iconv('UTF-16BE', $charEncoding, $string);
        }

        if ($this->_encoding == 'WinAnsiEncoding') {
            return iconv('CP1252', $charEncoding, $string);
        }

        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception(self::ENCODING_NOT_SUPPORTED);
    }

encodeString()

encodeString	(		$string,
			$charEncoding
	)

Convert string to the font encoding.

The method is used to prepare string for text drawing operators

Parameters

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

Returns

string

Definition at line 238 of file Extracted.php.

    {
        if ($this->_encoding == 'Identity-H') {
            return iconv($charEncoding, 'UTF-16BE', $string);
        }

        if ($this->_encoding == 'WinAnsiEncoding') {
            return iconv($charEncoding, 'CP1252//IGNORE', $string);
        }

        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception(self::ENCODING_NOT_SUPPORTED);
    }

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

Definition at line 190 of file Extracted.php.

    {
        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception(self::OPERATION_NOT_SUPPORTED);
    }

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 166 of file Extracted.php.

    {
        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception(self::OPERATION_NOT_SUPPORTED);
    }

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 148 of file Extracted.php.

    {
        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception(self::OPERATION_NOT_SUPPORTED);
    }

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

Definition at line 223 of file Extracted.php.

    {
        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception(self::OPERATION_NOT_SUPPORTED);
    }

widthsForGlyphs()

widthsForGlyphs

(

$glyphNumbers

)

Returns the widths of the glyphs.

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

See also widthForGlyph().

Parameters

array

$glyphNumbers

Array of glyph numbers.

Returns

array Array of glyph widths (integers).

Exceptions

Zend_Pdf_Exception

Definition at line 208 of file Extracted.php.

    {
        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception(self::OPERATION_NOT_SUPPORTED);
    }

Field Documentation

$_encoding

$_encoding = null

protected

Definition at line 54 of file Extracted.php.

ENCODING_NOT_SUPPORTED

const ENCODING_NOT_SUPPORTED = 'Font encoding is not supported'

Definition at line 44 of file Extracted.php.

OPERATION_NOT_SUPPORTED

const OPERATION_NOT_SUPPORTED = 'Operation is not supported for extracted fonts'

Definition at line 45 of file Extracted.php.

TYPE_NOT_SUPPORTED

const TYPE_NOT_SUPPORTED = 'Unsupported font type.'

Messages

Definition at line 43 of file Extracted.php.

---

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

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