Class: I2CE FontMetric

This article describes the class I2CE_FontMetric.

• Child Classes:
  • I2CE_FontMetricMultiDirection
    • I2CE_FontMetricAFM
    • I2CE_FontMetricTTF
• Location: Part of the module textlayout in the package TextLayout Tools
• Source: Defined in the file lib/I2CE_FontMetric.php on line 22
• Author: Carl Leitner <litlfred@ibiblio.org>

Class to contain information about font metrics.

Variables

$bbox

protected @var $bbox of numeric. the bounding box with values in order llx lly urx ury

• Defined in textlayout/lib/I2CE_FontMetric.php on line 26
• Type: protected $bbox

$ascender

protected @var numeric $ascender

• Defined in textlayout/lib/I2CE_FontMetric.php on line 30
• Type: protected $ascender

$descender

protected @var numeric $ascender

• Defined in textlayout/lib/I2CE_FontMetric.php on line 35
• Type: protected $descender

$linegap

protected @var numeric $linegap

• Defined in textlayout/lib/I2CE_FontMetric.php on line 40
• Type: protected $linegap

$is_fixed_width

protected @var array of boolean $is_fixed_width whether or not this font is fixed width

• Defined in textlayout/lib/I2CE_FontMetric.php on line 45
• Type: protected $is_fixed_width

$fixed_character_width

protected @var int the size of a fixed width character

• Defined in textlayout/lib/I2CE_FontMetric.php on line 50
• Type: protected $fixed_character_width

$fixed_character_height

protected @var int the size of a fixed width character

• Defined in textlayout/lib/I2CE_FontMetric.php on line 56
• Type: protected $fixed_character_height

$size

protected @var int $size the font size in points

• Defined in textlayout/lib/I2CE_FontMetric.php on line 62
• Type: protected $size

$encoding

proteted @var I2CE_Encoding encoding data for the character set

• Defined in textlayout/lib/I2CE_FontMetric.php on line 69
• Type: protected $encoding

$kerning_table_pairs

protected @var array of array of numbers $kerning_table_pairs the kerning table for pairs. the first index is the preceeding character the second index is the following character

• Defined in textlayout/lib/I2CE_FontMetric.php on line 76
• Type: protected $kerning_table_pairs

$kerning_table_groups

protected @var array of array of numbers $kerning_table_groups the kerning table for groups. the first index is the group for the preceeding character the second index is the group for the following character

• Defined in textlayout/lib/I2CE_FontMetric.php on line 82
• Type: protected $kerning_table_groups

$kerning_groups

protected $var array with keys character and values the kerning groups

• Defined in textlayout/lib/I2CE_FontMetric.php on line 87
• Type: protected $kerning_groups

$character_widths

of floats containing $character_widths the character widths for the current font to be super redundant the keys will be either the character code or the glyph name

• Defined in textlayout/lib/I2CE_FontMetric.php on line 95
• Type: public array $character_widths

$character_heights

of array of floats $character_heights containing the character heights for the current font to be super redundant the keys will be either the character code or the glyph name

• Defined in textlayout/lib/I2CE_FontMetric.php on line 102
• Type: public array $character_heights

$character_info

of array of mixed $character_info containing character information (besides the width)

• Defined in textlayout/lib/I2CE_FontMetric.php on line 107
• Type: public array $character_info

$font_info

protected @var array of mixed global font information

• Defined in textlayout/lib/I2CE_FontMetric.php on line 112
• Type: protected $font_info

Methods

__construct()

• Defined in textlayout/lib/I2CE_FontMetric.php on line 119
• Signature: public function __construct($encoding)
• Parameters:
  • I2CE_Encoding $encoding
    the encoding used for the internal storage of strings/characters needs to be one that is a valid encoding for PHP multibyte strings.

getAllFontCharacteristics()

Get all the font information

• Defined in textlayout/lib/I2CE_FontMetric.php on line 451
• Signature: public function getAllFontCharacteristics()

getAscender()

get the asceneder value

• Defined in textlayout/lib/I2CE_FontMetric.php on line 231
• Signature: public function getAscender()
• Returns: numeric
  $ascender *

getBoundingBox()

Get the bounding box $returns array $bbox of numeric. The bounding box in llx lly urx ury order

• Defined in textlayout/lib/I2CE_FontMetric.php on line 283
• Signature: public function getBoundingBox()

getCharacterHeight()

Gets the character height of a character

• Defined in textlayout/lib/I2CE_FontMetric.php on line 413
• Signature: public function getCharacterHeight($ch,$use_font_size)
• Parameters:
  • mixed $ch
    a character @param bool use_font_size default false --
  • $use_font_size
    • Default Value: false
• Returns: float
  the width

getCharacterHeights()

Get the character heights

