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
[email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Pdf
- Subpackage
- Fonts
- Version
- $Id$
\Zend_Pdf_Resource_Font_Extracted
Package: Zend_Pdf\FontsExtracted fonts implementation
Thes class allows to extract fonts already mentioned within PDF document and use them
for text drawing.
- Parent(s)
- \Zend_Pdf_Resource_Font
<
\Zend_Pdf_Resource
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
ENCODING_NOT_SUPPORTED
= 'Font encoding is not supported'
OPERATION_NOT_SUPPORTED
= 'Operation is not supported for extracted fonts'Properties
Methods
decodeString(string $string, string $charEncoding) : stringConvert 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. |
|---|
ReturnsencodeString(string $string, string $charEncoding) : stringConvert 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. |
|---|
ReturnsgetCoveredPercentage(string $string, string $charEncoding = '') : floatReturns 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'. |
|---|
ReturnsglyphNumberForCharacter(integer $characterCode) : integerReturns 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. |
glyphNumbersForCharacters(array $characterCodes) : arrayReturns 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. |
widthForGlyph(integer $glyphNumber) : integerReturns the width of the glyph.
Like {@link widthsForGlyphs()} but used for one glyph at a time.
Parameters| Name | Type | Description |
|---|
| $glyphNumber | integer | |
|---|
ReturnsThrowswidthsForGlyphs(array $glyphNumbers) : arrayReturns 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 
inherited
Classes
