Index

  1. \setasign\SetaPDF2
    1. Core
      1. Font
        1. TrueType
        2. TrueType
          1. Subset
          2. Subset
            1. Exception
            2. File
            3. Table

setasign\SetaPDF2\Core\Font\TrueType

Subset Class that represents a PDF TrueType font subset.

File: /SetaPDF v2/Core/Font/TrueType/Subset.php
Old class name (alias): \SetaPDF_Core_Font_TrueType_Subset

This class will embedded a subset of the original TrueType font programm with only glyphs, that were requested by calling the getCharCodes() method.

The subset can represent up to 255 glyphs.

Class hierarchy

Implements

Summary

Methods

Properties

Constants

Constants

STATE_FINISHED

public const Subset::STATE_FINISHED = 'finished'

State constant for a finished subset

STATE_NEW

public const Subset::STATE_NEW = 'new'

State constant for a new created subset

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 int Subset::$_ascent

The ascent value.

$_charCodes

protected array Subset::$_charCodes = array(...)

Mapping from UTF-16BE characters to glyph ids.

$_chars

protected array Subset::$_chars = array(...)

Mapping from glyph ids to UTF-16BE charcater codes.

$_descent

protected int Subset::$_descent

The descent value.

$_dictionary

protected \SetaPDF_Core_Type_Dictionary Subset::$_dictionary

The main font dictionary.

$_document

protected \SetaPDF_Core_Document Subset::$_document

The document instance.

$_factor

protected float Subset::$_factor

The scaling factor from TrueType units to glyph coordinate system.

$_fontBBox

protected int[] Subset::$_fontBBox

The font bounding box.

$_fontFile

protected \SetaPDF_Core_Font_TrueType_File Subset::$_fontFile

The source font file instance.

$_fontName

protected string Subset::$_fontName

The font name.

$_indirectObject

protected ?\SetaPDF_Core_Type_IndirectObject Subset::$_indirectObject

The indirect object for the PDF font object.

$_state

protected string Subset::$_state = 'new'

The state of this subset

$_subsetFile

protected \SetaPDF_Core_Font_TrueType_Subset_File_ByteEncoding Subset::$_subsetFile

The instance of the subset class.

$_throwExceptionWhenMissingGlyphIsUsed

protected bool Subset::$_throwExceptionWhenMissingGlyphIsUsed = false

Flag saying whether an exception should be thrown if a character is not available or not.

$_widths

protected int[] Subset::$_widths = array()

The widths of the used glyphs.

$maxCharLimit

public int Subset::$maxCharLimit = 256

The char count limit.


Methods

__construct()

public Subset::__construct (
\SetaPDF_Core_Document $document,
\SetaPDF_Core_Font_TrueType_File|string|\SetaPDF_Core_Reader_Binary $fontFile,
bool $throwExceptionWhenMissingGlyphIsUsed = false,
bool $ignoreLicenseRestrictions = false
)

The constructor.

Parameters
$document : \SetaPDF_Core_Document
 
$fontFile : \SetaPDF_Core_Font_TrueType_File|string|\SetaPDF_Core_Reader_Binary
 
$throwExceptionWhenMissingGlyphIsUsed : bool

Whether an exception should be thrown if the registered character cannot be found or not.

$ignoreLicenseRestrictions : bool

Can be used to disable the font license check

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Font\Exception

Throws Subset\Exception

Throws \setasign\SetaPDF2\NotImplementedException

_checkState()

protected Subset::_checkState (
void
): void

_getSubsetFile()

protected Subset::_getSubsetFile (
void
): \SetaPDF_Core_Font_TrueType_Subset_File

Gets the subset file instance.

Exceptions

Throws \setasign\SetaPDF2\Core\Font\Exception

_getToUnicode()

protected Subset::_getToUnicode (
void
): string

Returns the ToUnicode cmap.

_registerChar()

protected Subset::_registerChar (
string $char,
string $charCode
): void

Registers a glyph that got registered in the font subsetter.

Parameters
$char : string
 
$charCode : string
 

cleanUp()

public Subset::cleanUp (
void
): void

Release cycled references and memory.

createSubset()

public Subset::createSubset (
void
): void

Create the final subset file and embed it into the PDF document.

Exceptions

Throws \setasign\SetaPDF2\Core\Font\Exception

Throws \setasign\SetaPDF2\NotImplementedException

getAscent()

public Subset::getAscent (
void
): float

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

Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

getCharCodes()

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

Exceptions

Throws \setasign\SetaPDF2\Core\Font\Exception

Throws \setasign\SetaPDF2\NotImplementedException

getDescent()

public Subset::getDescent (
void
): float

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

Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

getDocument()

public Subset::getDocument (
void
): \SetaPDF_Core_Document

Get the document instance.

getFontBBox()

public Subset::getFontBBox (
void
): int[]

Get the font bounding box array.

Exceptions

Throws \setasign\SetaPDF2\Core\Font\Exception

Throws \setasign\SetaPDF2\NotImplementedException

getFontDescriptorFlags()

public Subset::getFontDescriptorFlags (
void
): int

Get flags defining various characteristics of the font.

Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

See
  • PDF 32000-1:2008 - 9.8.2 Font Descriptor Flags

getFontFile()

public Subset::getFontFile (
void
): \SetaPDF_Core_Font_TrueType_File

Get the source true type file.

getFontName()

public Subset::getFontName (
void
): string

Get the font name.

Exceptions

Throws \setasign\SetaPDF2\Core\Font\Exception

Throws \setasign\SetaPDF2\NotImplementedException

getGlyphWidth()

public Subset::getGlyphWidth (
string $char,
string $encoding = 'UTF-16BE'
): int

Get the glyph width of a single character.

Parameters
$char : string

The character

$encoding : string

The encoding of the character

Exceptions

Throws \setasign\SetaPDF2\Core\Font\Exception

Throws \setasign\SetaPDF2\NotImplementedException

getGlyphWidthByCharCode()

public Subset::getGlyphWidthByCharCode (
string $charCode
): int

Get the glyph width by a char code.

Parameters
$charCode : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\Font\Exception

Throws \setasign\SetaPDF2\NotImplementedException

getGlyphsWidth()

public Subset::getGlyphsWidth (
string $chars,
string $encoding = 'UTF-16BE'
): int

Get the glyphs width of a string.

Parameters
$chars : string

The string

$encoding : string

The encoding of the characters

Exceptions

Throws \setasign\SetaPDF2\Core\Font\Exception

Throws \setasign\SetaPDF2\NotImplementedException

getIndirectObject()

public Subset::getIndirectObject (
?\SetaPDF_Core_Document $document = null
): \SetaPDF_Core_Type_IndirectObject

Get the indirect object of this resource.

Parameters
$document : ?\SetaPDF_Core_Document
 

getRegisteredChars()

public Subset::getRegisteredChars (
void
): array

Get all registered characters (UTF-16BE encoded) indexed by their glyph ids.

getResourceType()

public Subset::getResourceType (
void
): string

Get the resource type of an implementation.

getUnderlinePosition()

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

Get the underline position.

Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

getUnderlineThickness()

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

Get the underline thickness.

Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

splitCharCodes()

public Subset::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)