Pdf/Resource/Font.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 [email protected] 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 24593 2012-01-05 20:35:02Z matthew $
\Zend_Pdf_Resource_Font
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 Zend_Pdf_Font::fontWithName and 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


integer $_fontType = \Zend_Pdf_Font::TYPE_UNKNOWN
The type of font.
Use TYPE_ constants defined in Zend_Pdf_Font.
\Zend_Pdf_Font::TYPE_UNKNOWN
Details- Type
- integer


boolean $_isBold = false
Flag indicating whether or not this font is bold.
false
Details- Type
- boolean


boolean $_isItalic = false
Flag indicating whether or not this font is italic.
false
Details- Type
- boolean


boolean $_isMonospace = false
Flag indicating whether or not this font is monospaced.
false
Details- Type
- boolean


\Zend_Pdf_ElementFactory_Interface $_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).
- Type
- \Zend_Pdf_ElementFactory_Interface
- Inherited_from
- \Zend_Pdf_Resource::$$_objectFactory


\Zend_Pdf_Element_Object $_resource =
- Type
- \Zend_Pdf_Element_Object
- Inherited_from
- \Zend_Pdf_Resource::$$_resource


integer $_strikePosition = 0
The position above the text baseline of the strikethrough (in glyph units).
0
Details- Type
- integer


integer $_strikeThickness = 0
The thickness of the strikethrough (in glyph units).
0
Details- Type
- integer


integer $_underlinePosition = 0
The position below the text baseline of the underline (in glyph units).
0
Details- Type
- integer


integer $_underlineThickness = 0
The thickness of the underline (in glyph units).
0
Details- Type
- integer
Methods


__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()

__construct() : void
Object constructor.
If resource is not a Zend_Pdf_Element object, then stream object with specified value is generated.


__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.
Type | Description |
---|---|
string |


decodeString(string $string, string $charEncoding) : string
Convert string from the font encoding.
The method is used to convert strings retrieved from existing content streams
Name | Type | Description |
---|---|---|
$string | string | |
$charEncoding | string | Character encoding of resulting text. |
Type | Description |
---|---|
string |


encodeString(string $string, string $charEncoding) : string
Convert string to the font encoding.
The method is used to prepare string for text drawing operators
Name | Type | Description |
---|---|---|
$string | string | |
$charEncoding | string | Character encoding of source text. |
Type | Description |
---|---|
string |


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


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.
Name | Type | Description |
---|---|---|
$string | string | |
$charEncoding | string | (optional) Character encoding of source text. If omitted, uses 'current locale'. |
Type | Description |
---|---|
float |


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


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:
- Zend_Pdf_Font::NAME_FULL
- Zend_Pdf_Font::NAME_FAMILY
- Zend_Pdf_Font::NAME_PREFERRED_FAMILY
- Zend_Pdf_Font::NAME_STYLE
- Zend_Pdf_Font::NAME_PREFERRED_STYLE
- Zend_Pdf_Font::NAME_DESCRIPTION
- Zend_Pdf_Font::NAME_SAMPLE_TEXT
- Zend_Pdf_Font::NAME_ID
- Zend_Pdf_Font::NAME_VERSION
- Zend_Pdf_Font::NAME_POSTSCRIPT
- Zend_Pdf_Font::NAME_CID_NAME
- Zend_Pdf_Font::NAME_DESIGNER
- Zend_Pdf_Font::NAME_DESIGNER_URL
- Zend_Pdf_Font::NAME_MANUFACTURER
- Zend_Pdf_Font::NAME_VENDOR_URL
- Zend_Pdf_Font::NAME_COPYRIGHT
- Zend_Pdf_Font::NAME_TRADEMARK
- Zend_Pdf_Font::NAME_LICENSE
- 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.
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()}; |
Type | Description |
---|---|
string |


getFontType() : integer
Returns the type of font.
Type | Description |
---|---|
integer | One of the TYPE_ constants defined in {@link Zend_Pdf_Font}. |


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).
Type | Description |
---|---|
integer |


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


getStrikePosition() : integer
Returns the suggested position above the text baseline of the strikethrough in glyph units.
Type | Description |
---|---|
integer |


getStrikeThickness() : integer
Returns the suggested line thickness of the strikethrough in glyph units.
Type | Description |
---|---|
integer |


getUnderlinePosition() : integer
Returns the suggested position below the text baseline of the underline in glyph units.
This value is usually negative.
Type | Description |
---|---|
integer |


getUnderlineThickness() : integer
Returns the suggested line thickness of the underline in glyph units.
Type | Description |
---|---|
integer |


getUnitsPerEm() : integer
Returns the number of glyph units per em.
Used to convert glyph space to user space. Frequently used in conjunction with widthsForGlyphs() to calculate the with of a run of text.
Type | Description |
---|---|
integer |


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 glyphNumbersForCharacters() which is optimized for bulk operations.
Name | Type | Description |
---|---|---|
$characterCode | integer | Unicode character code (code point). |
Type | Description |
---|---|
integer | Glyph number. |


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 glyphNumberForCharacter().
Name | Type | Description |
---|---|---|
$characterCodes | array | Array of Unicode character codes (code points). |
Type | Description |
---|---|
array | Array of glyph numbers. |


widthForGlyph(integer $glyphNumber) : integer
Returns the width of the glyph.
Like widthsForGlyphs() but used for one glyph at a time.
Name | Type | Description |
---|---|---|
$glyphNumber | integer |
Type | Description |
---|---|
integer |
Exception | Description |
---|---|
\Zend_Pdf_Exception |


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 unitsPerEm().
See also widthForGlyph().
Name | Type | Description |
---|---|---|
$glyphNumbers | array | Array of glyph numbers. |
Type | Description |
---|---|
array | Array of glyph widths (integers). |
Exception | Description |
---|---|
\Zend_Pdf_Exception |