• Defined in textlayout/lib/I2CE_FontMetric.php on line 443
• Signature: public function getCharacterHeights()
• Returns: array
  of number, the values of which are the heights and the keys of which are some combination of glpyh names, character codes, and unicodes codepoints, or characters

getCharacterInfo()

Get information associated to a character

• Defined in textlayout/lib/I2CE_FontMetric.php on line 335
• Signature: public function getCharacterInfo($ch,$key)
• Parameters:
  • mixed $ch
    a character (or glyphname)
  • mixed $key
• Returns: mixed
  $value

getCharacterWidth()

Gets the character width of a character

• Defined in textlayout/lib/I2CE_FontMetric.php on line 363
• Signature: public function getCharacterWidth($ch,$use_font_size)
• Parameters:
  • mixed $ch
    a character (or glyphname) @param bool use_font_size default false --
  • $use_font_size
    • Default Value: false
• Returns: float
  the width

getCharacterWidths()

Get the character widths

• Defined in textlayout/lib/I2CE_FontMetric.php on line 432
• Signature: public function getCharacterWidths()
• Returns: array
  of number, the values of which are the widths and the keys of which are some combination of glpyh names, character codes, and unicodes codepoints, or characters

getDescender()

get the desceneder value

• Defined in textlayout/lib/I2CE_FontMetric.php on line 248
• Signature: public function getDescender()
• Returns: numeric
  $descender *

getEncoding()

Get the encoding used for the internal storage of strings/characters

• Defined in textlayout/lib/I2CE_FontMetric.php on line 128
• Signature: public function getEncoding()
• Returns: string

getFixedStringWidth()

Caluclulate the length of a fixed width string

• Defined in textlayout/lib/I2CE_FontMetric.php on line 136
• Signature: protected function getFixedStringWidth($string)
• Parameters:
  • string $string
    the string we wish to calculate the length of
• Returns: float/int
  the length of the string

getFixedWidth()

Get the width of a character in a fixed width font

• Defined in textlayout/lib/I2CE_FontMetric.php on line 319
• Signature: public function getFixedWidth()
• Returns: number
  Returns null if called when the current font is not fixed width

getFontCharacteristic()

Get a global font characteristic @param $key

• Defined in textlayout/lib/I2CE_FontMetric.php on line 474
• Signature: public function getFontCharacteristic($key)
• Parameters:
  • $key
• Returns: mixed
  the value associated to the $key

getFontSize()

Get the font size

• Defined in textlayout/lib/I2CE_FontMetric.php on line 493
• Signature: public function getFontSize()
• Returns: int

getKerningByGroup()

get the kerning values associated to a pair of groups

• Defined in textlayout/lib/I2CE_FontMetric.php on line 570
• Signature: public function getKerningByGroup($g1,$g2,$use_font_size)
• Parameters:
  • mixed $g1
    the preceeding group
  • mixed $g2
    the following group @param bool use_font_size default false --
  • $use_font_size
    • Default Value: false
• Returns: numeric
  $kern the kerning value or null if none found

getKerningByPair()

get the kerning values associated to a pair of character

• Defined in textlayout/lib/I2CE_FontMetric.php on line 530
• Signature: public function getKerningByPair($ch1,$ch2,$use_font_size)
• Parameters:
  • mixed $ch1
    the preceeding character
  • mixed $ch2
    the following character @param bool use_font_size default false --
  • $use_font_size
    • Default Value: false
• Returns: numeric
  the kerning value or null if there is none found

getKerningGroup()

Get the kerning groups associated to a character

• Defined in textlayout/lib/I2CE_FontMetric.php on line 503
• Signature: public function getKerningGroup($ch)
• Parameters:
  • mixed $ch
    the character
• Returns: mixed
  the group

getKerningValue()

Return the (horizontal) kerning values for a pair of characters If there is kerning info for both groups and pairs, the pairs takes prescedence @params string $ch1 the left characcter @params string $ch2 the right character @param bool use_font_size default false --

• Defined in textlayout/lib/I2CE_FontMetric.php on line 613
• Signature: public function getKerningValue($ch1,$ch2,$use_font_size)
• Parameters:
  • $ch1
  • $ch2
  • $use_font_size
• Returns: number
  the kerning value or null if none is found

getLinegap()

get the line gap value

• Defined in textlayout/lib/I2CE_FontMetric.php on line 265
• Signature: public function getLinegap()
• Returns: numeric
  $linegap *

getStringWidth()

Caluclulate the length of a string

• Defined in textlayout/lib/I2CE_FontMetric.php on line 154
• Signature: public function getStringWidth($string,$use_font_size)
• Parameters:
  • string $string
    the string we wish to calculate the length of
  • $use_font_size
    • Default Value: false
• Returns: float/int
  the length of the string note: if it is a fixed width font, we assume that all characters are printable. in particular a line break is considered a printable character. If you have line breaks to deal with @param bool use_font_size default false -- you should see TextColumn

