Pdf/Resource/Font/Type0.php

Show: PublicProtectedPrivateinherited
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: Type0.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Pdf_Resource_Font_Type0

Package: Zend\Pdf\Fonts
Adobe PDF composite fonts implementation

A composite font is one whose glyphs are obtained from other fonts or from fontlike objects called CIDFonts (Zend_Pdf_Resource_Font_CidFont), organized hierarchically. In PDF, a composite font is represented by a font dictionary whose Subtype value is Type0; this is also called a Type 0 font (the Type 0 font at the top level of the hierarchy is the root font).

In PDF, a Type 0 font is a CID-keyed font.

CID-keyed fonts provide effective method to operate with multi-byte character encodings.

The CID-keyed font architecture specifies the external representation of certain font programs, called CMap and CIDFont files, along with some conventions for combining and using those files.

A CID-keyed font is the combination of a CMap with one or more CIDFonts, simple fonts, or composite fonts containing glyph descriptions.

The term 'CID-keyed font' reflects the fact that CID (character identifier) numbers are used to index and access the glyph descriptions in the font.

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

Parent(s)
\Zend_Pdf_Resource_Font < \Zend_Pdf_Resource
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedinteger $_ascent = 0
inherited
Typographical ascent.
Inherited from: \Zend_Pdf_Resource_Font::$$_ascent
Default value0Details
Type
integer
Inherited_from
\Zend_Pdf_Resource_Font::$$_ascent  
>VPropertyprivate\Zend_Pdf_Resource_Font_CidFont $_descendantFont
Descendant CIDFont
>VPropertyprotectedinteger $_descent = 0
inherited
Typographical descent.
Inherited from: \Zend_Pdf_Resource_Font::$$_descent
Default value0Details
Type
integer
Inherited_from
\Zend_Pdf_Resource_Font::$$_descent  
>VPropertyprotectedarray $_fontNames = array()
inherited
Array containing descriptive names for the font.
Inherited from: \Zend_Pdf_Resource_Font::$$_fontNames
Default valuearray()Details
Type
array
Inherited_from
\Zend_Pdf_Resource_Font::$$_fontNames  
>VPropertyprotectedinteger $_fontType = \Zend_Pdf_Font::TYPE_UNKNOWN
inherited
The type of font.
Inherited from: \Zend_Pdf_Resource_Font::$$_fontType

Use TYPE_ constants defined in Zend_Pdf_Font.

