Index

  1. \setasign\SetaPDF2
    1. Core
      1. Font
        1. Standard
          1. AbstractStandard
          2. Courier
          3. CourierBold
          4. CourierBoldOblique
          5. CourierOblique
          6. Helvetica
          7. HelveticaBold
          8. HelveticaBoldOblique
          9. HelveticaOblique
          10. Symbol
          11. TimesBold
          12. TimesBoldItalic
          13. TimesItalic
          14. TimesRoman
          15. ZapfDingbats

setasign\SetaPDF2\Core\Font\Standard

Symbol Class representing the PDF standard font Symbol

File: /SetaPDF v2/Core/Font/Standard/Symbol.php
Old class name (alias): \SetaPDF_Core_Font_Standard_Symbol

Class hierarchy

Implements

Summary

Static Methods

Methods

Properties

Constants

Constants

INFO_COPYRIGHT

public const string \setasign\SetaPDF2\Core\Font\Font::INFO_COPYRIGHT = 'copyright'

Info constant

INFO_CREATION_DATE

public const string \setasign\SetaPDF2\Core\Font\Font::INFO_CREATION_DATE = 'creationDate'

Info constant

INFO_UNIQUE_ID

public const string \setasign\SetaPDF2\Core\Font\Font::INFO_UNIQUE_ID = 'uniqueId'

Info constant

INFO_VERSION

public const string \setasign\SetaPDF2\Core\Font\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

$_ascent

protected AbstractStandard::$_ascent = 0

The distance from baseline of highest ascender (Typographic ascent)

$_avgWidth

protected int|float \setasign\SetaPDF2\Core\Font\Simple::$_avgWidth

The average width of glyphs in the font.

$_capHeight

protected float AbstractStandard::$_capHeight = 0

The vertical coordinate of the top of flat capital letters, measured from the baseline.

$_charCodeCache

protected array \setasign\SetaPDF2\Core\Font\Font::$_charCodeCache = array()

A char code cache which is used in \setasign\SetaPDF2\Core\Font\Font::getCharByCharCode().

$_descent

protected AbstractStandard::$_descent = 0

The distance from baseline of lowest descender (Typographic descent)

$_dictionary

protected \SetaPDF_Core_Type_Dictionary \setasign\SetaPDF2\Core\Font\Font::$_dictionary

The font dictionary

$_encodingTable

protected array \setasign\SetaPDF2\Core\Font\Simple::$_encodingTable

The encoding table

$_fontBBox

protected array AbstractStandard::$_fontBBox = array()

The font bounding box

$_fontBBoxVector

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

$_fontFamily

protected string AbstractStandard::$_fontFamily

The font family

$_fontName

protected string AbstractStandard::$_fontName

The font name

$_indirectObject

protected \SetaPDF_Core_Type_IndirectObject \setasign\SetaPDF2\Core\Font\Font::$_indirectObject

The indirect object of the font

$_info

protected array \setasign\SetaPDF2\Core\Font\Font::$_info = array()

Array holding information about the font

$_isBold

protected bool AbstractStandard::$_isBold = false

Flag indicating if this font is bold.

$_isItalic

protected bool AbstractStandard::$_isItalic = false

Flag indicating if this font is italic.

$_isMonospace

protected bool AbstractStandard::$_isMonospace = false

Flag indicating if this font is monospace.

$_italicAngle

protected float AbstractStandard::$_italicAngle = 0

The italic angle

$_kerningPairs

protected array AbstractStandard::$_kerningPairs = array()

Kerning pairs

$_substituteCharacter

protected ?string AbstractStandard::$_substituteCharacter

The UTF-16BE unicode value for a substitute character

$_toUnicodeTable

protected array \setasign\SetaPDF2\Core\Font\Simple::$_toUnicodeTable

The map that maps character codes to uncidoe values

$_underlinePosition

protected null|int|float \setasign\SetaPDF2\Core\Font\Font::$_underlinePosition

The relative underline positioning.

$_underlineThickness

protected null|int|float \setasign\SetaPDF2\Core\Font\Font::$_underlineThickness

The underline thickness.

$_widths

protected array AbstractStandard::$_widths = array()

Glyph widths

$_widthsByCharCode

protected array \setasign\SetaPDF2\Core\Font\Font::$_widthsByCharCode

Widths by char codes

$_xHeight

protected float AbstractStandard::$_xHeight = 0

The vertical coordinate of the top of flat non-ascending lowercase letters (like the letter x), measured from the baseline


Static Methods

_createDifferenceArray()

protected static AbstractStandard::_createDifferenceArray (
\SetaPDF_Core_Type_Dictionary $dictionary,
string $baseEncoding,
array $diffEncoding
): void

Creates a difference array.

Parameters
$dictionary : \SetaPDF_Core_Type_Dictionary
 
$baseEncoding : string
 
$diffEncoding : array
 

create()

public static Symbol::create (
\SetaPDF_Core_Document $document,
string $baseEncoding = null,
array $diffEncoding = array ( )
): \SetaPDF_Core_Font_Standard_Symbol

Creates a font object of this font.

Parameters
$document : \SetaPDF_Core_Document
 
$baseEncoding : string
 
$diffEncoding : array
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

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 \setasign\SetaPDF2\Core\Font\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 \setasign\SetaPDF2\Core\Font\Font::freeFontCache (): void

Release font instances by a document instance.

Parameters
$document : \SetaPDF_Core_Document
 
See

get()

