SetaPDF_Core_Font_Simple Abstract class for simple fonts.

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

9.5 Introduction to Font Data Structures: "[...]Type 0 fonts are called composite fonts; other types of fonts are called simple fonts.[...]"

Class hierarchy

Implements

Summary

Static Properties

$_fonts

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

An array caching font objects


Properties

$_avgWidth

protected integer|float SetaPDF_Core_Font_Simple::$_avgWidth

The average width of glyphs in the font.

$_charCodeCache

protected array SetaPDF_Core_Font_Simple::$_charCodeCache = array()

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

$_dictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Font_Simple::$_dictionary

The font dictionary

$_encodingTable

protected array SetaPDF_Core_Font_Simple::$_encodingTable

The encoding table

$_glyphsWidthCache

protected array SetaPDF_Core_Font_Simple::$_glyphsWidthCache = array()

Cache for glyph widths

$_indirectObject

protected SetaPDF_Core_Type_IndirectObject SetaPDF_Core_Font_Simple::$_indirectObject

The indirect object of the font

$_info

protected array SetaPDF_Core_Font_Simple::$_info = array()

Array holding information about the font

$_substituteCharacter

protected string SetaPDF_Core_Font_Simple::$_substituteCharacter

The substitute character in a fonts specific encoding.

$_toUnicodeTable

protected array SetaPDF_Core_Font_Simple::$_toUnicodeTable

The map that maps character codes to uncidoe values

$_widths

protected array SetaPDF_Core_Font_Simple::$_widths

Glyph withds

$_widthsByCharCode

protected array SetaPDF_Core_Font_Simple::$_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()

abstract protected SetaPDF_Core_Font_Simple::_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()

abstract public SetaPDF_Core_Font::getAscent (
void
): float

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

getAvgWidth()

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

Get the average glyph width.

Parameters
$calculateIfUndefined : boolean
 

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

abstract public SetaPDF_Core_Font::getDescent (
void
): float

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

getDictionary()

Get the font dictionary.

getFontBBox()

abstract public SetaPDF_Core_Font::getFontBBox (
void
): array

Returns the font bounding box.

Return Values

Format is [llx lly urx ury]

getFontFamily()

abstract public SetaPDF_Core_Font::getFontFamily (
void
): string

Get the font family.

getFontName()

abstract public SetaPDF_Core_Font::getFontName (
void
): string

Get the font name.

getGlyphWidth()

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

Get the width of a glyph/character.

Parameters
$char : string

The character

$encoding : string

The input encoding

getGlyphWidthByCharCode()

public SetaPDF_Core_Font::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()

abstract public SetaPDF_Core_Font::getItalicAngle (
void
): float

Returns the italic angle.

getMaxWidth()

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

Get the max. glyph width.

getMissingWidth()

public SetaPDF_Core_Font::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()

abstract public SetaPDF_Core_Font::isBold (
void
): boolean

Checks if the font is bold.

isItalic()

abstract public SetaPDF_Core_Font::isItalic (
void
): boolean

Checks if the font is italic.

isMonospace()

abstract public SetaPDF_Core_Font::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