Default value\Zend_Pdf_Font::TYPE_UNKNOWNDetails
Type
integer
Inherited_from
\Zend_Pdf_Resource_Font::$$_fontType  
>VPropertyprotectedboolean $_isBold = false
inherited
Flag indicating whether or not this font is bold.
Inherited from: \Zend_Pdf_Resource_Font::$$_isBold
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Pdf_Resource_Font::$$_isBold  
>VPropertyprotectedboolean $_isItalic = false
inherited
Flag indicating whether or not this font is italic.
Inherited from: \Zend_Pdf_Resource_Font::$$_isItalic
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Pdf_Resource_Font::$$_isItalic  
>VPropertyprotectedboolean $_isMonospace = false
inherited
Flag indicating whether or not this font is monospaced.
Inherited from: \Zend_Pdf_Resource_Font::$$_isMonospace
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Pdf_Resource_Font::$$_isMonospace  
>VPropertyprotectedinteger $_lineGap = 0
inherited
Typographical line gap.
Inherited from: \Zend_Pdf_Resource_Font::$$_lineGap
Default value0Details
Type
integer
Inherited_from
\Zend_Pdf_Resource_Font::$$_lineGap  
>VPropertyprotected\Zend_Pdf_ElementFactory_Interface $_objectFactory
inherited
Each Pdf resource (fonts, images, .
Inherited from: \Zend_Pdf_Resource::$$_objectFactory\Zend_Pdf_Resource_Font::$$_objectFactory

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

Details
Type
\Zend_Pdf_ElementFactory_Interface
Inherited_from
\Zend_Pdf_Resource::$$_objectFactory  
Inherited_from
\Zend_Pdf_Resource_Font::$$_objectFactory  
>VPropertyprotected\Zend_Pdf_Element_Object $_resource
inherited
Main resource object
Inherited from: \Zend_Pdf_Resource::$$_resource\Zend_Pdf_Resource_Font::$$_resource
>VPropertyprotectedinteger $_strikePosition = 0
inherited
The position above the text baseline of the strikethrough (in glyph units).
Inherited from: \Zend_Pdf_Resource_Font::$$_strikePosition
Default value0Details
Type
integer
Inherited_from
\Zend_Pdf_Resource_Font::$$_strikePosition  
>VPropertyprotectedinteger $_strikeThickness = 0
inherited
The thickness of the strikethrough (in glyph units).
Inherited from: \Zend_Pdf_Resource_Font::$$_strikeThickness
Default value0Details
Type
integer
Inherited_from
\Zend_Pdf_Resource_Font::$$_strikeThickness  
>VPropertyprotectedinteger $_underlinePosition = 0
inherited
The position below the text baseline of the underline (in glyph units).
Inherited from: \Zend_Pdf_Resource_Font::$$_underlinePosition
Default value0Details
Type
integer
Inherited_from
\Zend_Pdf_Resource_Font::$$_underlinePosition  
>VPropertyprotectedinteger $_underlineThickness = 0
inherited
The thickness of the underline (in glyph units).
Inherited from: \Zend_Pdf_Resource_Font::$$_underlineThickness
Default value0Details
Type
integer
Inherited_from
\Zend_Pdf_Resource_Font::$$_underlineThickness  
>VPropertyprotectedinteger $_unitsPerEm = 0
inherited
Number of glyph units per em.
Inherited from: \Zend_Pdf_Resource_Font::$$_unitsPerEm
Default value0Details
Type
integer
Inherited_from
\Zend_Pdf_Resource_Font::$$_unitsPerEm  

Methods

methodpublic__clone() : void
inherited

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()\Zend_Pdf_Resource_Font::__clone()
methodpublic__construct( $descendantFont) : void

Object constructor

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

Parameters
NameTypeDescription
$descendantFont
methodpublic__toString() : string
inherited

Returns the full name of the font in the encoding method of the current locale.

Inherited from: \Zend_Pdf_Resource_Font::__toString()

Transliterates any characters that cannot be naturally represented in that character set.

Returns
TypeDescription
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
NameTypeDescription
$stringstring
$charEncodingstring

Character encoding of resulting text.

Returns
TypeDescription
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
NameTypeDescription
$stringstring
$charEncodingstring

Character encoding of source text.

Returns
TypeDescription
string
methodpublicgetAscent() : integer
inherited

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
TypeDescription
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
NameTypeDescription
$stringstring
$charEncodingstring

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

Returns
TypeDescription
float
methodpublicgetDescent() : integer
inherited

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
TypeDescription
integer
methodpublicgetFontName(integer $nameType, mixed $language, string $characterSet = null) : string
inherited

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:

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
NameTypeDescription
$nameTypeinteger

Type of name requested.

$languagemixed

Preferred language (string) or array of languages in preferred order. Use the ISO 639 standard 2-letter language codes.

$characterSetstring

(optional) Desired resulting character set. You may use any character set supported by {@link iconv()};

Returns
TypeDescription
string
methodpublicgetFontNames() : array
inherited

Returns whole set of font names.

Inherited from: \Zend_Pdf_Resource_Font::getFontNames()
Returns
TypeDescription
array
methodpublicgetFontType() : integer
inherited

Returns the type of font.

Inherited from: \Zend_Pdf_Resource_Font::getFontType()
Returns
TypeDescription
integerOne of the TYPE_ constants defined in {@link Zend_Pdf_Font}.
methodpublicgetLineGap() : integer
inherited

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
TypeDescription
integer
methodpublicgetLineHeight() : integer
inherited

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
TypeDescription
integer
methodpublicgetStrikePosition() : integer
inherited

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

Inherited from: \Zend_Pdf_Resource_Font::getStrikePosition()
Returns
TypeDescription
integer
methodpublicgetStrikeThickness() : integer
inherited

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

Inherited from: \Zend_Pdf_Resource_Font::getStrikeThickness()
Returns
TypeDescription
integer
methodprivategetToUnicodeCMapData() : string
static

Generate ToUnicode character map data

Returns
TypeDescription
string
methodpublicgetUnderlinePosition() : integer
inherited

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
TypeDescription
integer
methodpublicgetUnderlineThickness() : integer
inherited

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

Inherited from: \Zend_Pdf_Resource_Font::getUnderlineThickness()
Returns
TypeDescription
integer
methodpublicgetUnitsPerEm() : integer
inherited

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 widthsForGlyphs() to calculate the with of a run of text.

Returns
TypeDescription
integer
methodpublicglyphNumberForCharacter(integer $characterCode) : integer

Returns the glyph number corresponding to the Unicode character.

Zend_Pdf uses 'Identity-H' encoding for Type 0 fonts. So we don't need to perform any conversion

Parameters
NameTypeDescription
$characterCodeinteger

Unicode character code (code point).

Returns
TypeDescription
integerGlyph number.
methodpublicglyphNumbersForCharacters(array $characterCodes) : array

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

Zend_Pdf uses 'Identity-H' encoding for Type 0 fonts. So we don't need to perform any conversion

See also glyphNumberForCharacter().

Parameters
NameTypeDescription
$characterCodesarray

Array of Unicode character codes (code points).

Returns
TypeDescription
arrayArray of glyph numbers.
methodpublicisBold() : boolean
inherited

Returns true if font is bold.

Inherited from: \Zend_Pdf_Resource_Font::isBold()
Returns
TypeDescription
boolean
methodpublicisItalic() : boolean
inherited

Returns true if font is italic.

Inherited from: \Zend_Pdf_Resource_Font::isItalic()
Returns
TypeDescription
boolean
methodpublicisMonospace() : boolean
inherited

Returns true if font is monospace.

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

Returns the width of the glyph.

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

Parameters
NameTypeDescription
$glyphNumberinteger
Returns
TypeDescription
integer
Throws
ExceptionDescription
\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 unitsPerEm().

Throws an exception if the glyph number is out of range.

See also widthForGlyph().

Parameters
NameTypeDescription
$glyphNumbersarray

&$glyphNumbers Array of glyph numbers.

Returns
TypeDescription
arrayArray of glyph widths (integers).
Throws
ExceptionDescription
\Zend_Pdf_Exception
Documentation was generated by phpDocumentor 2.0.0a12.