Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Font
      2. Font
        1. Type0
        2. Type0
          1. Subset

SetaPDF_Core_Font_Type0 Class for Type0 fonts

File: /SetaPDF v2/Core/Font/Type0.php

Class hierarchy

Implements

Summary

Static Methods

Methods

Properties

Constants

Constants

INFO_COPYRIGHT

public const string SetaPDF_Core_Font::INFO_COPYRIGHT = 'copyright'

Info constant

INFO_CREATION_DATE

public const string SetaPDF_Core_Font::INFO_CREATION_DATE = 'creationDate'

Info constant

INFO_UNIQUE_ID

public const string SetaPDF_Core_Font::INFO_UNIQUE_ID = 'uniqueId'

Info constant

INFO_VERSION

public const string SetaPDF_Core_Font::INFO_VERSION = 'version'

Info constant

TYPE_COLOR_SPACE

public const string SetaPDF_Core_Resource::TYPE_COLOR_SPACE = 'ColorSpace'

Type constant

TYPE_EXT_G_STATE

public const string SetaPDF_Core_Resource::TYPE_EXT_G_STATE = 'ExtGState'

Type constant

TYPE_FONT

public const string SetaPDF_Core_Resource::TYPE_FONT = 'Font'

Type constant

TYPE_PATTERN

public const string SetaPDF_Core_Resource::TYPE_PATTERN = 'Pattern'

Type constant

TYPE_PROC_SET

public const string SetaPDF_Core_Resource::TYPE_PROC_SET = 'ProcSet'

Type constant

TYPE_PROPERTIES

public const string SetaPDF_Core_Resource::TYPE_PROPERTIES = 'Properties'

Type constant

TYPE_SHADING

public const string SetaPDF_Core_Resource::TYPE_SHADING = 'Shading'

Type constant

TYPE_X_OBJECT

public const string SetaPDF_Core_Resource::TYPE_X_OBJECT = 'XObject'

Type constant


Properties

$_avgWidth

protected int|float SetaPDF_Core_Font_Type0::$_avgWidth

The average width of glyphs in the font.

$_calculatedFontBBox

protected null|array SetaPDF_Core_Font_Type0::$_calculatedFontBBox

$_charCodeCache

protected array SetaPDF_Core_Font::$_charCodeCache = array()

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

$_dictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Font::$_dictionary

The font dictionary

$_encodingTable

protected SetaPDF_Core_Font_Cmap SetaPDF_Core_Font_Type0::$_encodingTable

$_fontBBox

protected null|array SetaPDF_Core_Font_Type0::$_fontBBox

The font bounding box

$_fontBBoxVector

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

$_indirectObject

protected SetaPDF_Core_Type_IndirectObject SetaPDF_Core_Font::$_indirectObject

The indirect object of the font

$_info

protected array SetaPDF_Core_Font::$_info = array()

Array holding information about the font

$_splitCharCodesCache

protected array SetaPDF_Core_Font_Type0::$_splitCharCodesCache = array()

Cache array for the splitCharCodes method.

$_streamParser

protected SetaPDF_Core_Font_TrueType_File SetaPDF_Core_Font_Type0::$_streamParser

The TTF/OTF parser of the embedded font file.

$_substituteCharacter

protected string SetaPDF_Core_Font::$_substituteCharacter

The substitute character in a fonts specific encoding.

$_toUnicodeTable

protected SetaPDF_Core_Font_Cmap_CmapInterface SetaPDF_Core_Font_Type0::$_toUnicodeTable

$_underlinePosition

protected null|int|float SetaPDF_Core_Font::$_underlinePosition

The relative underline positioning.

$_underlineThickness

protected null|int|float SetaPDF_Core_Font::$_underlineThickness

The underline thickness.

$_widths

protected array SetaPDF_Core_Font_Type0::$_widths = array()

Cache for width values

$_widthsByCharCode

protected array SetaPDF_Core_Font::$_widthsByCharCode

Widths by char codes


Static Methods

freeCache()

WARNING: This method is marked as deprecated!

Call SetaPDF_Core_Document::clearCache() with the type SetaPDF_Core_Document::CACHE_FONT instead.

public static SetaPDF_Core_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 SetaPDF_Core_Font::freeFontCache (): void

Release font instances by a document instance.

Parameters
$document : SetaPDF_Core_Document
 
See

get()

public static SetaPDF_Core_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 SetaPDF_Exception_NotImplemented

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Core_Type_Exception


Methods

__construct()

public SetaPDF_Core_Font::__construct ()

The constructor.

Parameters
$indirectObjectOrDictionary : SetaPDF_Core_Type_IndirectObjectInterface|SetaPDF_Core_Type_Dictionary
 
Exceptions

Throws SetaPDF_Core_Type_Exception

