Index

  1. \setasign\SetaPDF2
    1. Core
      1. Font
        1. Cid
        2. CidType0
        3. CidType2
        4. Cmap
        5. Descriptor
        6. DescriptorInterface
        7. Exception
        8. Font
        9. FontInterface
        10. Glyph
        11. MMType1
        12. Simple
        13. Standard
        14. ToUnicode
        15. TrueType
        16. TrueType
        17. Type0
        18. Type0
        19. Type1
        20. Type3

setasign\SetaPDF2\Core\Font

Simple Abstract class for simple fonts.

File: /SetaPDF v2/Core/Font/Simple.php
Old class name (alias): \SetaPDF_Core_Font_Simple

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 Methods

Methods

Properties

Constants

Constants

INFO_COPYRIGHT

public const string Font::INFO_COPYRIGHT = 'copyright'

Info constant

INFO_CREATION_DATE

public const string Font::INFO_CREATION_DATE = 'creationDate'

Info constant

INFO_UNIQUE_ID

public const string Font::INFO_UNIQUE_ID = 'uniqueId'

Info constant

INFO_VERSION

public const string Font::INFO_VERSION = 'version'

Info constant

TYPE_COLOR_SPACE

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_COLOR_SPACE = 'ColorSpace'

Type constant

TYPE_EXT_G_STATE

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_EXT_G_STATE = 'ExtGState'

Type constant

TYPE_FONT

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_FONT = 'Font'

Type constant

TYPE_PATTERN

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_PATTERN = 'Pattern'

Type constant

TYPE_PROC_SET

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_PROC_SET = 'ProcSet'

Type constant

TYPE_PROPERTIES

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_PROPERTIES = 'Properties'

Type constant

TYPE_SHADING

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_SHADING = 'Shading'

Type constant

TYPE_X_OBJECT

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_X_OBJECT = 'XObject'

Type constant


Properties

$_avgWidth

protected int|float Simple::$_avgWidth

The average width of glyphs in the font.

$_charCodeCache

protected array Font::$_charCodeCache = array()

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

$_dictionary

protected \SetaPDF_Core_Type_Dictionary Font::$_dictionary

The font dictionary

$_encodingTable

protected array Simple::$_encodingTable

The encoding table

$_fontBBoxVector

protected array<string, \SetaPDF_Core_Geometry_Point> Font::$_fontBBoxVector = array()

$_indirectObject

protected \SetaPDF_Core_Type_IndirectObject Font::$_indirectObject

The indirect object of the font

$_info

protected array Font::$_info = array()

Array holding information about the font

$_substituteCharacter

protected string Font::$_substituteCharacter

The substitute character in a fonts specific encoding.

$_toUnicodeTable

protected array Simple::$_toUnicodeTable

The map that maps character codes to uncidoe values

$_underlinePosition

protected null|int|float Font::$_underlinePosition

The relative underline positioning.

$_underlineThickness

protected null|int|float Font::$_underlineThickness

The underline thickness.

$_widths

protected array Font::$_widths

Glyph withds

$_widthsByCharCode

protected array Font::$_widthsByCharCode

Widths by char codes


Static Methods

freeCache()

WARNING: This method is marked as deprecated!

Call \setasign\SetaPDF2\Core\Document::clearCache() with the type \setasign\SetaPDF2\Core\Document::CACHE_FONT instead.

public static Font::freeCache (): void

Release font instances by a document instance.

Parameters
$document : \SetaPDF_Core_Document
 

freeFontCache()

WARNING: This method is marked as deprecated!

public static Font::freeFontCache (): void

Release font instances by a document instance.

Parameters
$document : \SetaPDF_Core_Document
 
See

get()

public static Font::get (): \SetaPDF_Core_Font|\SetaPDF_Core_Font_Cid

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|\SetaPDF_Core_Type_Dictionary
 
Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

Throws Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception


Methods

__construct()

public Font::__construct ()

The constructor.

Parameters
$indirectObjectOrDictionary : \SetaPDF_Core_Type_IndirectObjectInterface|\SetaPDF_Core_Type_Dictionary
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

_ensureUnderlinePosition()

protected Font::_ensureUnderlinePosition (
void
): int|float

