SetaPDF_Core_Font_Type1 Class for Type1 fonts

File: /SetaPDF v2/Core/Font/Type1.php

Class hierarchy

Implements

Summary

Static Properties

$_fonts

static protected array SetaPDF_Core_Font_Type1::$_fonts = array()

An array caching font objects


Properties

$_avgWidth

protected integer|float SetaPDF_Core_Font_Type1::$_avgWidth

The average width of glyphs in the font.

$_charCodeCache

protected array SetaPDF_Core_Font_Type1::$_charCodeCache = array()

A char code cache which is used in SetaPDF_Core_Font::getCharByCharCode().

$_dictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Font_Type1::$_dictionary

The font dictionary

$_encodingTable

protected array SetaPDF_Core_Font_Type1::$_encodingTable

The encoding table

$_fontDescriptor

protected SetaPDF_Core_Font_Descriptor SetaPDF_Core_Font_Type1::$_fontDescriptor

The font descriptor object

$_glyphsWidthCache

protected array SetaPDF_Core_Font_Type1::$_glyphsWidthCache = array()

A cache of width values

$_indirectObject

protected SetaPDF_Core_Type_IndirectObject SetaPDF_Core_Font_Type1::$_indirectObject

The indirect object of the font

$_info

protected array SetaPDF_Core_Font_Type1::$_info = array()

Array holding information about the font

$_substituteCharacter

protected null|string SetaPDF_Core_Font_Type1::$_substituteCharacter

The UTF-16BE unicode value for a substitute character

$_toUnicodeTable

protected array SetaPDF_Core_Font_Type1::$_toUnicodeTable

The map that maps character codes to uncidoe values

$_widths

protected array SetaPDF_Core_Font_Type1::$_widths

Glyph widths

$_widthsByCharCode

protected array SetaPDF_Core_Font_Type1::$_widthsByCharCode

Widths by char codes


Static Methods

freeCache()

public static SetaPDF_Core_Font::freeCache (): void

Release font instances by a document instance.

Parameters
$document : SetaPDF_Core_Document
 

freeFontCache()

public static SetaPDF_Core_Font::freeFontCache (): void

Release font instances by a document instance.

Parameters
$document : SetaPDF_Core_Document
 
See

get()

Get a font object by an indirect reference.

The needed font object class is automatically resolve via the Subtype value of the font dictionary.

Parameters
$indirectObjectOrDictionary : SetaPDF_Core_Type_IndirectObjectInterface
 
Exceptions

Throws SetaPDF_Exception_NotImplemented

Throws SetaPDF_Core_Font_Exception


Methods

__construct()

_getCharCodesTable()

Get the map that maps character codes to unicode values.

_getEncodingTable()

protected SetaPDF_Core_Font_Simple::_getEncodingTable (
void
): array

Get the encoding table based on the Encoding dictionary and it's Differences entry (if available).

_getWidths()

protected SetaPDF_Core_Font_Type1::_getWidths (
void
): void

Resolves the width values from the font descriptor and fills the $_width-array.

_sortByArray()

protected SetaPDF_Core_Font_Simple::_sortByArray (
$array
): array

Sorts an array by shifting the array values to the top of the resulting array.

Parameters
$array
 

getAscent()

public SetaPDF_Core_Font_Type1::getAscent (
void
): float

Returns the distance from baseline of highest ascender (Typographic ascent).

getAvgWidth()

public SetaPDF_Core_Font_Type1::getAvgWidth (
[ boolean $calculateIfUndefined = false ]
): integer|float

Get the average glyph width.

Parameters
$calculateIfUndefined : boolean
 

getBaseEncodingTable()

Get the base encoding of the font.

If no BaseEncoding entry is available we use the Standard encoding for now. This should be extended to get the fonts build in encoding later.

getCharByCharCode()

public SetaPDF_Core_Font::getCharByCharCode (
string $charCode [, string $encoding = 'UTF-8' ]
): string

