SetaPDF_Core_Font Abstract class representing a Font

File: /SetaPDF v2/Core/Font.php

Class hierarchy

Implements

Summary

Constants

INFO_COPYRIGHT

const string SetaPDF_Core_Font::INFO_COPYRIGHT = 'copyright'

Info constant

INFO_CREATION_DATE

const string SetaPDF_Core_Font::INFO_CREATION_DATE = 'creationDate'

Info constant

INFO_UNIQUE_ID

const string SetaPDF_Core_Font::INFO_UNIQUE_ID = 'uniqueId'

Info constant

INFO_VERSION

const string SetaPDF_Core_Font::INFO_VERSION = 'version'

Info constant

TYPE_COLOR_SPACE

const SetaPDF_Core_Font::TYPE_COLOR_SPACE = 'ColorSpace'

TYPE_EXT_G_STATE

const SetaPDF_Core_Font::TYPE_EXT_G_STATE = 'ExtGState'

TYPE_FONT

TYPE_PATTERN

const SetaPDF_Core_Font::TYPE_PATTERN = 'Pattern'

TYPE_PROC_SET

const SetaPDF_Core_Font::TYPE_PROC_SET = 'ProcSet'

TYPE_PROPERTIES

const SetaPDF_Core_Font::TYPE_PROPERTIES = 'Properties'

TYPE_SHADING

const SetaPDF_Core_Font::TYPE_SHADING = 'Shading'

TYPE_X_OBJECT

const SetaPDF_Core_Font::TYPE_X_OBJECT = 'XObject'


Static Properties

$_fonts

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

An array caching font objects


Properties

$_charCodeCache

protected array SetaPDF_Core_Font::$_charCodeCache = array()

A char code cache which is used in SetaPDF_Core_Font.

$_dictionary

$_glyphsWidthCache

protected array SetaPDF_Core_Font::$_glyphsWidthCache = array()

Cache for glyph widths

$_indirectObject

The indirect object of the font

$_info

protected array SetaPDF_Core_Font::$_info = array()

Array holding information about the font

$_substituteCharacter

The substitute character in a fonts specific encoding.

$_widths

protected array SetaPDF_Core_Font::$_widths

Glyph withds

$_widthsByCharCode

Widths by char codes


Static Methods

freeCache()

static public SetaPDF_Core_Font::freeCache (): void

Release font instances by a document instance.

Parameters
$document : SetaPDF_Core_Document
 

freeFontCache()

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

Returns the table to map character codes to unicode values.

_getEncodingTable()

Returns the encoding table.

getAscent()

abstract public SetaPDF_Core_Font::getAscent (
void
): float

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

getAvgWidth()

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