README

sfnt2woff is a PHP class for converting OTF, TTF, TTC and OTC files to WOFF 1.0 and 2.0.

Requirements

• PHP 8.0+
• ZLIB extension for WOFF 1.0 export
• Brotli extension for WOFF 2.0 export

Limitations

WOFF 2.0 export uses a null transformation: table data is not optimized.

Usage

Convert a font to WOFF 1.0:

$sfnt2woff = new \xenocrat\sfnt2woff();
$sfnt = file_get_contents("font.ttf");
$sfnt2woff->sfnt_import($sfnt);
$woff = $sfnt2woff->woff1_export();
file_put_contents("font.woff", $woff);

Convert a font to WOFF 2.0:

$sfnt2woff = new \xenocrat\sfnt2woff();
$sfnt = file_get_contents("font.ttf");
$sfnt2woff->sfnt_import($sfnt);
$woff = $sfnt2woff->woff2_export();
file_put_contents("font.woff2", $woff);

Methods

sfnt_import

Description

public sfnt2woff::sfnt_import(
    string $sfnt,
    bool $verify_checksums = true
): void

Imports SFNT data from a TTF or OTF font source.

Parameters

• sfnt

  A complete TTF or OTF file as a string of data.

• verify_checksums

  Whether or not to verify the table data checksums on import.

otfc_import

Description

public sfnt2woff::otfc_import(
    string $otfc,
    bool $verify_checksums = true
): void

Imports TTC or OTC data from a TrueType or OpenType font collection.

Parameters

• otfc

  A complete TTC or OTC file as a string of data.

• verify_checksums

  Whether or not to verify the table data checksums on import.

otfc_extract

Description

public sfnt2woff::otfc_extract(
    int $index
): void

Extracts SFNT data from a TrueType or OpenType font collection. After extraction, the data can be exported using woff1_export or woff2_export.

Parameters

• index

  The zero-based index of the font in a collection imported using otfc_import. The total number of fonts in the collection is returned by get_otfc_info.

woff1_export

Description

public sfnt2woff::woff1_export(
    int $compression_level = -1
): string|false

Exports SFNT data in WOFF 1.0 format.

Parameters

• compression_level

  The compression level, from 0 (minimum) to 9 (maximum). Defaults to 6.

Return Values

Returns a complete WOFF 1.0 file as a string of data, or false if there is no data to export.

woff2_export

Description

public sfnt2woff::woff2_export(
    int $compression_level = -1
): string|false

Exports SFNT data in WOFF 2.0 format.

Parameters

• compression_level

  The compression level, from 0 (minimum) to 11 (maximum). Defaults to BROTLI_COMPRESS_LEVEL_DEFAULT.

Return Values

Returns a complete WOFF 2.0 file as a string of data, or false if there is no data to export.

woffc_export

Description

public sfnt2woff::woffc_export(
    int $compression_level = -1
): string|false

Exports TTC or OTC data in WOFF 2.0 font collection format.

Parameters

• compression_level

  The compression level, from 0 (minimum) to 11 (maximum). Defaults to BROTLI_COMPRESS_LEVEL_DEFAULT.

Return Values

Returns a complete WOFF 2.0 collection file as a string of data, or false if there is no data to export.

set_woff_version

Description

public sfnt2woff::set_woff_version(
    int $major,
    int $major
): void

Set the major and minor version numbers for WOFF exports.

Parameters

• major

  The major version, an integer in the range 0-65535.

• minor

  The minor version, an integer in the range 0-65535.

get_woff_version

Description

public sfnt2woff::get_woff_version(
): array

Get the major and minor version numbers for WOFF exports.

Return Values

Returns an array of two integers representing the major and minor version numbers.

set_woff_meta

Description

public sfnt2woff::set_woff_meta(
    SimpleXMLElement $object
): void

Set the WOFF extended metadata block.

Parameters

• object

  A SimpleXMLElement object representing the XML metadata.

get_woff_meta

Description

public sfnt2woff::get_woff_meta(
): object|false

Get the WOFF extended metadata block.

Return Values

Returns a SimpleXMLElement object representing the XML metadata, or false if no metadata block has been set.

set_woff_priv

Description

public sfnt2woff::set_woff_priv(
    string $data
): void

Set the WOFF private data block.

Parameters

• data

  A string of data representing the private data block.

get_woff_priv

Description

public sfnt2woff::get_woff_priv(
): string|false

Get the WOFF private data block.

Return Values

Returns a string of data representing the private data block, or false if no private data block has been set.

get_sfnt_info

Description

public sfnt2woff::get_sfnt_info(
): array|false

Returns information about SFNT data imported using sfnt_import or otfc_extract.

Return Values

Returns an associative array, or false if no data has been imported.

get_otfc_info

Description

public sfnt2woff::get_otfc_info(
): array|false

Returns information about TTC or OTC data imported using otfc_import.

Return Values

Returns an associative array, or false if no data has been imported.