API Documentation

Pdf/Resource/Font/Type0.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: Type0.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Pdf_Resource_Font_Type0

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_Type0
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
$_descendantFont
Methods
getToUnicodeCMapData
__construct
glyphNumbersForCharacters
glyphNumberForCharacter
getCoveredPercentage
widthsForGlyphs
widthForGlyph
encodeString
decodeString

Description

Adobe PDF composite fonts implementation

A composite font is one whose glyphs are obtained from other fonts or from fontlike objects called CIDFonts ({@link Zend_Pdf_Resource_Font_CidFont}), organized hierarchically. In PDF, a composite font is represented by a font dictionary whose Subtype value is Type0; this is also called a Type 0 font (the Type 0 font at the top level of the hierarchy is the root font).

In PDF, a Type 0 font is a CID-keyed font.

CID-keyed fonts provide effective method to operate with multi-byte character encodings.

The CID-keyed font architecture specifies the external representation of certain font programs, called CMap and CIDFont files, along with some conventions for combining and using those files.

A CID-keyed font is the combination of a CMap with one or more CIDFonts, simple fonts, or composite fonts containing glyph descriptions.

The term 'CID-keyed font' reflects the fact that CID (character identifier) numbers are used to index and access the glyph descriptions in the font.

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

Properties

$_descendantFont
jump to class

Zend_Pdf_Resource_Font_CidFont $_descendantFont = ''

Descendant CIDFont

Details

$_descendantFont
Zend_Pdf_Resource_Font_CidFont
visibility
private
default
final
false
static
false

Methods

__construct
jump to class

__construct(  $descendantFont ) :

Object constructor

Arguments
$descendantFont
Details
visibility
public
final
false
static
false

decodeString
jump to class

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

Convert string from the font encoding.

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

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

encodeString
jump to class

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

Convert string to the font encoding.

The method is used to prepare string for text drawing operators

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

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

getToUnicodeCMapData
jump to class

getToUnicodeCMapData( ) : string

Generate ToUnicode character map data

Output
string
Details
visibility
private
final
false
static
true

glyphNumberForCharacter
jump to class

glyphNumberForCharacter( integer $characterCode ) : integer

Returns the glyph number corresponding to the Unicode character.

Zend_Pdf uses 'Identity-H' encoding for Type 0 fonts. So we don't need to perform any conversion

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.

Zend_Pdf uses 'Identity-H' encoding for Type 0 fonts. So we don't need to perform any conversion

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

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

widthsForGlyphs
jump to class

widthsForGlyphs( array $glyphNumbers ) : array

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

Throws an exception if the glyph number is out of range.

See also {@link widthForGlyph()}.

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.