API Documentation

Pdf/Resource/Font/CidFont.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Pdf
subpackage
Fonts
version
$Id: CidFont.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Pdf_Resource_Font_CidFont

Description

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.

Zend_Pdf_Resource_Font_CidFont
jump to top

Extends from
Zend_Pdf_Resource_Font
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Pdf
subpackage
Fonts
Properties
$_cmap
$_charWidths
$_missingCharWidth
Methods
__construct
glyphNumbersForCharacters
glyphNumberForCharacter
getCoveredPercentage
widthsForChars
widthForChar
widthsForGlyphs
widthForGlyph
encodeString
decodeString

Description

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}.

Properties

$_charWidths
jump to class

array $_charWidths = 'null'

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

Details

$_charWidths
array
visibility
protected
default
null
final
false
static
false

$_cmap
jump to class

Zend_Pdf_Cmap $_cmap = 'null'

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

Details

$_cmap
Zend_Pdf_Cmap
visibility
protected
default
null
final
false
static
false

$_missingCharWidth
jump to class

integer $_missingCharWidth = '0'

Width for characters missed in the font

Details

$_missingCharWidth
integer
visibility
protected
default
0
final
false
static
false

Methods

__construct
jump to class

__construct( Zend_Pdf_FileParser_Font_OpenType $fontParser ) :

Object constructor

Arguments
$fontParser
Zend_Pdf_FileParser_Font_OpenType
Font parser object containing OpenType file.
Details
visibility
public
final
false
static
false
throws

decodeString
jump to class

decodeString( string $string, string $charEncoding ) : string

Convert string from the font encoding.

Arguments
$string
string
$charEncoding
string
Character encoding of resulting text.
Output
string
Details
visibility
public
final
false
static
false
throws

encodeString
jump to class

encodeString( string $string, string $charEncoding ) : string

Convert string to the font encoding.

Arguments
$string
string
$charEncoding
string
Character encoding of source text.
Output
string
Details
visibility
public
final
false
static
false
throws

getCoveredPercentage
jump to class

getCoveredPercentage( 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.

Arguments
$string
string
$charEncoding
string
(optional) Character encoding of source text. If omitted, uses 'current locale'.
Output
float
Details
visibility
public
final
false
static
false

glyphNumberForCharacter
jump to class

glyphNumberForCharacter( 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.

Arguments
$characterCode
integer
Unicode character code (code point).
Output
integer
Glyph number.
Details
visibility
public
final
false
static
false

glyphNumbersForCharacters
jump to class

glyphNumbersForCharacters( 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()}.

Arguments
$characterCodes
array
Array of Unicode character codes (code points).
Output
array
Array of glyph numbers.
Details
visibility
public
final
false
static
false

widthForChar
jump to class

widthForChar( integer $charCode ) : integer

Returns the width of the character.

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

Arguments
$charCode
integer
Output
integer
Details
visibility
public
final
false
static
false

widthForGlyph
jump to class

widthForGlyph( integer $glyphNumber ) : integer

Returns the width of the glyph.

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

Arguments
$glyphNumber
integer
Output
integer
Details
visibility
public
final
false
static
false
throws

widthsForChars
jump to class

widthsForChars( 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()}.

Arguments
$charCodes
array
&$glyphNumbers Array of glyph numbers.
Output
array
Array of glyph widths (integers).
Details
visibility
public
final
false
static
false

widthsForGlyphs
jump to class

widthsForGlyphs( array $glyphNumbers ) : array

Returns the widths of the glyphs.

Arguments
$glyphNumbers
array
&$glyphNumbers Array of glyph numbers.
Output
array
Array of glyph widths (integers).
Details
visibility
public
final
false
static
false
throws
Documentation was generated by DocBlox.