Interface setasign\SetaPDF2\Core\Font\FontInterface in SetaPDF v2 API Reference

Index

\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

FontInterface Font interface

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

Implemented in

Implements

Summary

Constants

TYPE_COLOR_SPACE
TYPE_EXT_G_STATE
TYPE_FONT
TYPE_PATTERN
TYPE_PROC_SET
TYPE_PROPERTIES
TYPE_SHADING
TYPE_X_OBJECT

Constants

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

Methods

getAscent()

abstract public FontInterface::getAscent (

void

): float

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

getCharCodes()

abstract public FontInterface::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

getDescent()

abstract public FontInterface::getDescent (

void

): float

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

getFontBBox()

abstract public FontInterface::getFontBBox (

void

): array

Returns the font bounding box.

Return Values

Format is [llx lly urx ury]

getFontName()

abstract public FontInterface::getFontName (

void

): string

Get the font name.

getGlyphWidth()

abstract public Glyph\Collection\CollectionInterface::getGlyphWidth (

string $char,
string $encoding = 'UTF-16BE'

): float|bool

Get the glyph width of a single character.

Parameters

$char : string: The character
$encoding : string: The encoding of the character

getGlyphWidthByCharCode()

abstract public FontInterface::getGlyphWidthByCharCode (

string $charCode

): float|bool

Get the width of a glyph by its char code.

Parameters

$charCode : string

getGlyphsWidth()

abstract public Glyph\Collection\CollectionInterface::getGlyphsWidth (

string $chars,
string $encoding = 'UTF-16BE'

): float|bool

Get the glyphs width of a string.

Parameters

$chars : string: The string
$encoding : string: The encoding of the characters

getIndirectObject()

abstract public \setasign\SetaPDF2\Core\Resource\ResourceInterface::getIndirectObject (

?\SetaPDF_Core_Document $document = null

): \SetaPDF_Core_Type_IndirectObject

Get the indirect object of this resource.

Parameters

$document : ?\SetaPDF_Core_Document

getResourceType()

abstract public \setasign\SetaPDF2\Core\Resource\ResourceInterface::getResourceType (

void

): string

Get the resource type of an implementation.

getUnderlinePosition()

abstract public FontInterface::getUnderlinePosition (

void

): int|float

Get the underline position.

getUnderlineThickness()

abstract public FontInterface::getUnderlineThickness (

void

): int|float

Get the underline thickness.

splitCharCodes()

abstract public FontInterface::splitCharCodes (

string $charCodes

): array

Split a string of char codes into single char codes.

Parameters

$charCodes : string