_ensureUnderlinePosition()

protected SetaPDF_Core_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 SetaPDF_Core_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).

_getEncodingTable()

protected SetaPDF_Core_Font_Type0::_getEncodingTable (
void
): array|SetaPDF_Core_Font_Cmap

Get the CMaps table for this font.

Exceptions

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception_NotImplemented

getAscent()

public SetaPDF_Core_Font_Type0::getAscent (
void
): float

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

Exceptions

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Exception_NotImplemented

getAvgWidth()

public SetaPDF_Core_Font_Type0::getAvgWidth (
[ boolean $calculateIfUndefined = false ]
): integer|float

Get the average glyph width.

Parameters
$calculateIfUndefined : boolean
 
Exceptions

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Exception_NotImplemented

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_Type0::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
 
Exceptions

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception_NotImplemented

getDescendantFont()

public SetaPDF_Core_Font_Type0::getDescendantFont (
void
): SetaPDF_Core_Font_Cid

Get the descendant font.

Exceptions

Throws SetaPDF_Exception_NotImplemented

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

getDictionary()

public SetaPDF_Core_Font::getDictionary (
void
): SetaPDF_Core_Type_Dictionary

Get the font dictionary.

getFontBBox()

public SetaPDF_Core_Font_Type0::getFontBBox (
void
): array

Returns the font bounding box.

Exceptions

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Exception_NotImplemented

getFontBBoxVector()

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

Get a font bounding box vector.

Parameters
$name : int
 
$fontSize : float
 
Exceptions

Throws SetaPDF_Core_Exception

getFontDescriptor()

public SetaPDF_Core_Font_Type0::getFontDescriptor (
void
): SetaPDF_Core_Font_Descriptor

Get the font descriptor object.

Exceptions

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Exception_NotImplemented

getFontFamily()

public SetaPDF_Core_Font_Type0::getFontFamily (
void
): false|string

Get the font family.

Exceptions

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Exception_NotImplemented

getFontName()

public SetaPDF_Core_Font_Type0::getFontName (
void
): string

Get the font name.

Exceptions

Throws SetaPDF_Core_Type_Exception

getGlyphWidthByCharCode()

public SetaPDF_Core_Font_Type0::getGlyphWidthByCharCode (
string $charCode
): float|int

Get the width of a glpyh by its char code.

Parameters
$charCode : string
 
Exceptions

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception_NotImplemented

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

getIndirectObject()

public SetaPDF_Core_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 SetaPDF_Core_Font::getInfo (
string $name
): bool|string

Get information about the font.

Parameters
$name : string

The name of the font

getItalicAngle()

public SetaPDF_Core_Font_Type0::getItalicAngle (
void
): float

Returns the italic angle.

Exceptions

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Exception_NotImplemented

getMaxWidth()

public SetaPDF_Core_Font_Type0::getMaxWidth (
void
): integer|float

Get the max glyph width.

Exceptions

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Exception_NotImplemented

getMissingWidth()

public SetaPDF_Core_Font_Type0::getMissingWidth (
void
): integer|float

Get the missing glyph width.

Exceptions

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Exception_NotImplemented

getResourceType()

public SetaPDF_Core_Font::getResourceType (
void
): string

Get the resource type.

See

getStreamParser()

public SetaPDF_Core_Font_Type0::getStreamParser (
void
): bool|SetaPDF_Core_Font_TrueType_File

Get the TTF/OTF parser for the embedded font programm.

Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Exception_NotImplemented

getType()

public SetaPDF_Core_Font::getType (
void
): string

Get the Subtype entry of the font dictionary.

Exceptions

Throws SetaPDF_Core_Type_Exception

getUnderlinePosition()

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

Get the underline position.

getUnderlineThickness()

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

Get the underline thickness.

isBold()

public SetaPDF_Core_Font_Type0::isBold (
void
): boolean

Checks if the font is bold.

Exceptions

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Exception_NotImplemented

isItalic()

public SetaPDF_Core_Font_Type0::isItalic (
void
): bool

Checks if the font is italic.

Exceptions

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Exception_NotImplemented

isMonospace()

public SetaPDF_Core_Font_Type0::isMonospace (
void
): bool

Checks if the font is monospace.

Exceptions

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Exception_NotImplemented

recalculateFontBBox()

public SetaPDF_Core_Font_Type0::recalculateFontBBox (
void
): array|false|float[]|int[]|null
Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Exception_NotImplemented

setUnderlinePosition()

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

Sets the underline position for the current font.

Parameters
$position : int|float
 

setUnderlineThickness()

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

Sets the underline thickness for the current font.

Parameters
$thickness : int|float
 

splitCharCodes()

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

Split a string of char codes into single char codes.

Parameters
$charCodes : string
 
Exceptions

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception_NotImplemented


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