public static \setasign\SetaPDF2\Core\Font\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 \setasign\SetaPDF2\Core\Font\Exception

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

Throws \setasign\SetaPDF2\Core\Type\Exception

getDefaultDictionary()

public static Symbol::getDefaultDictionary (
void
): \SetaPDF_Core_Type_Dictionary

Gets a default dictionary for this font.

getStandardFontsToClasses()

public static AbstractStandard::getStandardFontsToClasses (
void
): array

Helper method to get all available standard font names and their class mapping.


Methods

__construct()

public Symbol::__construct ()

Constructor.

Parameters
$indirectObjectOrDictionary : \SetaPDF_Core_Type_IndirectObjectInterface|\SetaPDF_Core_Type_Dictionary
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

_ensureUnderlinePosition()

protected \setasign\SetaPDF2\Core\Font\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 \setasign\SetaPDF2\Core\Font\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 \setasign\SetaPDF2\Core\Font\Simple::_getCharCodesTable (
void
): \SetaPDF_Core_Font_Cmap|array|false

Get the map that maps character codes to unicode values.

Exceptions

Throws \setasign\SetaPDF2\Core\Font\Exception

_getEncodingTable()

protected \setasign\SetaPDF2\Core\Font\Simple::_getEncodingTable (
void
): array

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

_getWidths()

protected AbstractStandard::_getWidths (
void
): void

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

getAscent()

public AbstractStandard::getAscent (
void
): float

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

getAvgWidth()

public \setasign\SetaPDF2\Core\Font\Simple::getAvgWidth (
bool $calculateIfUndefined = false
): int|float

Get the average glyph width.

Parameters
$calculateIfUndefined : bool
 

getBaseEncodingTable()

public Symbol::getBaseEncodingTable (
void
): array

Get the base encoding table.

getCapHeight()

public AbstractStandard::getCapHeight (
void
): float

Get the vertical coordinate of the top of flat capital letters, measured from the baseline.

getCharByCharCode()

public Symbol::getCharByCharCode (
string $charCode,
string $encoding = 'UTF-8',
bool $normalize = false
): 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

$normalize : bool

Specifies if unknown mappings (e.g. to points in the private unicode area) should be mapped to meaningful values.

getCharCode()

public \setasign\SetaPDF2\Core\Font\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 \setasign\SetaPDF2\Core\Font\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 \setasign\SetaPDF2\Core\Font\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 AbstractStandard::getDescent (
void
): float

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

getDictionary()

public \setasign\SetaPDF2\Core\Font\Font::getDictionary (
void
): \SetaPDF_Core_Type_Dictionary

Get the font dictionary.

getFontBBox()

public AbstractStandard::getFontBBox (
void
): array

Returns the font bounding box.

getFontBBoxVector()

public \setasign\SetaPDF2\Core\Font\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()

public AbstractStandard::getFontFamily (
void
): string

Get the font family.

getFontName()

public AbstractStandard::getFontName (
void
): string

Get the font name.

getGlyphWidth()

public \setasign\SetaPDF2\Core\Font\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 AbstractStandard::getGlyphWidthByCharCode (
string $charCode
): float|int

Get the width of a glpyh by its char code.

Parameters
$charCode : string
 

getGlyphsWidth()

public \setasign\SetaPDF2\Core\Font\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 \setasign\SetaPDF2\Core\Font\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 \setasign\SetaPDF2\Core\Font\Font::getInfo (
string $name
): bool|string

Get information about the font.

Parameters
$name : string

The name of the font

getItalicAngle()

public AbstractStandard::getItalicAngle (
void
): float

Returns the italic angle.

getMaxWidth()

public \setasign\SetaPDF2\Core\Font\Font::getMaxWidth (
void
): int|float

Get the max. glyph width.

getMissingWidth()

public \setasign\SetaPDF2\Core\Font\Font::getMissingWidth (
void
): int|float

Get the missing glyph width.

getResourceType()

public \setasign\SetaPDF2\Core\Font\Font::getResourceType (
void
): string

Get the resource type.

See

getType()

public \setasign\SetaPDF2\Core\Font\Font::getType (
void
): string

Get the Subtype entry of the font dictionary.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getUnderlinePosition()

public \setasign\SetaPDF2\Core\Font\Font::getUnderlinePosition (
void
): int|float

Get the underline position.

getUnderlineThickness()

public \setasign\SetaPDF2\Core\Font\Font::getUnderlineThickness (
void
): int|float

Get the underline thickness.

getXHeight()

public AbstractStandard::getXHeight (
void
): float

Get the vertical coordinate of the top of flat non-ascending lowercase letters (like the letter x), measured from the baseline.

isBold()

public AbstractStandard::isBold (
void
): bool

Checks if the font is bold.

isItalic()

public AbstractStandard::isItalic (
void
): bool

Checks if the font is italic.

isMonospace()

public AbstractStandard::isMonospace (
void
): bool

Checks if the font is monospace.

recalculateFontBBox()

public \setasign\SetaPDF2\Core\Font\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 \setasign\SetaPDF2\Core\Font\Font::setUnderlinePosition (
int|float $position
): void

Sets the underline position for the current font.

Parameters
$position : int|float
 

setUnderlineThickness()

public \setasign\SetaPDF2\Core\Font\Font::setUnderlineThickness (
int|float $thickness
): void

Sets the underline thickness for the current font.

Parameters
$thickness : int|float
 

splitCharCodes()

public \setasign\SetaPDF2\Core\Font\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)