API Documentation

Zend/Pdf/Resource/Font.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: Font.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Pdf_Resource_Font

Package: Zend\Pdf\Fonts

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

Parent(s)
\Zend_Pdf_Resource
Children
\Zend_Pdf_Resource_Font_CidFont
\Zend_Pdf_Resource_Font_Extracted
\Zend_Pdf_Resource_Font_Type0
\Zend_Pdf_Resource_Font_Simple
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedinteger  $_ascent= '0'

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

Default value0Details
Type
integer
Propertyprotectedinteger  $_descent= '0'

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

Default value0Details
Type
integer
Propertyprotectedarray  $_fontNames= 'array()'

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

Default valuearray()Details
Type
array
Propertyprotectedinteger  $_fontType= 'Zend_Pdf_Font::TYPE_UNKNOWN'

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

Default valueZend_Pdf_Font::TYPE_UNKNOWNDetails
Type
integer
Propertyprotectedboolean  $_isBold= 'false'

Flag indicating whether or not this font is bold.

Default valuefalseDetails
Type
boolean
Propertyprotectedboolean  $_isItalic= 'false'

Flag indicating whether or not this font is italic.

Default valuefalseDetails
Type
boolean
Propertyprotectedboolean  $_isMonospace= 'false'

Flag indicating whether or not this font is monospaced.

Default valuefalseDetails
Type
boolean
Propertyprotectedinteger  $_lineGap= '0'

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

Default value0Details
Type
integer
Propertyprotectedinteger  $_strikePosition= '0'

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

Default value0Details
Type
integer
Propertyprotectedinteger  $_strikeThickness= '0'

The thickness of the strikethrough (in glyph units).

Default value0Details
Type
integer
Propertyprotectedinteger  $_underlinePosition= '0'

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

Default value0Details
Type
integer
Propertyprotectedinteger  $_underlineThickness= '0'

The thickness of the underline (in glyph units).

Default value0Details
Type
integer
Propertyprotectedinteger  $_unitsPerEm= '0'

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

Default value0Details
Type
integer

Methods

methodpublic__construct( ) : void

Object constructor.

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

Returns
Type Description
string
methodpublicdecodeString( string $string, string $charEncoding ) : string
abstract

Convert string from the font encoding.

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

Parameters
Name Type Description
$string string
$charEncoding string

Character encoding of resulting text.

Returns
Type Description
string
methodpublicencodeString( string $string, string $charEncoding ) : string
abstract

Convert string to the font encoding.

The method is used to prepare string for text drawing operators

Parameters
Name Type Description
$string string
$charEncoding string

Character encoding of source text.

Returns
Type Description
string
methodpublicgetAscent( ) : 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.

Returns
Type Description
integer
methodpublicgetCoveredPercentage( string $string, string $charEncoding = '' ) : float
abstract

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
methodpublicgetDescent( ) : 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.

Returns
Type Description
integer
methodpublicgetFontName( 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.

Parameters
Name Type Description
$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()};

Returns
Type Description
string
methodpublicgetFontNames( ) : array

Returns whole set of font names.

Returns
Type Description
array
methodpublicgetFontType( ) : integer

Returns the type of font.

Returns
Type Description
integer One of the TYPE_ constants defined in {@link Zend_Pdf_Font}.
methodpublicgetLineGap( ) : 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).

Returns
Type Description
integer
methodpublicgetLineHeight( ) : 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.

Returns
Type Description
integer
methodpublicgetStrikePosition( ) : integer

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

Returns
Type Description
integer
methodpublicgetStrikeThickness( ) : integer

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

Returns
Type Description
integer
methodpublicgetUnderlinePosition( ) : integer

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

This value is usually negative.

Returns
Type Description
integer
methodpublicgetUnderlineThickness( ) : integer

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

Returns
Type Description
integer
methodpublicgetUnitsPerEm( ) : 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.

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

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
abstract

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.
methodpublicisBold( ) : boolean

Returns true if font is bold.

Returns
Type Description
boolean
methodpublicisItalic( ) : boolean

Returns true if font is italic.

Returns
Type Description
boolean
methodpublicisMonospace( ) : boolean

Returns true if font is monospace.

Returns
Type Description
boolean
methodpublicwidthForGlyph( integer $glyphNumber ) : integer
abstract

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
methodpublicwidthsForGlyphs( array $glyphNumbers ) : array
abstract

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

Parameters
Name Type Description
$glyphNumbers array

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.