Implementation for the standard PDF font Helvetica-Oblique.

This class was generated automatically using the font information and metric data contained in the Adobe Font Metric (AFM) files, available here: http://partners.adobe.com/public/developer/en/pdf/Core14_AFMs.zip

The PHP script used to generate this class can be found in the /tools directory of the framework distribution. If you need to make modifications to this class, chances are the same modifications are needed for the rest of the standard fonts. You should modify the script and regenerate the classes instead of changing this class file by hand.

package Zend_Pdf
subpackage Fonts
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Pdf_Resource_Font_Simple_Standard

 Methods

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

__clone() 
Inherited

Object constructor

__construct() 

If resource is not a Zend_Pdf_Element object, then stream object with specified value is generated.

inherited_from \Zend_Pdf_Resource_Font_Simple_Standard::__construct()

Object constructor.

__construct(\Zend_Pdf_Element|string $resource) 
Inherited

If resource is not a Zend_Pdf_Element object, then stream object with specified value is generated.

Parameters

$resource

\Zend_Pdf_Elementstring

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.

__toString() : string
Inherited

Returns

string

Convert string from the font encoding.

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

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

Parameters

$string

string

$charEncoding

string

Character encoding of resulting text.

Returns

string

Convert string to the font encoding.

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

The method is used to prepare string for text drawing operators

Parameters

$string

string

$charEncoding

string

Character encoding of source text.

Returns

string

Returns the typographic ascent in font glyph units.

getAscent() : integer
Inherited

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

integer

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.

getCoveredPercentage(string $string, string $charEncoding = '') : float
Inherited

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

$string

string

$charEncoding

string

(optional) Character encoding of source text. If omitted, uses 'current locale'.

Returns

float

Returns the typographic descent in font glyph units.

getDescent() : integer
Inherited

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

Returns

integer

Returns the specified descriptive name for the font.

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