Converts a char code from the font specific encoding to another encoding.

Parameters
$charCode : string

The char code in the font specific encoding.

$encoding : string

The resulting encoding

getCharCode()

public SetaPDF_Core_Font::getCharCode (
string $char [, string $encoding = 'UTF-16BE' ]
): string

Get the final character code of a single character.

Parameters
$char : string

The character

$encoding : string

The output encoding

getCharCodes()

public SetaPDF_Core_Font::getCharCodes (
string $chars [, string $encoding = 'UTF-16BE' ]
): array

Get the final character codes of a character string.

Parameters
$chars : string

The character string

$encoding : string

The output encoding

getCharsByCharCodes()

public SetaPDF_Core_Font::getCharsByCharCodes (
string $charCodes [, string $encoding = 'UTF-8' [, bool $asArray = true ]]
): string|array

Converts char codes from the font specific encoding to another encoding.

Parameters
$charCodes : string

The char codes in the font specific encoding.

$encoding : string

The resulting encoding

$asArray : bool
 

getDescent()

public SetaPDF_Core_Font_Type1::getDescent (
void
): float

Returns the distance from baseline of lowest descender (Typographic descent).

getDictionary()

Get the font dictionary.

getFontBBox()

public SetaPDF_Core_Font_Type1::getFontBBox (
void
): array

Returns the font bounding box.

getFontDescriptor()

Get the font descriptor object.

getFontFamily()

public SetaPDF_Core_Font_Type1::getFontFamily (
void
): string

Get the font family.

getFontName()

public SetaPDF_Core_Font_Type1::getFontName (
void
): string

Get the font name.

getGlyphWidth()

public SetaPDF_Core_Font_Type1::getGlyphWidth (
string $char [, string $encoding = 'UTF-16BE' ]
): float|int

Get the width of a glyph/character.

Parameters
$char : string
 
$encoding : string

The input encoding

See

getGlyphWidthByCharCode()

public SetaPDF_Core_Font_Type1::getGlyphWidthByCharCode (
string $charCode
): float|int

Get the width of a glpyh by its char code.

Parameters
$charCode : string
 

getGlyphsWidth()

public SetaPDF_Core_Font::getGlyphsWidth (
string $chars [, string $encoding = 'UTF-16BE' ]
): float|int

Get the width of the glyphs/characters.

Parameters
$chars : string

The characters

$encoding : string

The input encoding

getGlyphsWidthByCharCodes()

public SetaPDF_Core_Font::getGlyphsWidthByCharCodes (
string $charCodes
): float|int

Get the width of glyphs by their char codes.

Parameters
$charCodes : string
 

getIndirectObject()

getInfo()

public SetaPDF_Core_Font::getInfo (
string $name
): bool|string

Get information about the font.

Parameters
$name : string

The name of the font

getItalicAngle()

public SetaPDF_Core_Font_Type1::getItalicAngle (
void
): float

Returns the italic angle.

getMaxWidth()

public SetaPDF_Core_Font_Type1::getMaxWidth (
void
): integer|float

Get the max glyph width.

getMissingWidth()

public SetaPDF_Core_Font_Type1::getMissingWidth (
void
): integer|float

Get the missing glyph width.

getResourceType()

public SetaPDF_Core_Font::getResourceType (
void
): string

Get the resource type.

See

getType()

public SetaPDF_Core_Font::getType (
void
): mixed

Get the Subtype entry of the font dictionary.

isBold()

public SetaPDF_Core_Font_Type1::isBold (
void
): boolean

Checks if the font is bold.

isItalic()

public SetaPDF_Core_Font_Type1::isItalic (
void
): boolean

Checks if the font is italic.

isMonospace()

public SetaPDF_Core_Font_Type1::isMonospace (
void
): boolean

Checks if the font is monospace.

splitCharCodes()

public SetaPDF_Core_Font::splitCharCodes (
string $charCodes
): array

Split a string of char codes into single char codes.

Parameters
$charCodes : string