API Documentation

Zend/Pdf/Resource/Font/CidFont.php

Show: inherited
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
Fonts  
Version
$Id: CidFont.php 24665 2012-02-26 16:53:25Z adamlundrigan $  

\Zend_Pdf_Resource_Font_CidFont

Package: Zend\Pdf\Fonts

Adobe PDF CIDFont font object implementation

A CIDFont program contains glyph descriptions that are accessed using a CID as the character selector. There are two types of CIDFont. A Type 0 CIDFont contains glyph descriptions based on Adobe’s Type 1 font format, whereas those in a Type 2 CIDFont are based on the TrueType font format.

A CIDFont dictionary is a PDF object that contains information about a CIDFont program. Although its Type value is Font, a CIDFont 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. It is used only as a descendant of a Type 0 font. The CMap in the Type 0 font is what defines the encoding that maps character codes to CIDs in the CIDFont.

Font objects should be normally be obtained from the factory methods {@link Zend_Pdf_Font::fontWithName} and {@link Zend_Pdf_Font::fontWithPath}.

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

Properties

Propertyprotectedarray  $_charWidths= 'null'

Array containing the widths of each character that have entries in used character map.

Default valuenullDetails
Type
array
Propertyprotected\Zend_Pdf_Cmap  $_cmap= 'null'

Object representing the font's cmap (character to glyph map).

Default valuenullDetails
Type
\Zend_Pdf_Cmap
Propertyprotectedinteger  $_missingCharWidth= '0'

Width for characters missed in the font

Default value0Details
Type
integer

Methods

methodpublic__construct( \Zend_Pdf_FileParser_Font_OpenType $fontParser ) : void

Object constructor

Parameters
Name Type Description
$fontParser \Zend_Pdf_FileParser_Font_OpenType

Font parser object containing OpenType file.

Throws
Exception Description
\Zend_Pdf_Exception
methodpublicdecodeString( string $string, string $charEncoding ) : string

Convert string from the font encoding.

Parameters
Name Type Description
$string string
$charEncoding string

Character encoding of resulting text.

Returns
Type Description
string
Throws
Exception Description
\Zend_Pdf_Exception
methodpublicencodeString( string $string, string $charEncoding ) : string

Convert string to the font encoding.

Parameters
Name Type Description
$string string
$charEncoding string

Character encoding of source text.

Returns
Type Description
string
Throws
Exception Description
\Zend_Pdf_Exception
methodpublicgetCoveredPercentage( string $string, string $charEncoding = '' ) : float

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
Name Type Description
$string string
$charEncoding string

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

Returns
Type Description
float
methodpublicglyphNumberForCharacter( integer $characterCode ) : integer

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 {@link glyphNumbersForCharacters()} which is optimized for bulk operations.

Parameters
Name Type Description
$characterCode integer

Unicode character code (code point).

Returns
Type Description
integer Glyph number.
methodpublicglyphNumbersForCharacters( array $characterCodes ) : array

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 {@link glyphNumberForCharacter()}.

Parameters
Name Type Description
$characterCodes array

Array of Unicode character codes (code points).

Returns
Type Description
array Array of glyph numbers.
methodpublicwidthForChar( integer $charCode ) : integer

Returns the width of the character.

Like {@link widthsForChars()} but used for one char at a time.

Parameters
Name Type Description
$charCode integer
Returns
Type Description
integer
methodpublicwidthForGlyph( integer $glyphNumber ) : integer

Returns the width of the glyph.

Like {@link widthsForGlyphs()} but used for one glyph at a time.

Parameters
Name Type Description
$glyphNumber integer
Returns
Type Description
integer
Throws
Exception Description
\Zend_Pdf_Exception
methodpublicwidthsForChars( array $charCodes ) : array

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 {@link unitsPerEm()}.

See also {@link widthForChar()}.

Parameters
Name Type Description
$charCodes array

&$glyphNumbers Array of glyph numbers.

Returns
Type Description
array Array of glyph widths (integers).
methodpublicwidthsForGlyphs( array $glyphNumbers ) : array

Returns the widths of the glyphs.

Parameters
Name Type Description
$glyphNumbers array

&$glyphNumbers Array of glyph numbers.

Returns
Type Description
array Array of glyph widths (integers).
Throws
Exception Description
\Zend_Pdf_Exception
Documentation was generated by DocBlox 0.15.1.