Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Font
      2. Font
        1. Standard
        2. Standard
          1. Courier
          2. CourierBold
          3. CourierBoldOblique
          4. CourierOblique
          5. Helvetica
          6. HelveticaBold
          7. HelveticaBoldOblique
          8. HelveticaOblique
          9. Symbol
          10. TimesBold
          11. TimesBoldItalic
          12. TimesItalic
          13. TimesRoman
          14. ZapfDingbats

SetaPDF_Core_Font_Standard_Helvetica Class representing the PDF standard font Helvetica

File: /SetaPDF v2/Core/Font/Standard/Helvetica.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

$_ascent

protected SetaPDF_Core_Font_Standard::$_ascent = 0

The distance from baseline of highest ascender (Typographic ascent)

$_avgWidth

protected integer|float SetaPDF_Core_Font_Simple::$_avgWidth

The average width of glyphs in the font.

$_capHeight

protected float SetaPDF_Core_Font_Standard::$_capHeight = 0

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

$_charCodeCache

protected array SetaPDF_Core_Font::$_charCodeCache = array()

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

$_descent

protected SetaPDF_Core_Font_Standard::$_descent = 0

The distance from baseline of lowest descender (Typographic descent)

$_dictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Font::$_dictionary

The font dictionary

$_encodingTable

protected array SetaPDF_Core_Font_Simple::$_encodingTable

The encoding table

$_fontBBox

protected array SetaPDF_Core_Font_Standard::$_fontBBox = array()

The font bounding box

$_fontBBoxVector

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

$_fontFamily

protected string SetaPDF_Core_Font_Standard::$_fontFamily

The font family

$_fontName

protected string SetaPDF_Core_Font_Standard::$_fontName

The font name

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

$_isBold

protected boolean SetaPDF_Core_Font_Standard::$_isBold = false

Flag indicating if this font is bold.

$_isItalic

protected boolean SetaPDF_Core_Font_Standard::$_isItalic = false

Flag indicating if this font is italic.

$_isMonospace

protected boolean SetaPDF_Core_Font_Standard::$_isMonospace = false

Flag indicating if this font is monospace.

$_italicAngle

protected float SetaPDF_Core_Font_Standard::$_italicAngle = 0

The italic angle

$_kerningPairs

protected array SetaPDF_Core_Font_Standard::$_kerningPairs = array()

Kerning pairs

$_substituteCharacter

protected null|string SetaPDF_Core_Font_Standard::$_substituteCharacter

The UTF-16BE unicode value for a substitute character

$_toUnicodeTable

protected array SetaPDF_Core_Font_Simple::$_toUnicodeTable

The map that maps character codes to uncidoe values

$_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_Standard::$_widths = array()

Glyph widths

$_widthsByCharCode

protected array SetaPDF_Core_Font::$_widthsByCharCode

Widths by char codes

$_xHeight

protected float SetaPDF_Core_Font_Standard::$_xHeight = 0

The vertical coordinate of the top of flat non-ascending lowercase letters (like the letter x), measured from the baseline


Static Methods

_createDifferenceArray()

protected static SetaPDF_Core_Font_Standard::_createDifferenceArray (
SetaPDF_Core_Type_Dictionary $dictionary, string $baseEncoding, array $diffEncoding
): void

Creates a difference array.

Parameters
$dictionary : SetaPDF_Core_Type_Dictionary
 
$baseEncoding : string
 
$diffEncoding : array
 

create()

public static SetaPDF_Core_Font_Standard_Helvetica::create (
SetaPDF_Core_Document $document [, string $baseEncoding = SetaPDF_Core_Encoding::WIN_ANSI [, array $diffEncoding = array ( ) ]]
): SetaPDF_Core_Font_Standard_Helvetica

Creates a font object of this font.

Parameters
$document : SetaPDF_Core_Document
 
$baseEncoding : string
 
$diffEncoding : array
 
Exceptions

Throws SetaPDF_Core_Type_Exception

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

getDefaultDictionary()

