API Documentation

Zend/Pdf/Resource/Font/Extracted.php

Show: inherited
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: Extracted.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Pdf_Resource_Font_Extracted

Package: Zend\Pdf\Fonts

Extracted 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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  TYPE_NOT_SUPPORTED = 'Unsupported font type.'

Messages

Constant  ENCODING_NOT_SUPPORTED = 'Font encoding is not supported'
Constant  OPERATION_NOT_SUPPORTED = 'Operation is not supported for extracted fonts'

Properties

Propertyprotectedstring  $_encoding= 'null'

Extracted font encoding

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

Default valuenullDetails
Type
string

Methods

methodpublic__construct( mixed $fontDictionary ) : void

Object constructor

$fontDictionary is a Zend_Pdf_Element_Reference or Zend_Pdf_Element_Object object

Parameters
Name Type Description
$fontDictionary mixed
Throws
Exception Description
\Zend_Pdf_Exception
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
Name Type Description
$string string
$charEncoding string

Character encoding of resulting text.

Returns
Type Description
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
Name Type Description
$string string
$charEncoding string

Character encoding of source text.

Returns
Type Description
string
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
Name Type Description
$string string
$charEncoding string

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

Returns
Type Description
float
methodpublicglyphNumberForCharacter( 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.

Parameters
Name Type Description
$characterCode integer

Unicode character code (code point).

Returns
Type Description
integer Glyph number.
methodpublicglyphNumbersForCharacters( 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()}.

Parameters
Name Type Description
$characterCodes array

Array of Unicode character codes (code points).

Returns
Type Description
array Array of glyph numbers.
methodpublicwidthForGlyph( integer $glyphNumber ) : integer

Returns the width of the glyph.

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

Parameters
Name Type Description
$glyphNumber integer
Returns
Type Description
integer
Throws
Exception Description
\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 {@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
Exception Description
\Zend_Pdf_Exception
Documentation was generated by DocBlox 0.15.1.