getTrackingValues()

Get the tracking values for the current font size

• Defined in textlayout/lib/I2CE_FontMetric.php on line 632
• Signature: public function getTrackingValues()
• Returns: array
  $values of floats. $values[0] is the minimum, $values[1] is the maximum or null if if there is no tracking values

getVariableStringWidth()

Function caluclulate the length of a variable width string

• Defined in textlayout/lib/I2CE_FontMetric.php on line 178
• Signature: protected function getVariableStringWidth($string)
• Parameters:
  • string $string
    the string we wish to calculate the length of @param bool use_font_size default false --
• Returns: float
  the length of the string

isFixedWidth()

Check to see if the current font is fixed width

• Defined in textlayout/lib/I2CE_FontMetric.php on line 308
• Signature: public function isFixedWidth()
• Returns: boolean
  true if it is fixed width

setAscender()

set the asceneder value

• Defined in textlayout/lib/I2CE_FontMetric.php on line 222
• Signature: public function setAscender($ascender)
• Parameters:
  • numeric $ascender *

setBoundingBox()

Set the bounding box $param array $bbox of numeric. The bounding box in llx lly urx ury order

• Defined in textlayout/lib/I2CE_FontMetric.php on line 275
• Signature: public function setBoundingBox($bbox)
• Parameters:
  • $bbox

setCharacterHeight()

Sets the character width of a character

• Defined in textlayout/lib/I2CE_FontMetric.php on line 400
• Signature: public function setCharacterHeight($ch,$h)
• Parameters:
  • mixed $ch
    a character (or glyphname)
  • numeric $h
    the $height

setCharacterInfo()

Sets information associated to a character

• Defined in textlayout/lib/I2CE_FontMetric.php on line 349
• Signature: public function setCharacterInfo($ch,$key,$value)
• Parameters:
  • mixed $ch
    a character (or glyphname)
  • mixed $key
  • mixed $value

setCharacterWidth()

Sets the character width of a character

• Defined in textlayout/lib/I2CE_FontMetric.php on line 384
• Signature: public function setCharacterWidth($ch,$w)
• Parameters:
  • mixed $ch
    a character (or glyphname)
  • numeriv $w
    the width

setDescender()

set the desceneder value

• Defined in textlayout/lib/I2CE_FontMetric.php on line 239
• Signature: public function setDescender($descender)
• Parameters:
  • numeric $descender *

setFixedHeightSize()

set the fixed height character size

• Defined in textlayout/lib/I2CE_FontMetric.php on line 300
• Signature: public function setFixedHeightSize($height)
• Parameters:
  • numeric $height
    the width

setFixedWidth()

Set whether or not this is a fixed width font @parma boolean $is_fixed_width

• Defined in textlayout/lib/I2CE_FontMetric.php on line 213
• Signature: public function setFixedWidth($is_fixed_width)
• Parameters:
  • $is_fixed_width

setFixedWidthSize()

set the fixed width character size

• Defined in textlayout/lib/I2CE_FontMetric.php on line 292
• Signature: public function setFixedWidthSize($width)
• Parameters:
  • numeric $width
    the width

setFontCharacteristic()

Set a global font characteristic

• Defined in textlayout/lib/I2CE_FontMetric.php on line 462
• Signature: public function setFontCharacteristic($key,$value)
• Parameters:
  • string $key
  • mixed $value

setFontSize()

Set the font size @params int $size

• Defined in textlayout/lib/I2CE_FontMetric.php on line 485
• Signature: public function setFontSize($size)
• Parameters:
  • $size

setKerningByGroup()

get the kerning values associated to a pair of groups

• Defined in textlayout/lib/I2CE_FontMetric.php on line 592
• Signature: public function setKerningByGroup($g1,$g2,$kern)
• Parameters:
  • mixed $g1
    the preceeding group
  • mixed $g2
    the following grou @params numeric $kern the kerning value
  • $kern

setKerningByPair()

set the kerning values associated to a pair of character

• Defined in textlayout/lib/I2CE_FontMetric.php on line 551
• Signature: public function setKerningByPair($ch1,$ch2,$kern)
• Parameters:
  • mixed $ch1
    the preceeding character
  • mixed $ch2
    the following character @params numeric $kern the kerning value
  • $kern

setKerningGroup()

Set the kerning groups associated to a character

• Defined in textlayout/lib/I2CE_FontMetric.php on line 516
• Signature: public function setKerningGroup($ch,$group)
• Parameters:
  • mixed $ch
    the character
  • mixed $group
    the group

setLinegap()

set the line gap value

• Defined in textlayout/lib/I2CE_FontMetric.php on line 256
• Signature: public function setLinegap($linegap)
• Parameters:
  • numeric $linegap *