Pdf/Resource/Font/Extracted.php

Show: PublicProtectedPrivateinherited
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 [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\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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  TYPE_NOT_SUPPORTED = 'Unsupported font type.'
Messages
>VConstant  ENCODING_NOT_SUPPORTED = 'Font encoding is not supported'
>VConstant  OPERATION_NOT_SUPPORTED = 'Operation is not supported for extracted fonts'

Properties

>VPropertyprotectedstring $_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
NameTypeDescription
$fontDictionarymixed
Throws
ExceptionDescription
\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
NameTypeDescription
$stringstring
$charEncodingstring

Character encoding of resulting text.

Returns
TypeDescription
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
NameTypeDescription
$stringstring
$charEncodingstring

Character encoding of source text.

Returns
TypeDescription
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
NameTypeDescription
$stringstring
$charEncodingstring

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

Returns
TypeDescription
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
NameTypeDescription
$characterCodeinteger

Unicode character code (code point).

Returns
TypeDescription
integerGlyph 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
NameTypeDescription
$characterCodesarray

Array of Unicode character codes (code points).

Returns
TypeDescription
arrayArray 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
NameTypeDescription
$glyphNumberinteger
Returns
TypeDescription
integer
Throws
ExceptionDescription
\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
NameTypeDescription
$glyphNumbersarray

Array of glyph numbers.

Returns
TypeDescription
arrayArray of glyph widths (integers).
Throws
ExceptionDescription
\Zend_Pdf_Exception
Documentation was generated by phpDocumentor 2.2.0 .