The font name type is usually one of the following:

  • [Zend_Pdf_Font::NAME_FULL](/classes/Zend_Pdf_Font.html#constant_NAME_FULL)
  • [Zend_Pdf_Font::NAME_FAMILY](/classes/Zend_Pdf_Font.html#constant_NAME_FAMILY)
  • [Zend_Pdf_Font::NAME_PREFERRED_FAMILY](/classes/Zend_Pdf_Font.html#constant_NAME_PREFERRED_FAMILY)
  • [Zend_Pdf_Font::NAME_STYLE](/classes/Zend_Pdf_Font.html#constant_NAME_STYLE)
  • [Zend_Pdf_Font::NAME_PREFERRED_STYLE](/classes/Zend_Pdf_Font.html#constant_NAME_PREFERRED_STYLE)
  • [Zend_Pdf_Font::NAME_DESCRIPTION](/classes/Zend_Pdf_Font.html#constant_NAME_DESCRIPTION)
  • [Zend_Pdf_Font::NAME_SAMPLE_TEXT](/classes/Zend_Pdf_Font.html#constant_NAME_SAMPLE_TEXT)
  • [Zend_Pdf_Font::NAME_ID](/classes/Zend_Pdf_Font.html#constant_NAME_ID)
  • [Zend_Pdf_Font::NAME_VERSION](/classes/Zend_Pdf_Font.html#constant_NAME_VERSION)
  • [Zend_Pdf_Font::NAME_POSTSCRIPT](/classes/Zend_Pdf_Font.html#constant_NAME_POSTSCRIPT)
  • [Zend_Pdf_Font::NAME_CID_NAME](/classes/Zend_Pdf_Font.html#constant_NAME_CID_NAME)
  • [Zend_Pdf_Font::NAME_DESIGNER](/classes/Zend_Pdf_Font.html#constant_NAME_DESIGNER)
  • [Zend_Pdf_Font::NAME_DESIGNER_URL](/classes/Zend_Pdf_Font.html#constant_NAME_DESIGNER_URL)
  • [Zend_Pdf_Font::NAME_MANUFACTURER](/classes/Zend_Pdf_Font.html#constant_NAME_MANUFACTURER)
  • [Zend_Pdf_Font::NAME_VENDOR_URL](/classes/Zend_Pdf_Font.html#constant_NAME_VENDOR_URL)
  • [Zend_Pdf_Font::NAME_COPYRIGHT](/classes/Zend_Pdf_Font.html#constant_NAME_COPYRIGHT)
  • [Zend_Pdf_Font::NAME_TRADEMARK](/classes/Zend_Pdf_Font.html#constant_NAME_TRADEMARK)
  • [Zend_Pdf_Font::NAME_LICENSE](/classes/Zend_Pdf_Font.html#constant_NAME_LICENSE)
  • [Zend_Pdf_Font::NAME_LICENSE_URL](/classes/Zend_Pdf_Font.html#constant_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

$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

string

Returns whole set of font names.

getFontNames() : array
Inherited

Returns

array

Returns the type of font.

getFontType() : integer
Inherited

Returns

integerOne of the TYPE_ constants defined in {@link Zend_Pdf_Font}.

Returns the typographic line gap in font glyph units.

getLineGap() : integer
Inherited

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

integer

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

getLineHeight() : integer
Inherited

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

integer

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

getStrikePosition() : integer
Inherited

Returns

integer

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

getStrikeThickness() : integer
Inherited

Returns

integer

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

getUnderlinePosition() : integer
Inherited

This value is usually negative.

Returns

integer

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

getUnderlineThickness() : integer
Inherited

Returns

integer

Returns the number of glyph units per em.

getUnitsPerEm() : integer
Inherited

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

Returns

integer

Returns the glyph number corresponding to the Unicode character.

glyphNumberForCharacter(integer $characterCode) : integer
Inherited

If a particular character doesn't exist in this font, the special 'missing character glyph' will be substituted.

See also \glyphNumbersForCharacters() which is optimized for bulk operations.

Parameters

$characterCode

integer

Unicode character code (code point).

Returns

integerGlyph number.

Returns an array of glyph numbers corresponding to the Unicode characters.

glyphNumbersForCharacters(array $characterCodes) : array
Inherited

If a particular character doesn't exist in this font, the special 'missing character glyph' will be substituted.

See also \glyphNumberForCharacter().

Parameters

$characterCodes

array

Array of Unicode character codes (code points).

Returns

arrayArray of glyph numbers.

Returns true if font is bold.

isBold() : boolean
Inherited

Returns

boolean

Returns true if font is italic.

isItalic() : boolean
Inherited

Returns

boolean

Returns true if font is monospace.

isMonospace() : boolean
Inherited

Returns

boolean

Returns the width of the glyph.

widthForGlyph(integer $glyphNumber) : integer
Inherited

Like \widthsForGlyphs() but used for one glyph at a time.

Parameters

$glyphNumber

integer

Exceptions

\Zend_Pdf_Exception

Returns

integer

Returns the widths of the glyphs.

widthsForGlyphs(array $glyphNumbers) : array
Inherited

The widths are expressed in the font's glyph space. You are responsible for converting to user space as necessary. See \unitsPerEm().

See also \widthForGlyph().

Parameters

$glyphNumbers

array

Array of glyph numbers.

Exceptions

\Zend_Pdf_Exception

Returns

arrayArray of glyph widths (integers).

 Properties

 

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

$_ascent : integer

Default

0
 

Object representing the font's cmap (character to glyph map).

$_cmap : \Zend_Pdf_Cmap

Default

null
 

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

$_descent : integer

Default

0
 

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

$_fontNames : array

Default

array()
 

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

$_fontType : integer

Default

\Zend_Pdf_Font::TYPE_UNKNOWN
 

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

$_glyphWidths : array

Default

null

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.

 

Flag indicating whether or not this font is bold.

$_isBold : boolean

Default

false
 

Flag indicating whether or not this font is italic.

$_isItalic : boolean

Default

false
 

Flag indicating whether or not this font is monospaced.

$_isMonospace : boolean

Default

false
 

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

$_lineGap : integer

Default

0
 

Width for glyphs missed in the font

$_missingGlyphWidth : integer

Default

0

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.

 

Each Pdf resource (fonts, images, .

$_objectFactory : \Zend_Pdf_ElementFactory_Interface

Default

..) interacts with a PDF itself. It creates appropriate PDF objects, structures and sometime embedded files. Resources are referenced in content streams by names, which are stored in a page resource dictionaries.

Thus, resources must be attached to the PDF.

Resource abstraction uses own PDF object factory to store all necessary information. At the render time internal object factory is appended to the global PDF file factory.

Resource abstraction also cashes information about rendered PDF files and doesn't duplicate resource description each time then Resource is rendered (referenced).

 

Main resource object

$_resource : \Zend_Pdf_Element_Object

Default

 

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

$_strikePosition : integer

Default

0
 

The thickness of the strikethrough (in glyph units).

$_strikeThickness : integer

Default

0
 

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

$_underlinePosition : integer

Default

0
 

The thickness of the underline (in glyph units).

$_underlineThickness : integer

Default

0
 

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

$_unitsPerEm : integer

Default

0