API Documentation

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

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_Simple
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
$_glyphWidths
$_missingGlyphWidth
Methods
__construct
glyphNumbersForCharacters
glyphNumberForCharacter
getCoveredPercentage
widthsForGlyphs
widthForGlyph
encodeString
decodeString

Description

Adobe PDF Simple fonts implementation

PDF simple fonts functionality is presented by Adobe Type 1 (including standard PDF Type1 built-in fonts) and TrueType fonts support.

Both fonts have the following properties: - Glyphs in the font are selected by single-byte character codes obtained from a string that is shown by the text-showing operators. Logically, these codes index into a table of 256 glyphs; the mapping from codes to glyphs is called the font’s encoding. PDF specification provides a possibility to specify any user defined encoding in addition to the standard built-in encodings: Standard-Encoding, MacRomanEncoding, WinAnsiEncoding, and PDFDocEncoding, but Zend_Pdf simple fonts implementation operates only with Windows ANSI encoding (except Symbol and ZapfDingbats built-in fonts).

  • Each glyph has a single set of metrics, including a horizontal displacement or width. That is, simple fonts support only horizontal writing mode.

The code in this class is common to both types. However, you will only deal directly with subclasses.

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

Properties

$_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

$_glyphWidths
jump to class

array $_glyphWidths = 'null'

Array containing the widths of each of the glyphs contained in the font.

Keys are integers starting from 0, which coresponds to Zend_Pdf_Cmap::MISSING_CHARACTER_GLYPH.

Font character map may contain gaps for actually used glyphs, nevertheless glyphWidths array contains widths for all glyphs even they are unused.

Details

$_glyphWidths
array
visibility
protected
default
null
final
false
static
false

$_missingGlyphWidth
jump to class

integer $_missingGlyphWidth = '0'

Width for glyphs missed in the font

Note: Adobe PDF specfication (V1.4 - V1.6) doesn't define behavior for rendering characters missed in the standard PDF fonts (such us 0x7F (DEL) Windows ANSI code) Adobe Font Metrics files doesn't also define metrics for "missed glyph". We provide character width as "0" for this case, but actually it depends on PDF viewer implementation.

Details

$_missingGlyphWidth
integer
visibility
protected
default
0
final
false
static
false

Methods

__construct
jump to class

__construct( ) :

Object constructor

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

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

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

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

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
Documentation was generated by DocBlox.