Pdf/Resource/Font.php

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: Font.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Pdf_Resource_Font

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
jump to top

Extends from: Zend_Pdf_Resource
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: $_fontType; $_fontNames; $_isBold; $_isItalic; $_isMonospace; $_underlinePosition; $_underlineThickness; $_strikePosition; $_strikeThickness; $_unitsPerEm; $_ascent; $_descent; $_lineGap
Methods: __construct; __toString; getFontType; getFontName; getFontNames; isBold; isItalic; isMonospace; getUnderlinePosition; getUnderlineThickness; getStrikePosition; getStrikeThickness; getUnitsPerEm; getAscent; getDescent; getLineGap; getLineHeight; glyphNumbersForCharacters; glyphNumberForCharacter; getCoveredPercentage; widthsForGlyphs; widthForGlyph; encodeString; decodeString; toEmSpace

Description

Abstract class which manages PDF fonts.

Defines the public interface and creates shared storage for concrete subclasses which are responsible for generating the font's information dictionaries, mapping characters to glyphs, and providing both overall font and glyph-specific metric data.

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

Properties

$_ascent
jump to class

integer $_ascent = '0'

Typographical ascent. See {@link getAscent()}.

Details

$_ascent: integer
visibility: protected
default: 0
final: false
static: false

$_descent
jump to class

integer $_descent = '0'

Typographical descent. See {@link getDescent()}.

Details

$_descent: integer
visibility: protected
default: 0
final: false
static: false

$_fontNames
jump to class

array $_fontNames = 'array'

Array containing descriptive names for the font. See {@link fontName()}.

Details

$_fontNames: array
visibility: protected
default: array
final: false
static: false

$_fontType
jump to class

integer $_fontType = 'Zend_Pdf_Font'

The type of font. Use TYPE_ constants defined in {@link Zend_Pdf_Font}.

Details

$_fontType: integer
visibility: protected
default: Zend_Pdf_Font
final: false
static: false

$_isBold
jump to class

boolean $_isBold = 'false'

Flag indicating whether or not this font is bold.

Details

$_isBold: boolean
visibility: protected
default: false
final: false
static: false

$_isItalic
jump to class

boolean $_isItalic = 'false'

Flag indicating whether or not this font is italic.

Details

$_isItalic: boolean
visibility: protected
default: false
final: false
static: false

$_isMonospace
jump to class

boolean $_isMonospace = 'false'

Flag indicating whether or not this font is monospaced.

Details

$_isMonospace: boolean
visibility: protected
default: false
final: false
static: false

$_lineGap
jump to class

integer $_lineGap = '0'

Typographical line gap. See {@link getLineGap()}.

Details

$_lineGap: integer
visibility: protected
default: 0
final: false
static: false

$_strikePosition
jump to class

integer $_strikePosition = '0'

The position above the text baseline of the strikethrough (in glyph units).

Details

$_strikePosition: integer
visibility: protected
default: 0
final: false
static: false

$_strikeThickness
jump to class

integer $_strikeThickness = '0'

The thickness of the strikethrough (in glyph units).

Details

$_strikeThickness: integer
visibility: protected
default: 0
final: false
static: false

$_underlinePosition
jump to class

integer $_underlinePosition = '0'

The position below the text baseline of the underline (in glyph units).

Details

$_underlinePosition: integer
visibility: protected
default: 0
final: false
static: false

$_underlineThickness
jump to class

integer $_underlineThickness = '0'

The thickness of the underline (in glyph units).

Details

$_underlineThickness: integer
visibility: protected
default: 0
final: false
static: false

$_unitsPerEm
jump to class

integer $_unitsPerEm = '0'

Number of glyph units per em. See {@link getUnitsPerEm()}.

Details

$_unitsPerEm: integer
visibility: protected
default: 0
final: false
static: false

Methods

__construct
jump to class

__construct(
          
          )
        
        :

Object constructor.

Details

visibility: public
final: false
static: false

__toString
jump to class

__toString(
          
          )
        
        :
        string

Returns the full name of the font in the encoding method of the current locale. Transliterates any characters that cannot be naturally represented in that character set.

Output

string

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

getAscent
jump to class

getAscent(
          
          )
        
        :
        integer

Returns the typographic ascent in font glyph units.

