Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Font
      2. Font
        1. Cmap
        2. Cmap
        3. Glyph
        4. Standard
        5. Standard
        6. TrueType
        7. TrueType
        8. Type0
        9. Type0
        10. Cid
        11. CidType0
        12. CidType2
        13. Descriptor
        14. DescriptorInterface
        15. Exception
        16. FontInterface
        17. MMType1
        18. Simple
        19. ToUnicode
        20. Type1
        21. Type3

SetaPDF_Core_Font_Descriptor Class representing a font descriptor

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

Class hierarchy

Summary

Methods

Properties

Properties

$_dictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Font_Descriptor::$_dictionary

The dictionary


Methods

__construct()

public SetaPDF_Core_Font_Descriptor::__construct ()

The constructor.

Parameters
$indirectObjectOrDictionary : SetaPDF_Core_Type_IndirectObjectInterface|SetaPDF_Core_Type_Dictionary
 
Exceptions

Throws InvalidArgumentException

_get()

private SetaPDF_Core_Font_Descriptor::_get (
string $key [, null|mixed $default = null ]
): mixed|null

Helper method to get values from a font descriptor.

Parameters
$key : string
 
$default : null|mixed
 
Exceptions

Throws SetaPDF_Core_Font_Exception

_getFontFile()

private SetaPDF_Core_Font_Descriptor::_getFontFile (
string $key
): false|SetaPDF_Core_Type_Stream

Helper method to get font file entries.

Parameters
$key : string
 

getAscent()

public SetaPDF_Core_Font_Descriptor::getAscent (
void
): integer|float|false

Get the maximum height above the baseline reached by glyphs in this font.

Exceptions

Throws SetaPDF_Core_Font_Exception

getAvgWidth()

public SetaPDF_Core_Font_Descriptor::getAvgWidth (
void
): integer|float

Get the average width of glyphs in the font.

Exceptions

Throws SetaPDF_Core_Font_Exception

getCapHeight()

public SetaPDF_Core_Font_Descriptor::getCapHeight (
void
): integer|float|false

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

Exceptions

Throws SetaPDF_Core_Font_Exception

getDescent()

public SetaPDF_Core_Font_Descriptor::getDescent (
void
): integer|float|false

Get the maximum depth below the baseline reached by glyphs in this font.

Exceptions

Throws SetaPDF_Core_Font_Exception

getDictionary()

public SetaPDF_Core_Font_Descriptor::getDictionary (
void
): SetaPDF_Core_Type_Dictionary

Get the font descriptor dictionary.

getFlags()

public SetaPDF_Core_Font_Descriptor::getFlags (
void
): int

Get a collection of flags defining various characteristics of the font.

Exceptions

Throws SetaPDF_Core_Font_Exception

getFontBBox()

public SetaPDF_Core_Font_Descriptor::getFontBBox (
void
): array|false

Get a rectangle, expressed in the glyph coordinate system, that shall specify the font bounding box.

getFontFamily()

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

Get the preferred font family name.

Exceptions

Throws SetaPDF_Core_Font_Exception

getFontFile()

public SetaPDF_Core_Font_Descriptor::getFontFile (
void
): false|SetaPDF_Core_Type_Stream

Get a stream containing a Type 1 font program.

getFontFile2()

public SetaPDF_Core_Font_Descriptor::getFontFile2 (
void
): false|SetaPDF_Core_Type_Stream

Get a stream containing a TrueType font program.

getFontFile3()

public SetaPDF_Core_Font_Descriptor::getFontFile3 (
void
): false|SetaPDF_Core_Type_Stream

Get a stream containing a font program whose format is specified by the Subtype entry in the stream dictionary.

getFontName()

public SetaPDF_Core_Font_Descriptor::getFontName (
void
): string

Get the PostScript name of the font.

Exceptions

Throws SetaPDF_Core_Font_Exception

getFontStretch()

public SetaPDF_Core_Font_Descriptor::getFontStretch (
void
): string|false

Get the font stretch value.

Exceptions

Throws SetaPDF_Core_Font_Exception

getFontWeight()

public SetaPDF_Core_Font_Descriptor::getFontWeight (
void
): integer|float|false

Get the weight (thickness) component of the fully-qualified font name or font specifier.

Exceptions

Throws SetaPDF_Core_Font_Exception

getItalicAngle()

public SetaPDF_Core_Font_Descriptor::getItalicAngle (
void
): integer|float

Get the angle, expressed in degrees counterclockwise from the vertical, of the dominant vertical strokes of the font.

Exceptions

Throws SetaPDF_Core_Font_Exception

getLeading()

public SetaPDF_Core_Font_Descriptor::getLeading (
void
): integer|float

Get the spacing between baselines of consecutive lines of text.

Exceptions

Throws SetaPDF_Core_Font_Exception

getMaxWidth()

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

Get the maximum width of glyphs in the font.

Exceptions

Throws SetaPDF_Core_Font_Exception

getMissingWidth()

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

Get the width to use for character codes whose widths are not specified in a font dictionary's Widths array.

Exceptions

Throws SetaPDF_Core_Font_Exception

getStemH()

public SetaPDF_Core_Font_Descriptor::getStemH (
void
): integer|float

Get the thickness, measured vertically, of the dominant horizontal stems of glyphs in the font.

Exceptions

Throws SetaPDF_Core_Font_Exception

getStemV()

public SetaPDF_Core_Font_Descriptor::getStemV (
void
): integer|float|false

Get the thickness, measured horizontally, of the dominant vertical stems of glyphs in the font.

Exceptions

Throws SetaPDF_Core_Font_Exception

getXHeight()

public SetaPDF_Core_Font_Descriptor::getXHeight (
void
): integer|float

Get the font’s x height.

The vertical coordinate of the top of flat nonascending lowercase letters (like the letter x), measured from the baseline, in fonts that have Latin characters.

Exceptions

Throws SetaPDF_Core_Font_Exception


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