Index

  1. \setasign\SetaPDF2
    1. Core
      1. Font
        1. Type0
        2. Type0
          1. Subset

setasign\SetaPDF2\Core\Font\Type0

Subset Class that represents a PDF Type0 (Composite) font subset.

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

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

This font allows you to use several thousands of glyphs (there's a limit of 65000 glyphs).

Class hierarchy

Implements

Summary

Methods

Properties

Constants

Constants

STATE_FINISHED

public const \setasign\SetaPDF2\Core\Font\TrueType\Subset::STATE_FINISHED = 'finished'

State constant for a finished subset

STATE_NEW

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

$_cidToGlyphId

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

Mapping array from character ids to glyph ids

$_descent

protected int \setasign\SetaPDF2\Core\Font\TrueType\Subset::$_descent

The descent value.

$_dictionary

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

The main font dictionary.

$_document

protected \SetaPDF_Core_Document \setasign\SetaPDF2\Core\Font\TrueType\Subset::$_document

The document instance.

$_factor

protected float \setasign\SetaPDF2\Core\Font\TrueType\Subset::$_factor

The scaling factor from TrueType units to glyph coordinate system.

$_fontBBox

protected int[] \setasign\SetaPDF2\Core\Font\TrueType\Subset::$_fontBBox

The font bounding box.

$_fontFile

protected \SetaPDF_Core_Font_TrueType_File \setasign\SetaPDF2\Core\Font\TrueType\Subset::$_fontFile

The source font file instance.

$_fontName

protected string \setasign\SetaPDF2\Core\Font\TrueType\Subset::$_fontName

The font name.

$_indirectObject

protected ?\SetaPDF_Core_Type_IndirectObject \setasign\SetaPDF2\Core\Font\TrueType\Subset::$_indirectObject

The indirect object for the PDF font object.

$_isCidToGlyphMapIdentity

protected bool Subset::$_isCidToGlyphMapIdentity = true

Flag saying whether we can use Identity mapping or not.

$_state

protected string \setasign\SetaPDF2\Core\Font\TrueType\Subset::$_state = 'new'

The state of this subset

$_subsetFile

protected \SetaPDF_Core_Font_TrueType_Subset_File_ByteEncoding \setasign\SetaPDF2\Core\Font\TrueType\Subset::$_subsetFile

The instance of the subset class.

$_throwExceptionWhenMissingGlyphIsUsed

protected bool \setasign\SetaPDF2\Core\Font\TrueType\Subset::$_throwExceptionWhenMissingGlyphIsUsed = false

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

$_widths

protected int[] \setasign\SetaPDF2\Core\Font\TrueType\Subset::$_widths = array()

The widths of the used glyphs.

$_writeCidSet

protected bool Subset::$_writeCidSet = false

Flag saying whether to write the CIDSet entry or not.

$maxCharLimit

public int \setasign\SetaPDF2\Core\Font\TrueType\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 \setasign\SetaPDF2\Core\Font\TrueType\Subset\Exception

Throws \setasign\SetaPDF2\NotImplementedException

_checkState()

protected \setasign\SetaPDF2\Core\Font\TrueType\Subset::_checkState (
void
): void

_createCidSet()

protected Subset::_createCidSet (
void
): \SetaPDF_Core_Type_Stream

Create the CIDSet stream.

Exceptions

Throws \setasign\SetaPDF2\Core\Font\Exception

_createCidToGidMap()

protected Subset::_createCidToGidMap (
void
): \SetaPDF_Core_Type_Name|\SetaPDF_Core_Type_IndirectObject

Create the CIDtoGIDMap entry.

_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.

_getWidthArray()

protected Subset::_getWidthArray (
void
): \SetaPDF_Core_Type_Array

Create the width array.

Exceptions

Throws \setasign\SetaPDF2\Core\Font\Exception

Throws \setasign\SetaPDF2\NotImplementedException

_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 \setasign\SetaPDF2\Core\Font\TrueType\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 \setasign\SetaPDF2\Core\Font\TrueType\Subset::getAscent (
void
): float

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

Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

getCharCodes()

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

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

Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

getDocument()

public \setasign\SetaPDF2\Core\Font\TrueType\Subset::getDocument (
void
): \SetaPDF_Core_Document

Get the document instance.

getFontBBox()

public \setasign\SetaPDF2\Core\Font\TrueType\Subset::getFontBBox (
void
): int[]

Get the font bounding box array.

Exceptions

Throws \setasign\SetaPDF2\Core\Font\Exception

Throws \setasign\SetaPDF2\NotImplementedException

getFontDescriptorFlags()

public \setasign\SetaPDF2\Core\Font\TrueType\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 \setasign\SetaPDF2\Core\Font\TrueType\Subset::getFontFile (
void
): \SetaPDF_Core_Font_TrueType_File

Get the source true type file.

getFontName()

public \setasign\SetaPDF2\Core\Font\TrueType\Subset::getFontName (
void
): string

Get the font name.

Exceptions

Throws \setasign\SetaPDF2\Core\Font\Exception

Throws \setasign\SetaPDF2\NotImplementedException

getGlyphWidth()

public \setasign\SetaPDF2\Core\Font\TrueType\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 \setasign\SetaPDF2\Core\Font\TrueType\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 \setasign\SetaPDF2\Core\Font\TrueType\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 \setasign\SetaPDF2\Core\Font\TrueType\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 \setasign\SetaPDF2\Core\Font\TrueType\Subset::getRegisteredChars (
void
): array

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

getResourceType()

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

Get the resource type of an implementation.

getUnderlinePosition()

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

Get the underline position.

Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

getUnderlineThickness()

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

Get the underline thickness.

Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

setWriteCidSet()

public Subset::setWriteCidSet (
bool $writeCidSet = true
): void

Defines whether the CIDSet entry is created and written or not.

This was required for PDF/A-1 and are optional in PDF/A-2 and PDF/A-3.

Parameters
$writeCidSet : bool
 

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)