Calculates the underline position.

This method is only used if no underline thickness is provided by the font implementation (e.g. through an already embedded font). We simply use the font bounding box to calculate a meaningful value.

_ensureUnderlineThickness()

protected Font::_ensureUnderlineThickness (
void
): float|int

Calculates the underline thickness.

This method is only used if no underline thickness is provided by the font implementation (e.g. through an already embedded font).

_getCharCodesTable()

protected Simple::_getCharCodesTable (
void
): \SetaPDF_Core_Font_Cmap|array|false

Get the map that maps character codes to unicode values.

Exceptions

Throws Exception

_getEncodingTable()

protected Simple::_getEncodingTable (
void
): array

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

_getWidths()

abstract protected Simple::_getWidths (
void
): void

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

getAscent()

abstract public FontInterface::getAscent (
void
): float

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

getAvgWidth()

public Simple::getAvgWidth (
bool $calculateIfUndefined = false
): int|float

Get the average glyph width.

Parameters
$calculateIfUndefined : bool
 

getCharByCharCode()

public 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 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 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 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 FontInterface::getDescent (
void
): float

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

getDictionary()

public Font::getDictionary (
void
): \SetaPDF_Core_Type_Dictionary

Get the font dictionary.

getFontBBox()

abstract public FontInterface::getFontBBox (
void
): array

Returns the font bounding box.

Return Values

Format is [llx lly urx ury]

getFontBBoxVector()

public Font::getFontBBoxVector (
int $name,
float $fontSize
): \SetaPDF_Core_Geometry_Vector

Get a font bounding box vector.

Parameters
$name : int
 
$fontSize : float
 
Exceptions

Throws \setasign\SetaPDF2\Core\Exception

getFontFamily()

abstract public Font::getFontFamily (
void
): string

Get the font family.

getFontName()

abstract public FontInterface::getFontName (
void
): string

Get the font name.

getGlyphWidth()

public 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 Font::getGlyphWidthByCharCode (
string $charCode
): float|int

Get the width of a glyph by its char code.

Parameters
$charCode : string
 

getGlyphsWidth()

public 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

getIndirectObject()

public Font::getIndirectObject (
?\SetaPDF_Core_Document $document = null
): \SetaPDF_Core_Type_IndirectObjectInterface

Gets an indirect object for this font.

Parameters
$document : ?\SetaPDF_Core_Document
 
Exceptions

Throws \InvalidArgumentException

See

getInfo()

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

Get information about the font.

Parameters
$name : string

The name of the font

getItalicAngle()

abstract public Font::getItalicAngle (
void
): float

Returns the italic angle.

getMaxWidth()

public Font::getMaxWidth (
void
): int|float

Get the max. glyph width.

getMissingWidth()

public Font::getMissingWidth (
void
): int|float

Get the missing glyph width.

getResourceType()

public Font::getResourceType (
void
): string

Get the resource type.

See

getType()

public Font::getType (
void
): string

Get the Subtype entry of the font dictionary.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getUnderlinePosition()

public Font::getUnderlinePosition (
void
): int|float

Get the underline position.

getUnderlineThickness()

public Font::getUnderlineThickness (
void
): int|float

Get the underline thickness.

isBold()

abstract public Font::isBold (
void
): bool

Checks if the font is bold.

isItalic()

abstract public Font::isItalic (
void
): bool

Checks if the font is italic.

isMonospace()

abstract public Font::isMonospace (
void
): bool

Checks if the font is monospace.

recalculateFontBBox()

public Font::recalculateFontBBox (
void
): false|array

Re-calculate the font bounding box by analysing the metrics of all embedded glyphs.

Return Values

Format is [llx lly urx ury]. Returns false if the font isn't recalculatable

setUnderlinePosition()

public Font::setUnderlinePosition (
int|float $position
): void

Sets the underline position for the current font.

Parameters
$position : int|float
 

setUnderlineThickness()

public Font::setUnderlineThickness (
int|float $thickness
): void

Sets the underline thickness for the current font.

Parameters
$thickness : int|float
 

splitCharCodes()

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

Split a string of char codes into single char codes.

Parameters
$charCodes : string
 

© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)