Pdf/Resource/Font/Extracted.php

Show:

inherited

Classes
- \Zend_Pdf_Resource_Font_Extracted

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-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Pdf
Subpackage: Fonts
Version: $Id: Extracted.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Pdf_Resource_Font_Extracted
jump to top

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

 
                TYPE_NOT_SUPPORTED
                = 'Unsupported font type.'

Messages

 
                ENCODING_NOT_SUPPORTED
                = 'Font encoding is not supported'

 
                OPERATION_NOT_SUPPORTED
                = 'Operation is not supported for extracted fonts'

Properties

integer $_ascent = 0

inherited

Typographical ascent.

Inherited from: \Zend_Pdf_Resource_Font::$$_ascent

See getAscent().

Default value0Details

Type: integer
Inherited_from: \Zend_Pdf_Resource_Font::$$_ascent

integer $_descent = 0

inherited

Typographical descent.

Inherited from: \Zend_Pdf_Resource_Font::$$_descent

See getDescent().

Default value0Details

Type: integer
Inherited_from: \Zend_Pdf_Resource_Font::$$_descent

string $_encoding = null

Extracted font encoding

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

Default valuenullDetails

Type: string

array $_fontNames = array()

inherited

Array containing descriptive names for the font.

Inherited from: \Zend_Pdf_Resource_Font::$$_fontNames

See fontName().

Default valuearray()Details

Type: array
Inherited_from: \Zend_Pdf_Resource_Font::$$_fontNames

integer $_fontType = \Zend_Pdf_Font::TYPE_UNKNOWN

inherited

The type of font.

Inherited from: \Zend_Pdf_Resource_Font::$$_fontType

Use TYPE_ constants defined in Zend_Pdf_Font.

Default value\Zend_Pdf_Font::TYPE_UNKNOWNDetails

Type: integer
Inherited_from: \Zend_Pdf_Resource_Font::$$_fontType

boolean $_isBold = false

inherited

Flag indicating whether or not this font is bold.

Inherited from: \Zend_Pdf_Resource_Font::$$_isBold

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Pdf_Resource_Font::$$_isBold

boolean $_isItalic = false

inherited

Flag indicating whether or not this font is italic.

Inherited from: \Zend_Pdf_Resource_Font::$$_isItalic

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Pdf_Resource_Font::$$_isItalic

boolean $_isMonospace = false

inherited

Flag indicating whether or not this font is monospaced.

Inherited from: \Zend_Pdf_Resource_Font::$$_isMonospace

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Pdf_Resource_Font::$$_isMonospace

integer $_lineGap = 0

inherited

Typographical line gap.

Inherited from: \Zend_Pdf_Resource_Font::$$_lineGap

See getLineGap().

Default value0Details

Type: integer
Inherited_from: \Zend_Pdf_Resource_Font::$$_lineGap

\Zend_Pdf_ElementFactory_Interface $_objectFactory =

inherited

Each Pdf resource (fonts, images, .

Inherited from: \Zend_Pdf_Resource::$$_objectFactory \Zend_Pdf_Resource_Font::$$_objectFactory

..) 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).

Details

Type: \Zend_Pdf_ElementFactory_Interface
Inherited_from: \Zend_Pdf_Resource::$$_objectFactory
Inherited_from: \Zend_Pdf_Resource_Font::$$_objectFactory

\Zend_Pdf_Element_Object $_resource =

inherited

Main resource object

Inherited from: \Zend_Pdf_Resource::$$_resource \Zend_Pdf_Resource_Font::$$_resource

Details

Type: \Zend_Pdf_Element_Object
Inherited_from: \Zend_Pdf_Resource::$$_resource
Inherited_from: \Zend_Pdf_Resource_Font::$$_resource

integer $_strikePosition = 0

inherited

The position above the text baseline of the strikethrough (in glyph units).

Inherited from: \Zend_Pdf_Resource_Font::$$_strikePosition

Default value0Details

Type: integer
Inherited_from: \Zend_Pdf_Resource_Font::$$_strikePosition

integer $_strikeThickness = 0

inherited

The thickness of the strikethrough (in glyph units).

Inherited from: \Zend_Pdf_Resource_Font::$$_strikeThickness

Default value0Details

Type: integer
Inherited_from: \Zend_Pdf_Resource_Font::$$_strikeThickness

integer $_underlinePosition = 0

inherited

The position below the text baseline of the underline (in glyph units).

Inherited from: \Zend_Pdf_Resource_Font::$$_underlinePosition

Default value0Details

Type: integer
Inherited_from: \Zend_Pdf_Resource_Font::$$_underlinePosition

