API Documentation

Pdf/Resource/Font/Extracted.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Pdf
subpackage
Fonts
version
$Id: Extracted.php 20893 2010-02-03 22:59:25Z yoshida@zend.co.jp $
Classes
Zend_Pdf_Resource_Font_Extracted

Description

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.

Zend_Pdf_Resource_Font_Extracted
jump to top

Extends from
Zend_Pdf_Resource_Font
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Pdf
subpackage
Fonts
Constants
TYPE_NOT_SUPPORTED
ENCODING_NOT_SUPPORTED
OPERATION_NOT_SUPPORTED
Properties
$_encoding
Methods
__construct
glyphNumbersForCharacters
glyphNumberForCharacter
getCoveredPercentage
widthsForGlyphs
widthForGlyph
encodeString
decodeString

Description

Extracted fonts implementation

Thes class allows to extract fonts already mentioned within PDF document and use them for text drawing.

Constants

TYPE_NOT_SUPPORTED
jump to class

 TYPE_NOT_SUPPORTED = 'Unsupported font type.'

Messages

Details

value
Unsupported font type.

ENCODING_NOT_SUPPORTED
jump to class

 ENCODING_NOT_SUPPORTED = 'Font encoding is not supported'

Details

value
Font encoding is not supported

OPERATION_NOT_SUPPORTED
jump to class

 OPERATION_NOT_SUPPORTED = 'Operation is not supported for extracted fonts'

Details

value
Operation is not supported for extracted fonts

Properties

$_encoding
jump to class

string $_encoding = 'null'

Extracted font encoding

Only 'Identity-H' and 'WinAnsiEncoding' encodings are supported now

Details

$_encoding
string
visibility
protected
default
null
final
false
static
false

Methods

__construct
jump to class

__construct( mixed $fontDictionary ) :

Object constructor

$fontDictionary is a Zend_Pdf_Element_Reference or Zend_Pdf_Element_Object object

Arguments
$fontDictionary
mixed
Details
visibility
public
final
false
static
false
throws

decodeString
jump to class

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

Convert string from the font encoding.

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

Arguments
$string
string
$charEncoding
string
Character encoding of resulting text.
Output
string
Details
visibility
public
final
false
static
false

encodeString
jump to class

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

Convert string to the font encoding.

The method is used to prepare string for text drawing operators

Arguments
$string
string
$charEncoding
string
Character encoding of source text.
Output
string
Details
visibility
public
final
false
static
false

getCoveredPercentage
jump to class

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.

Arguments
$string
string
$charEncoding
string
(optional) Character encoding of source text. If omitted, uses 'current locale'.
Output
float
Details
visibility
public
final
false
static
false

glyphNumberForCharacter
jump to class

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 {@link glyphNumbersForCharacters()} which is optimized for bulk operations.

Arguments
$characterCode
integer
Unicode character code (code point).
Output
integer
Glyph number.
Details
visibility
public
final
false
static
false

glyphNumbersForCharacters
jump to class

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 {@link glyphNumberForCharacter()}.

Arguments
$characterCodes
array
Array of Unicode character codes (code points).
Output
array
Array of glyph numbers.
Details
visibility
public
final
false
static
false

widthForGlyph
jump to class

widthForGlyph( integer $glyphNumber ) : integer

Returns the width of the glyph.

Like {@link widthsForGlyphs()} but used for one glyph at a time.

Arguments
$glyphNumber
integer
Output
integer
Details
visibility
public
final
false
static
false
throws

widthsForGlyphs
jump to class

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 {@link unitsPerEm()}.

See also {@link widthForGlyph()}.

Arguments
$glyphNumbers
array
Array of glyph numbers.
Output
array
Array of glyph widths (integers).
Details
visibility
public
final
false
static
false
throws
Documentation was generated by DocBlox.