The typographic ascent is the distance from the font's baseline to the top of the text frame. It is frequently used to locate the initial baseline for a paragraph of text inside a given rectangle.

Output

integer

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

getDescent
jump to class

getDescent(
          
          )
        
        :
        integer

Returns the typographic descent in font glyph units.

The typographic descent is the distance below the font's baseline to the bottom of the text frame. It is always negative.

Output

integer

Details

visibility: public
final: false
static: false

getFontName
jump to class

getFontName(
          integer $nameType, mixed $language, string $characterSet
              =
              null
          )
        
        :
        string

Returns the specified descriptive name for the font.

The font name type is usually one of the following:

{@link Zend_Pdf_Font::NAME_FULL}
{@link Zend_Pdf_Font::NAME_FAMILY}
{@link Zend_Pdf_Font::NAME_PREFERRED_FAMILY}
{@link Zend_Pdf_Font::NAME_STYLE}
{@link Zend_Pdf_Font::NAME_PREFERRED_STYLE}
{@link Zend_Pdf_Font::NAME_DESCRIPTION}
{@link Zend_Pdf_Font::NAME_SAMPLE_TEXT}
{@link Zend_Pdf_Font::NAME_ID}
{@link Zend_Pdf_Font::NAME_VERSION}
{@link Zend_Pdf_Font::NAME_POSTSCRIPT}
{@link Zend_Pdf_Font::NAME_CID_NAME}
{@link Zend_Pdf_Font::NAME_DESIGNER}
{@link Zend_Pdf_Font::NAME_DESIGNER_URL}
{@link Zend_Pdf_Font::NAME_MANUFACTURER}
{@link Zend_Pdf_Font::NAME_VENDOR_URL}
{@link Zend_Pdf_Font::NAME_COPYRIGHT}
{@link Zend_Pdf_Font::NAME_TRADEMARK}
{@link Zend_Pdf_Font::NAME_LICENSE}
{@link Zend_Pdf_Font::NAME_LICENSE_URL}

Note that not all names are available for all fonts. In addition, some fonts may contain additional names, whose indicies are in the range 256 to 32767 inclusive, which are used for certain font layout features.

If the preferred language translation is not available, uses the first available translation for the name, which is usually English.

If the requested name does not exist, returns null.

All names are stored internally as Unicode strings, using UTF-16BE encoding. You may optionally supply a different resulting character set.

Arguments

$nameType: integer
Type of name requested.
$language: mixed
Preferred language (string) or array of languages in preferred order. Use the ISO 639 standard 2-letter language codes.
$characterSet: string
(optional) Desired resulting character set. You may use any character set supported by {@link iconv()};

Output

string

Details

visibility: public
final: false
static: false

getFontNames
jump to class

getFontNames(
          
          )
        
        :
        array

Returns whole set of font names.

Output

array

Details

visibility: public
final: false
static: false

getFontType
jump to class

getFontType(
          
          )
        
        :
        integer

Returns the type of font.

Output

integer: One of the TYPE_ constants defined in {@link Zend_Pdf_Font}.

Details

visibility: public
final: false
static: false

getLineGap
jump to class

getLineGap(
          
          )
        
        :
        integer

Returns the typographic line gap in font glyph units.

The typographic line gap is the distance between the bottom of the text frame of one line to the top of the text frame of the next. It is typically combined with the typographical ascent and descent to determine the font's total line height (or leading).

Output

integer

Details

visibility: public
final: false
static: false

getLineHeight
jump to class

getLineHeight(
          
          )
        
        :
        integer

Returns the suggested line height (or leading) in font glyph units.

This value is determined by adding together the values of the typographic ascent, descent, and line gap. This value yields the suggested line spacing as determined by the font developer.

It should be noted that this is only a guideline; layout engines will frequently modify this value to achieve special effects such as double- spacing.

Output

integer

Details

visibility: public
final: false
static: false

getStrikePosition
jump to class

getStrikePosition(
          
          )
        
        :
        integer

Returns the suggested position above the text baseline of the strikethrough in glyph units.

Output

integer

Details

visibility: public
final: false
static: false

getStrikeThickness
jump to class

getStrikeThickness(
          
          )
        
        :
        integer

Returns the suggested line thickness of the strikethrough in glyph units.