public static SetaPDF_Core_Font_Standard_Helvetica::getDefaultDictionary (
[ string $encoding = 'WinAnsi' ]
): SetaPDF_Core_Type_Dictionary

Gets a default dictionary for this font.

Parameters
$encoding : string
 

getStandardFontsToClasses()

public static SetaPDF_Core_Font_Standard::getStandardFontsToClasses (
void
): array

Helper method to get all available standard font names and their class mapping.


Methods

__construct()

public SetaPDF_Core_Font_Standard_Helvetica::__construct ()

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

_getCharCodesTable()

protected SetaPDF_Core_Font_Simple::_getCharCodesTable (
void
): SetaPDF_Core_Font_Cmap|array|false

Get the map that maps character codes to unicode values.

Exceptions

Throws SetaPDF_Core_Font_Exception

_getEncodingTable()

protected SetaPDF_Core_Font_Simple::_getEncodingTable (
void
): array

Get the encoding table based on the Encoding dictionary and it's Differences entry (if available).

_getWidths()

protected SetaPDF_Core_Font_Standard::_getWidths (
void
): void

Resolves the width values from the font descriptor and fills the $_width-array.

getAscent()

public SetaPDF_Core_Font_Standard::getAscent (
void
): float

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

getAvgWidth()

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

Get the average glyph width.

Parameters
$calculateIfUndefined : boolean
 

getBaseEncodingTable()

public SetaPDF_Core_Font_Standard::getBaseEncodingTable (
void
): array

Get the base encoding table.

The base encoding of all Standard Fonts is StandardEncoding but Symbol and ZapfDingbats. They use their own encoding.

See

getCapHeight()

public SetaPDF_Core_Font_Standard::getCapHeight (
void
): float

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

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

getDescent()

public SetaPDF_Core_Font_Standard::getDescent (
void
): float

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

getDictionary()

public SetaPDF_Core_Font::getDictionary (
void
): SetaPDF_Core_Type_Dictionary

Get the font dictionary.

getFontBBox()

public SetaPDF_Core_Font_Standard::getFontBBox (
void
): array

Returns the font bounding box.

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

getFontFamily()

public SetaPDF_Core_Font_Standard::getFontFamily (
void
): string

Get the font family.

getFontName()

public SetaPDF_Core_Font_Standard::getFontName (
void
): string

Get the font name.

getGlyphWidth()

public SetaPDF_Core_Font::getGlyphWidth (
string $char [, string $encoding = 'UTF-16BE' ]
): float|int

Get the width of a glyph/character.

Parameters
$char : string

The character

$encoding : string

The input encoding

getGlyphWidthByCharCode()

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

Get the width of a glpyh by its char code.

Parameters
$charCode : string
 

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_Standard::getItalicAngle (
void
): float

Returns the italic angle.

getMaxWidth()

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

Get the max. glyph width.

getMissingWidth()

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

Get the missing glyph width.

getResourceType()

public SetaPDF_Core_Font::getResourceType (
void
): string

Get the resource type.

See

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.

getXHeight()

public SetaPDF_Core_Font_Standard::getXHeight (
void
): float

Get the vertical coordinate of the top of flat non-ascending lowercase letters (like the letter x), measured from the baseline.

isBold()

public SetaPDF_Core_Font_Standard::isBold (
void
): boolean

Checks if the font is bold.

isItalic()

public SetaPDF_Core_Font_Standard::isItalic (
void
): boolean

Checks if the font is italic.

isMonospace()

public SetaPDF_Core_Font_Standard::isMonospace (
void
): boolean

Checks if the font is monospace.

recalculateFontBBox()

public SetaPDF_Core_Font::recalculateFontBBox (
void
): false|array

Re-calculate the font bounding box by analysing the metrics of all embedded glyphs.

Return Values

Format is [llx lly urx ury]. Returns false if the font isn't recalculatable

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::splitCharCodes (
string $charCodes
): array

Split a string of char codes into single char codes.

Parameters
$charCodes : string
 

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