integer $_underlineThickness = 0

inherited

The thickness of the underline (in glyph units).

Inherited from: \Zend_Pdf_Resource_Font::$$_underlineThickness

Default value0Details

Type: integer
Inherited_from: \Zend_Pdf_Resource_Font::$$_underlineThickness

integer $_unitsPerEm = 0

inherited

Number of glyph units per em.

Inherited from: \Zend_Pdf_Resource_Font::$$_unitsPerEm

See getUnitsPerEm().

Default value0Details

Type: integer
Inherited_from: \Zend_Pdf_Resource_Font::$$_unitsPerEm

Methods

__clone() : void

inherited

Clone page, extract it and dependent objects from the current document, so it can be used within other docs.

Inherited from: \Zend_Pdf_Resource::__clone()\Zend_Pdf_Resource_Font::__clone()

__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

__toString() : string

inherited

Returns the full name of the font in the encoding method of the current locale.

Inherited from: \Zend_Pdf_Resource_Font::__toString()

Transliterates any characters that cannot be naturally represented in that character set.

Returns

Type	Description
string

decodeString(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

encodeString(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

getAscent() : integer

inherited

Returns the typographic ascent in font glyph units.

Inherited from: \Zend_Pdf_Resource_Font::getAscent()

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.

Returns

Type	Description
integer

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.

Parameters

Name	Type	Description
$string	string
$charEncoding	string	(optional) Character encoding of source text. If omitted, uses 'current locale'.

Returns

Type	Description
float

getDescent() : integer

inherited

Returns the typographic descent in font glyph units.

Inherited from: \Zend_Pdf_Resource_Font::getDescent()

The typographic descent is the distance below the font's baseline to the bottom of the text frame. It is always negative.

Returns

Type	Description
integer

getFontName(integer $nameType, mixed $language, string $characterSet = null) : string

inherited

Returns the specified descriptive name for the font.

Inherited from: \Zend_Pdf_Resource_Font::getFontName()

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.

Parameters

Name	Type	Description
$nameType	integer	Type of name requested.
$language	mixed	Preferred language (string) or array of languages in preferred order. Use the ISO 639 standard 2-letter language codes.
$characterSet	string	(optional) Desired resulting character set. You may use any character set supported by {@link iconv()};

Returns

Type	Description
string

getFontNames() : array

inherited

Returns whole set of font names.

Inherited from: \Zend_Pdf_Resource_Font::getFontNames()

Returns

Type	Description
array

getFontType() : integer

inherited

Returns the type of font.

Inherited from: \Zend_Pdf_Resource_Font::getFontType()

Returns

Type	Description
integer	One of the TYPE_ constants defined in {@link Zend_Pdf_Font}.

getLineGap() : integer

inherited

Returns the typographic line gap in font glyph units.

Inherited from: \Zend_Pdf_Resource_Font::getLineGap()

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).

Returns

Type	Description
integer

getLineHeight() : integer

inherited

Returns the suggested line height (or leading) in font glyph units.

Inherited from: \Zend_Pdf_Resource_Font::getLineHeight()

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.

Returns

Type	Description
integer

getStrikePosition() : integer

inherited

Returns the suggested position above the text baseline of the strikethrough in glyph units.

Inherited from: \Zend_Pdf_Resource_Font::getStrikePosition()

Returns

Type	Description
integer

getStrikeThickness() : integer

inherited

Returns the suggested line thickness of the strikethrough in glyph units.

Inherited from: \Zend_Pdf_Resource_Font::getStrikeThickness()

Returns

Type	Description
integer

getUnderlinePosition() : integer

inherited

Returns the suggested position below the text baseline of the underline in glyph units.

Inherited from: \Zend_Pdf_Resource_Font::getUnderlinePosition()

This value is usually negative.

Returns

Type	Description
integer

getUnderlineThickness() : integer

inherited

Returns the suggested line thickness of the underline in glyph units.

Inherited from: \Zend_Pdf_Resource_Font::getUnderlineThickness()

Returns

Type	Description
integer

getUnitsPerEm() : integer

inherited

Returns the number of glyph units per em.

Inherited from: \Zend_Pdf_Resource_Font::getUnitsPerEm()

Used to convert glyph space to user space. Frequently used in conjunction with widthsForGlyphs() to calculate the with of a run of text.

Returns

Type	Description
integer

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 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) : 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.

Pdf/Resource/Font/Extracted.php

\Zend_Pdf_Resource_Font_Extractedjump to top

Constants

Properties

Methods

\Zend_Pdf_Resource_Font_Extracted
jump to top