Output

integer

Details

visibility: public
final: false
static: false

getUnderlinePosition
jump to class

getUnderlinePosition(
          
          )
        
        :
        integer

Returns the suggested position below the text baseline of the underline in glyph units.

This value is usually negative.

Output

integer

Details

visibility: public
final: false
static: false

getUnderlineThickness
jump to class

getUnderlineThickness(
          
          )
        
        :
        integer

Returns the suggested line thickness of the underline in glyph units.

Output

integer

Details

visibility: public
final: false
static: false

getUnitsPerEm
jump to class

getUnitsPerEm(
          
          )
        
        :
        integer

Returns the number of glyph units per em.

Used to convert glyph space to user space. Frequently used in conjunction with {@link widthsForGlyphs()} to calculate the with of a run of text.

Output

integer

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

isBold
jump to class

isBold(
          
          )
        
        :
        boolean

Returns true if font is bold.

Output

boolean

Details

visibility: public
final: false
static: false

isItalic
jump to class

isItalic(
          
          )
        
        :
        boolean

Returns true if font is italic.

Output

boolean

Details

visibility: public
final: false
static: false

isMonospace
jump to class

isMonospace(
          
          )
        
        :
        boolean

Returns true if font is monospace.

Output

boolean

Details

visibility: public
final: false
static: false

toEmSpace
jump to class

toEmSpace(
          integer $value
          )
        
        :
        integer

If the font's glyph space is not 1000 units per em, converts the value.

Arguments

$value: integer

Output

integer

Details

visibility: public
final: false
static: false
internal

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

Arguments

$glyphNumbers: array
Array of glyph numbers.

Output

array: Array of glyph widths (integers).

Details

visibility: public
final: false
static: false
throws

API Documentation

Pdf/Resource/Font.php

Description

Zend_Pdf_Resource_Fontjump to top

Description

Properties

$_ascentjump to class

Details

$_descentjump to class

Details

$_fontNamesjump to class

Details

$_fontTypejump to class

Details

$_isBoldjump to class

Details

$_isItalicjump to class

Details

$_isMonospacejump to class

Details

$_lineGapjump to class

Details

$_strikePositionjump to class

Details

$_strikeThicknessjump to class

Details

$_underlinePositionjump to class

Details

$_underlineThicknessjump to class

Details

$_unitsPerEmjump to class

Details

Methods

__constructjump to class

Details

__toStringjump to class

Output

Details

decodeStringjump to class

Arguments

Output

Details

encodeStringjump to class

Arguments

Output

Details

getAscentjump to class

Output

Details

getCoveredPercentagejump to class

Arguments

Output

Details

getDescentjump to class

Output

Details

getFontNamejump to class

Arguments

Output

Details

getFontNamesjump to class

Output

Details

getFontTypejump to class

Output

Details

getLineGapjump to class

Output

Details

getLineHeightjump to class

Output

Details

getStrikePositionjump to class

Output

Details

getStrikeThicknessjump to class

Output

Details

getUnderlinePositionjump to class

Output

Zend_Pdf_Resource_Font
jump to top

$_ascent
jump to class

$_descent
jump to class

$_fontNames
jump to class

$_fontType
jump to class

$_isBold
jump to class

$_isItalic
jump to class

$_isMonospace
jump to class

$_lineGap
jump to class

$_strikePosition
jump to class

$_strikeThickness
jump to class

$_underlinePosition
jump to class

$_underlineThickness
jump to class

$_unitsPerEm
jump to class

__construct
jump to class

__toString
jump to class

decodeString
jump to class

encodeString
jump to class

getAscent
jump to class

getCoveredPercentage
jump to class

getDescent
jump to class

getFontName
jump to class

getFontNames
jump to class

getFontType
jump to class

getLineGap
jump to class

getLineHeight
jump to class

getStrikePosition
jump to class

getStrikeThickness
jump to class

getUnderlinePosition
jump to class

getUnderlineThickness
jump to class

getUnitsPerEm
jump to class

glyphNumberForCharacter
jump to class

glyphNumbersForCharacters
jump to class

isBold
jump to class

isItalic
jump to class

isMonospace
jump to class

toEmSpace
jump to class

widthForGlyph
jump to class

widthsForGlyphs
jump to class