Pdf/Font.php

Show:

inherited

Classes
- \Zend_Pdf_Font

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: Font.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Pdf_Font
jump to top

Package: Zend\Pdf\Fonts

Abstract factory class which vends {@link Zend_Pdf_Resource_Font} objects.

Font objects themselves are normally instantiated through the factory methods fontWithName() or fontWithPath().

This class is also the home for font-related constants because the name of the true base class (Zend_Pdf_Resource_Font) is not intuitive for the end user.

Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                TYPE_UNKNOWN
                = 0

Unknown font type.

 
                TYPE_STANDARD
                = 1

One of the standard 14 PDF fonts.

 
                TYPE_TYPE_1
                = 2

A PostScript Type 1 font.

 
                TYPE_TRUETYPE
                = 3

A TrueType font or an OpenType font containing TrueType outlines.

 
                TYPE_TYPE_0
                = 4

Type 0 composite font.

 
                TYPE_CIDFONT_TYPE_0
                = 5

CID font containing a PostScript Type 1 font.

These fonts are used only to construct Type 0 composite fonts and can't be used directly

 
                TYPE_CIDFONT_TYPE_2
                = 6

CID font containing a TrueType font or an OpenType font containing TrueType outlines.

These fonts are used only to construct Type 0 composite fonts and can't be used directly

 
                FONT_COURIER
                = 'Courier'

Name of the standard PDF font Courier.

 
                FONT_COURIER_BOLD
                = 'Courier-Bold'

Name of the bold style of the standard PDF font Courier.

 
                FONT_COURIER_OBLIQUE
                = 'Courier-Oblique'

Name of the italic style of the standard PDF font Courier.

 
                FONT_COURIER_ITALIC
                = 'Courier-Oblique'

Convenience constant for a common misspelling of {@link FONT_COURIER_OBLIQUE}.

 
                FONT_COURIER_BOLD_OBLIQUE
                = 'Courier-BoldOblique'

Name of the bold and italic style of the standard PDF font Courier.

 
                FONT_COURIER_BOLD_ITALIC
                = 'Courier-BoldOblique'

Convenience constant for a common misspelling of {@link FONT_COURIER_BOLD_OBLIQUE}.

 
                FONT_HELVETICA
                = 'Helvetica'

Name of the standard PDF font Helvetica.

 
                FONT_HELVETICA_BOLD
                = 'Helvetica-Bold'

Name of the bold style of the standard PDF font Helvetica.

 
                FONT_HELVETICA_OBLIQUE
                = 'Helvetica-Oblique'

Name of the italic style of the standard PDF font Helvetica.

 
                FONT_HELVETICA_ITALIC
                = 'Helvetica-Oblique'

Convenience constant for a common misspelling of {@link FONT_HELVETICA_OBLIQUE}.

 
                FONT_HELVETICA_BOLD_OBLIQUE
                = 'Helvetica-BoldOblique'

Name of the bold and italic style of the standard PDF font Helvetica.

 
                FONT_HELVETICA_BOLD_ITALIC
                = 'Helvetica-BoldOblique'

Convenience constant for a common misspelling of {@link FONT_HELVETICA_BOLD_OBLIQUE}.

 
                FONT_SYMBOL
                = 'Symbol'

Name of the standard PDF font Symbol.

 
                FONT_TIMES_ROMAN
                = 'Times-Roman'

Name of the standard PDF font Times.

 
                FONT_TIMES
                = 'Times-Roman'

Convenience constant for a common misspelling of {@link FONT_TIMES_ROMAN}.

 
                FONT_TIMES_BOLD
                = 'Times-Bold'

Name of the bold style of the standard PDF font Times.

 
                FONT_TIMES_ITALIC
                = 'Times-Italic'

Name of the italic style of the standard PDF font Times.

 
                FONT_TIMES_BOLD_ITALIC
                = 'Times-BoldItalic'

Name of the bold and italic style of the standard PDF font Times.

 
                FONT_ZAPFDINGBATS
                = 'ZapfDingbats'

Name of the standard PDF font Zapf Dingbats.

 
                NAME_COPYRIGHT
                = 0

Full copyright notice for the font.

 
                NAME_FAMILY
                = 1

Font family name.

Used to group similar styles of fonts together.

 
                NAME_STYLE
                = 2

Font style within the font family.

Examples: Regular, Italic, Bold, etc.

 
                NAME_ID
                = 3

Unique font identifier.

 
                NAME_FULL
                = 4

Full font name.

Usually a combination of the NAME_FAMILY and NAME_STYLE strings.

 
                NAME_VERSION
                = 5

Version number of the font.

 
                NAME_POSTSCRIPT
                = 6

PostScript name for the font.

This is the name used to identify fonts internally and within the PDF file.

 
                NAME_TRADEMARK
                = 7

Font trademark notice.

This is distinct from the NAME_COPYRIGHT.

 
                NAME_MANUFACTURER
                = 8

Name of the font manufacturer.

 
                NAME_DESIGNER
                = 9

Name of the designer of the font.

 
                NAME_DESCRIPTION
                = 10

Description of the font.

May contain revision information, usage recommendations, features, etc.

 
                NAME_VENDOR_URL
                = 11

URL of the font vendor.

Some fonts may contain a unique serial number embedded in this URL, which is used for licensing.

 
                NAME_DESIGNER_URL
                = 12

URL of the font designer ({@link NAME_DESIGNER}).

 
                NAME_LICENSE
                = 13

Plain language licensing terms for the font.

 
                NAME_LICENSE_URL
                = 14

URL of more detailed licensing information for the font.

 
                NAME_PREFERRED_FAMILY
                = 16

Preferred font family.

Used by some fonts to work around a Microsoft Windows limitation where only four fonts styles can share the same NAME_FAMILY value.

 
                NAME_PREFERRED_STYLE
                = 17

