API Documentation

Pdf/Resource/Font/Extracted.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Pdf  
subpackage
Fonts  
version
$Id: Extracted.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Pdf_Resource_Font_Extracted

Extracted fonts implementation

Thes class allows to extract fonts already mentioned within PDF document and use them for text drawing.

Extends from
\Zend_Pdf_Resource_Font
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Pdf  
subpackage
Fonts  

Constants

Constant  TYPE_NOT_SUPPORTED = 'Unsupported font type.'

Messages

Constant  ENCODING_NOT_SUPPORTED = 'Font encoding is not supported'
Constant  OPERATION_NOT_SUPPORTED = 'Operation is not supported for extracted fonts'

Properties

Propertyprotectedstring  $_encoding= 'null'

Extracted font encoding

Only 'Identity-H' and 'WinAnsiEncoding' encodings are supported now

Default valuenullDetails
Type
string

Methods

methodpublic__clone( ) : void

Clone page, extract it and dependent objects from the current document, so it can be used within other docs.

Inherited from: \Zend_Pdf_Resource::__clone()
methodpublic__construct( mixed $fontDictionary ) : void

Object constructor

$fontDictionary is a Zend_Pdf_Element_Reference or Zend_Pdf_Element_Object object

Parameters
Name Type Description
$fontDictionary mixed
Throws
Exception Description
\Zend_Pdf_Exception
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.

Inherited from: \Zend_Pdf_Resource_Font::__toString()
Returns
Type Description
string
methodpublicdecodeString( string $string, string $charEncoding ) : string

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

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.

Inherited from: \Zend_Pdf_Resource_Font::getAscent()

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

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.

Inherited from: \Zend_Pdf_Resource_Font::getDescent()

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.

Inherited from: \Zend_Pdf_Resource_Font::getFontName()

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.

Inherited from: \Zend_Pdf_Resource_Font::getFontNames()
Returns
Type Description
array
methodpublicgetFontType( ) : integer

Returns the type of font.

Inherited from: \Zend_Pdf_Resource_Font::getFontType()
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.

Inherited from: \Zend_Pdf_Resource_Font::getLineGap()

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.

Inherited from: \Zend_Pdf_Resource_Font::getLineHeight()

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.

Inherited from: \Zend_Pdf_Resource_Font::getStrikePosition()
Returns
Type Description
integer
methodpublicgetStrikeThickness( ) : integer

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

Inherited from: \Zend_Pdf_Resource_Font::getStrikeThickness()
Returns
Type Description
integer
methodpublicgetUnderlinePosition( ) : integer

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

Inherited from: \Zend_Pdf_Resource_Font::getUnderlinePosition()

This value is usually negative.

Returns
Type Description
integer
methodpublicgetUnderlineThickness( ) : integer

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

Inherited from: \Zend_Pdf_Resource_Font::getUnderlineThickness()
Returns
Type Description
integer
methodpublicgetUnitsPerEm( ) : integer

Returns the number of glyph units per em.

Inherited from: \Zend_Pdf_Resource_Font::getUnitsPerEm()

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

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

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.

Inherited from: \Zend_Pdf_Resource_Font::isBold()
Returns
Type Description
boolean
methodpublicisItalic( ) : boolean

Returns true if font is italic.

Inherited from: \Zend_Pdf_Resource_Font::isItalic()
Returns
Type Description
boolean
methodpublicisMonospace( ) : boolean

Returns true if font is monospace.

Inherited from: \Zend_Pdf_Resource_Font::isMonospace()
Returns
Type Description
boolean
methodpublicwidthForGlyph( integer $glyphNumber ) : integer

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

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