Adobe PDF Simple fonts implementation
PDF simple fonts functionality is presented by Adobe Type 1 (including standard PDF Type1 built-in fonts) and TrueType fonts support.
Both fonts have the following properties:
Glyphs in the font are selected by single-byte character codes obtained from a string that is shown by the text-showing operators. Logically, these codes index into a table of 256 glyphs; the mapping from codes to glyphs is called the font’s encoding. PDF specification provides a possibility to specify any user defined encoding in addition to the standard built-in encodings: Standard-Encoding, MacRomanEncoding, WinAnsiEncoding, and PDFDocEncoding, but Zend_Pdf simple fonts implementation operates only with Windows ANSI encoding (except Symbol and ZapfDingbats built-in fonts).
The code in this class is common to both types. However, you will only deal directly with subclasses.
Font objects should be normally be obtained from the factory methods \Zend_Pdf_Font::fontWithName and \Zend_Pdf_Font::fontWithPath.
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 |
__clone()
__construct()
If resource is not a Zend_Pdf_Element object, then stream object with specified value is generated.
inherited_from | \Zend_Pdf_Resource_Font::__construct() |
---|
__construct(\Zend_Pdf_Element|string $resource)
If resource is not a Zend_Pdf_Element object, then stream object with specified value is generated.
\Zend_Pdf_Element
string
__toString() : string
string
decodeString(string $string, string $charEncoding) : string
The method is used to convert strings retrieved from existing content streams
inherited_from | \Zend_Pdf_Resource_Font::decodeString() |
---|
string
string
Character encoding of resulting text.
string
decodeString(string $string, string $charEncoding) : string
The method is used to convert strings retrieved from existing content streams
string
string
Character encoding of resulting text.
string
encodeString(string $string, string $charEncoding) : string
The method is used to prepare string for text drawing operators
inherited_from | \Zend_Pdf_Resource_Font::encodeString() |
---|
string
string
Character encoding of source text.
string
encodeString(string $string, string $charEncoding) : string
The method is used to prepare string for text drawing operators
string
string
Character encoding of source text.
string
getAscent() : integer
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.
integer
getCoveredPercentage(string $string, string $charEncoding = ''
) : float
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.
inherited_from | \Zend_Pdf_Resource_Font::getCoveredPercentage() |
---|
string
string
(optional) Character encoding of source text. If omitted, uses 'current locale'.
float
getCoveredPercentage(string $string, string $charEncoding = ''
) : float
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.
string
string
(optional) Character encoding of source text. If omitted, uses 'current locale'.
float
getDescent() : integer
The typographic descent is the distance below the font's baseline to the bottom of the text frame. It is always negative.
integer
getFontName(integer $nameType, mixed $language, string $characterSet = null
) : string
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.
integer
Type of name requested.
mixed
Preferred language (string) or array of languages in preferred order. Use the ISO 639 standard 2-letter language codes.
string
(optional) Desired resulting character set. You may use any character set supported by {@link iconv()};
string
getFontNames() : array
array
getFontType() : integer
integer
One of the TYPE_ constants defined in
{@link Zend_Pdf_Font}.getLineGap() : integer
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).
integer
getLineHeight() : integer
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.
integer
getStrikePosition() : integer
integer
getStrikeThickness() : integer
integer
getUnderlinePosition() : integer
This value is usually negative.
integer
getUnderlineThickness() : integer
integer
getUnitsPerEm() : integer
Used to convert glyph space to user space. Frequently used in conjunction with \widthsForGlyphs() to calculate the with of a run of text.
integer
glyphNumberForCharacter(integer $characterCode) : integer
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.
inherited_from | \Zend_Pdf_Resource_Font::glyphNumberForCharacter() |
---|
integer
Unicode character code (code point).
integer
Glyph number.glyphNumberForCharacter(integer $characterCode) : integer
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.
integer
Unicode character code (code point).
integer
Glyph number.glyphNumbersForCharacters(array $characterCodes) : array
If a particular character doesn't exist in this font, the special 'missing character glyph' will be substituted.
See also \glyphNumberForCharacter().
inherited_from | \Zend_Pdf_Resource_Font::glyphNumbersForCharacters() |
---|
array
Array of Unicode character codes (code points).
array
Array of glyph numbers.glyphNumbersForCharacters(array $characterCodes) : array
If a particular character doesn't exist in this font, the special 'missing character glyph' will be substituted.
See also \glyphNumberForCharacter().
array
Array of Unicode character codes (code points).
array
Array of glyph numbers.isBold() : boolean
boolean
isItalic() : boolean
boolean
isMonospace() : boolean
boolean
widthForGlyph(integer $glyphNumber) : integer
Like \widthsForGlyphs() but used for one glyph at a time.
inherited_from | \Zend_Pdf_Resource_Font::widthForGlyph() |
---|
integer
integer
widthForGlyph(integer $glyphNumber) : integer
Like \widthsForGlyphs() but used for one glyph at a time.
integer
\Zend_Pdf_Exception |
---|
integer
widthsForGlyphs(array $glyphNumbers) : array
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().
inherited_from | \Zend_Pdf_Resource_Font::widthsForGlyphs() |
---|
array
Array of glyph widths (integers).widthsForGlyphs(array $glyphNumbers) : array
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().
array
Array of glyph numbers.
\Zend_Pdf_Exception |
---|
array
Array of glyph widths (integers).$_ascent : integer
0
$_cmap : \Zend_Pdf_Cmap
null
$_descent : integer
0
$_fontNames : array
array()
$_fontType : integer
\Zend_Pdf_Font::TYPE_UNKNOWN
$_glyphWidths : array
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.
$_isBold : boolean
false
$_isItalic : boolean
false
$_isMonospace : boolean
false
$_lineGap : integer
0
$_missingGlyphWidth : integer
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.
$_objectFactory : \Zend_Pdf_ElementFactory_Interface
..) 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).
$_resource : \Zend_Pdf_Element_Object
$_strikePosition : integer
0
$_strikeThickness : integer
0
$_underlinePosition : integer
0
$_underlineThickness : integer
0
$_unitsPerEm : integer
0