Preferred font style.

A more descriptive string than NAME_STYLE.

 
                NAME_SAMPLE_TEXT
                = 19

Suggested text to use as a representative sample of the font.

 
                NAME_CID_NAME
                = 20

PostScript CID findfont name.

 
                WEIGHT_THIN
                = 100

Thin font weight.

 
                WEIGHT_EXTRA_LIGHT
                = 200

Extra-light (Ultra-light) font weight.

 
                WEIGHT_LIGHT
                = 300

Light font weight.

 
                WEIGHT_NORMAL
                = 400

Normal (Regular) font weight.

 
                WEIGHT_MEDIUM
                = 500

Medium font weight.

 
                WEIGHT_SEMI_BOLD
                = 600

Semi-bold (Demi-bold) font weight.

 
                WEIGHT_BOLD
                = 700

Bold font weight.

 
                WEIGHT_EXTRA_BOLD
                = 800

Extra-bold (Ultra-bold) font weight.

 
                WEIGHT_BLACK
                = 900

Black (Heavy) font weight.

 
                WIDTH_ULTRA_CONDENSED
                = 1

Ultra-condensed font width.

Typically 50% of normal.

 
                WIDTH_EXTRA_CONDENSED
                = 2

Extra-condensed font width.

Typically 62.5% of normal.

 
                WIDTH_CONDENSED
                = 3

Condensed font width.

Typically 75% of normal.

 
                WIDTH_SEMI_CONDENSED
                = 4

Semi-condensed font width.

Typically 87.5% of normal.

 
                WIDTH_NORMAL
                = 5

Normal (Medium) font width.

 
                WIDTH_SEMI_EXPANDED
                = 6

Semi-expanded font width.

Typically 112.5% of normal.

 
                WIDTH_EXPANDED
                = 7

Expanded font width.

Typically 125% of normal.

 
                WIDTH_EXTRA_EXPANDED
                = 8

Extra-expanded font width.

Typically 150% of normal.

 
                WIDTH_ULTRA_EXPANDED
                = 9

Ultra-expanded font width.

Typically 200% of normal.

 
                EMBED_DONT_EMBED
                = 1

Do not embed the font in the PDF document.

 
                EMBED_DONT_SUBSET
                = 2

Embed, but do not subset the font in the PDF document.

 
                EMBED_DONT_COMPRESS
                = 4

Embed, but do not compress the font in the PDF document.

 
                EMBED_SUPPRESS_EMBED_EXCEPTION
                = 8

Suppress the exception normally thrown if the font cannot be embedded due to its copyright bits being set.

Properties

array $_fontFilePaths = array()

static

Array whose keys are the md5 hash of the full paths on disk for parsed fonts.

The values are the font objects themselves.

Default valuearray()Details

Type: array

array $_fontNames = array()

static

Array whose keys are the unique PostScript names of instantiated fonts.

The values are the font objects themselves.

Default valuearray()Details

Type: array

Methods

_extractTrueTypeFont(\Zend_Pdf_FileParserDataSource $dataSource, integer $embeddingOptions) : \Zend_Pdf_Resource_Font_OpenType_TrueType

static

Attempts to extract a TrueType font from the data source.

If the font parser throws an exception that suggests the data source simply doesn't contain a TrueType font, catches it and returns null. If an exception is thrown that suggests the TrueType font is corrupt or otherwise unusable, throws that exception. If successful, returns the font object.

Parameters

Name	Type	Description
$dataSource	\Zend_Pdf_FileParserDataSource
$embeddingOptions	integer	Options for font embedding.

Returns

Type	Description
\Zend_Pdf_Resource_Font_OpenType_TrueType	May also return null if the data source does not appear to contain a TrueType font.

Throws

Exception	Description
\Zend_Pdf_Exception

fontWithName(string $name, integer $embeddingOptions = 0) : \Zend_Pdf_Resource_Font

static

Returns a {@link Zend_Pdf_Resource_Font} object by full name.

This is the preferred method to obtain one of the standard 14 PDF fonts.

The result of this method is cached, preventing unnecessary duplication of font objects. Repetitive calls for a font with the same name will return the same object.

The $embeddingOptions parameter allows you to set certain flags related to font embedding. You may combine options by OR-ing them together. See the EMBED_ constants defined in Zend_Pdf_Font for the list of available options and their descriptions. Note that this value is only used when creating a font for the first time. If a font with the same name already exists, you will get that object and the options you specify here will be ignored. This is because fonts are only embedded within the PDF file once.

If the font name supplied does not match the name of a previously instantiated object and it is not one of the 14 standard PDF fonts, an exception will be thrown.

Parameters

Name	Type	Description
$name	string	Full PostScript name of font.
$embeddingOptions	integer	(optional) Options for font embedding.

Returns

Type	Description
\Zend_Pdf_Resource_Font

Throws

Exception	Description
\Zend_Pdf_Exception

fontWithPath(string $filePath, integer $embeddingOptions = 0) : \Zend_Pdf_Resource_Font

static

Returns a {@link Zend_Pdf_Resource_Font} object by file path.

The result of this method is cached, preventing unnecessary duplication of font objects. Repetitive calls for the font with the same path will return the same object.

If the file path supplied does not match the path of a previously instantiated object or the font type cannot be determined, an exception will be thrown.

Parameters

Name	Type	Description
$filePath	string	Full path to the font file.
$embeddingOptions	integer	(optional) Options for font embedding.

Returns

Type	Description
\Zend_Pdf_Resource_Font

Throws

Exception	Description
\Zend_Pdf_Exception

Pdf/Font.php

\Zend_Pdf_Fontjump to top

Constants

Properties

Methods

\Zend_Pdf_Font
jump to top