Font.php

Go to the documentation of this file.

<?php
abstract class Zend_Pdf_Font
{
  /**** Class Constants ****/


  /* Font Types */

    const TYPE_UNKNOWN = 0;

    const TYPE_STANDARD = 1;

    const TYPE_TYPE_1 = 2;

    const TYPE_TRUETYPE = 3;

    const TYPE_TYPE_0 = 4;

    const TYPE_CIDFONT_TYPE_0 = 5;

    const TYPE_CIDFONT_TYPE_2 = 6;


  /* Names of the Standard 14 PDF Fonts */

    const FONT_COURIER = 'Courier';

    const FONT_COURIER_BOLD = 'Courier-Bold';

    const FONT_COURIER_OBLIQUE = 'Courier-Oblique';

    const FONT_COURIER_ITALIC = 'Courier-Oblique';

    const FONT_COURIER_BOLD_OBLIQUE = 'Courier-BoldOblique';

    const FONT_COURIER_BOLD_ITALIC = 'Courier-BoldOblique';

    const FONT_HELVETICA = 'Helvetica';

    const FONT_HELVETICA_BOLD = 'Helvetica-Bold';

    const FONT_HELVETICA_OBLIQUE = 'Helvetica-Oblique';

    const FONT_HELVETICA_ITALIC = 'Helvetica-Oblique';

    const FONT_HELVETICA_BOLD_OBLIQUE = 'Helvetica-BoldOblique';

    const FONT_HELVETICA_BOLD_ITALIC = 'Helvetica-BoldOblique';

    const FONT_SYMBOL = 'Symbol';

    const FONT_TIMES_ROMAN = 'Times-Roman';

    const FONT_TIMES = 'Times-Roman';

    const FONT_TIMES_BOLD = 'Times-Bold';

    const FONT_TIMES_ITALIC = 'Times-Italic';

    const FONT_TIMES_BOLD_ITALIC = 'Times-BoldItalic';

    const FONT_ZAPFDINGBATS = 'ZapfDingbats';


  /* Font Name String Types */

    const NAME_COPYRIGHT =  0;

    const NAME_FAMILY =  1;

    const NAME_STYLE =  2;

    const NAME_ID =  3;

    const NAME_FULL =  4;

    const NAME_VERSION =  5;

    const NAME_POSTSCRIPT =  6;

    const NAME_TRADEMARK =  7;

    const NAME_MANUFACTURER =  8;

    const NAME_DESIGNER =  9;

    const NAME_DESCRIPTION = 10;

    const NAME_VENDOR_URL = 11;

    const NAME_DESIGNER_URL = 12;

    const NAME_LICENSE = 13;

    const NAME_LICENSE_URL = 14;

    const NAME_PREFERRED_FAMILY = 16;

    const NAME_PREFERRED_STYLE = 17;

    const NAME_SAMPLE_TEXT = 19;

    const NAME_CID_NAME = 20;


  /* Font Weights */

    const WEIGHT_THIN = 100;

    const WEIGHT_EXTRA_LIGHT = 200;

    const WEIGHT_LIGHT = 300;

    const WEIGHT_NORMAL = 400;

    const WEIGHT_MEDIUM = 500;

    const WEIGHT_SEMI_BOLD = 600;

    const WEIGHT_BOLD = 700;

    const WEIGHT_EXTRA_BOLD = 800;

    const WEIGHT_BLACK = 900;


  /* Font Widths */

    const WIDTH_ULTRA_CONDENSED = 1;

    const WIDTH_EXTRA_CONDENSED = 2;

    const WIDTH_CONDENSED = 3;

    const WIDTH_SEMI_CONDENSED = 4;

    const WIDTH_NORMAL = 5;

    const WIDTH_SEMI_EXPANDED = 6;

    const WIDTH_EXPANDED = 7;

    const WIDTH_EXTRA_EXPANDED = 8;

    const WIDTH_ULTRA_EXPANDED = 9;


  /* Font Embedding Options */

    const EMBED_DONT_EMBED = 0x01;

    const EMBED_DONT_SUBSET = 0x02;

    const EMBED_DONT_COMPRESS = 0x04;

    const EMBED_SUPPRESS_EMBED_EXCEPTION = 0x08;



  /**** Class Variables ****/


    private static $_fontNames = array();

    private static $_fontFilePaths = array();



  /**** Public Interface ****/


  /* Factory Methods */

    public static function fontWithName($name, $embeddingOptions = 0)
        {
        /* First check the cache. Don't duplicate font objects.
         */
        if (isset(Zend_Pdf_Font::$_fontNames[$name])) {
            return Zend_Pdf_Font::$_fontNames[$name];
        }

        /* Not an existing font and no mapping in the config file. Check to see
         * if this is one of the standard 14 PDF fonts.
         */
        switch ($name) {
            case Zend_Pdf_Font::FONT_COURIER:
                #require_once 'Zend/Pdf/Resource/Font/Simple/Standard/Courier.php';
                $font = new Zend_Pdf_Resource_Font_Simple_Standard_Courier();
                break;

            case Zend_Pdf_Font::FONT_COURIER_BOLD:
                #require_once 'Zend/Pdf/Resource/Font/Simple/Standard/CourierBold.php';
                $font = new Zend_Pdf_Resource_Font_Simple_Standard_CourierBold();
                break;

            case Zend_Pdf_Font::FONT_COURIER_OBLIQUE:
                #require_once 'Zend/Pdf/Resource/Font/Simple/Standard/CourierOblique.php';
                $font = new Zend_Pdf_Resource_Font_Simple_Standard_CourierOblique();
                break;

            case Zend_Pdf_Font::FONT_COURIER_BOLD_OBLIQUE:
                #require_once 'Zend/Pdf/Resource/Font/Simple/Standard/CourierBoldOblique.php';
                $font = new Zend_Pdf_Resource_Font_Simple_Standard_CourierBoldOblique();
                break;

            case Zend_Pdf_Font::FONT_HELVETICA:
                #require_once 'Zend/Pdf/Resource/Font/Simple/Standard/Helvetica.php';
                $font = new Zend_Pdf_Resource_Font_Simple_Standard_Helvetica();
                break;

            case Zend_Pdf_Font::FONT_HELVETICA_BOLD:
                #require_once 'Zend/Pdf/Resource/Font/Simple/Standard/HelveticaBold.php';
                $font = new Zend_Pdf_Resource_Font_Simple_Standard_HelveticaBold();
                break;

            case Zend_Pdf_Font::FONT_HELVETICA_OBLIQUE:
                #require_once 'Zend/Pdf/Resource/Font/Simple/Standard/HelveticaOblique.php';
                $font = new Zend_Pdf_Resource_Font_Simple_Standard_HelveticaOblique();
                break;

            case Zend_Pdf_Font::FONT_HELVETICA_BOLD_OBLIQUE:
                #require_once 'Zend/Pdf/Resource/Font/Simple/Standard/HelveticaBoldOblique.php';
                $font = new Zend_Pdf_Resource_Font_Simple_Standard_HelveticaBoldOblique();
                break;

            case Zend_Pdf_Font::FONT_SYMBOL:
                #require_once 'Zend/Pdf/Resource/Font/Simple/Standard/Symbol.php';
                $font = new Zend_Pdf_Resource_Font_Simple_Standard_Symbol();
                break;

            case Zend_Pdf_Font::FONT_TIMES_ROMAN:
                #require_once 'Zend/Pdf/Resource/Font/Simple/Standard/TimesRoman.php';
                $font = new Zend_Pdf_Resource_Font_Simple_Standard_TimesRoman();
                break;

            case Zend_Pdf_Font::FONT_TIMES_BOLD:
                #require_once 'Zend/Pdf/Resource/Font/Simple/Standard/TimesBold.php';
                $font = new Zend_Pdf_Resource_Font_Simple_Standard_TimesBold();
                break;

            case Zend_Pdf_Font::FONT_TIMES_ITALIC:
                #require_once 'Zend/Pdf/Resource/Font/Simple/Standard/TimesItalic.php';
                $font = new Zend_Pdf_Resource_Font_Simple_Standard_TimesItalic();
                break;

            case Zend_Pdf_Font::FONT_TIMES_BOLD_ITALIC:
                #require_once 'Zend/Pdf/Resource/Font/Simple/Standard/TimesBoldItalic.php';
                $font = new Zend_Pdf_Resource_Font_Simple_Standard_TimesBoldItalic();
                break;

            case Zend_Pdf_Font::FONT_ZAPFDINGBATS:
                #require_once 'Zend/Pdf/Resource/Font/Simple/Standard/ZapfDingbats.php';
                $font = new Zend_Pdf_Resource_Font_Simple_Standard_ZapfDingbats();
                break;

            default:
                #require_once 'Zend/Pdf/Exception.php';
                throw new Zend_Pdf_Exception("Unknown font name: $name",
                                             Zend_Pdf_Exception::BAD_FONT_NAME);
        }

        /* Add this new font to the cache array and return it for use.
         */
        Zend_Pdf_Font::$_fontNames[$name] = $font;
        return $font;
    }

    public static function fontWithPath($filePath, $embeddingOptions = 0)
    {
        /* First check the cache. Don't duplicate font objects.
         */
        $filePathKey = md5($filePath);
        if (isset(Zend_Pdf_Font::$_fontFilePaths[$filePathKey])) {
            return Zend_Pdf_Font::$_fontFilePaths[$filePathKey];
        }

        /* Create a file parser data source object for this file. File path and
         * access permission checks are handled here.
         */
        #require_once 'Zend/Pdf/FileParserDataSource/File.php';
        $dataSource = new Zend_Pdf_FileParserDataSource_File($filePath);

        /* Attempt to determine the type of font. We can't always trust file
         * extensions, but try that first since it's fastest.
         */
        $fileExtension = strtolower(pathinfo($filePath, PATHINFO_EXTENSION));

        /* If it turns out that the file is named improperly and we guess the
         * wrong type, we'll get null instead of a font object.
         */
        switch ($fileExtension) {
            case 'ttf':
                $font = Zend_Pdf_Font::_extractTrueTypeFont($dataSource, $embeddingOptions);
                break;

            default:
                /* Unrecognized extension. Try to determine the type by actually
                 * parsing it below.
                 */
                $font = null;
                break;
        }


        if ($font === null) {
            /* There was no match for the file extension or the extension was
             * wrong. Attempt to detect the type of font by actually parsing it.
             * We'll do the checks in order of most likely format to try to
             * reduce the detection time.
             */

            // OpenType

            // TrueType
            if (($font === null) && ($fileExtension != 'ttf')) {
                $font = Zend_Pdf_Font::_extractTrueTypeFont($dataSource, $embeddingOptions);
            }

            // Type 1 PostScript

            // Mac OS X dfont

            // others?
        }


        /* Done with the data source object.
         */
        $dataSource = null;

        if ($font !== null) {
            /* Parsing was successful. Add this font instance to the cache arrays
             * and return it for use.
             */
            $fontName = $font->getFontName(Zend_Pdf_Font::NAME_POSTSCRIPT, '', '');
            Zend_Pdf_Font::$_fontNames[$fontName] = $font;
            $filePathKey = md5($filePath);
            Zend_Pdf_Font::$_fontFilePaths[$filePathKey] = $font;
            return $font;

        } else {
            /* The type of font could not be determined. Give up.
             */
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception("Cannot determine font type: $filePath",
                                         Zend_Pdf_Exception::CANT_DETERMINE_FONT_TYPE);
         }

    }



  /**** Internal Methods ****/


  /* Font Extraction Methods */

    protected static function _extractTrueTypeFont($dataSource, $embeddingOptions)
    {
        try {
            #require_once 'Zend/Pdf/FileParser/Font/OpenType/TrueType.php';
            $fontParser = new Zend_Pdf_FileParser_Font_OpenType_TrueType($dataSource);

            $fontParser->parse();
            if ($fontParser->isAdobeLatinSubset) {
                #require_once 'Zend/Pdf/Resource/Font/Simple/Parsed/TrueType.php';
                $font = new Zend_Pdf_Resource_Font_Simple_Parsed_TrueType($fontParser, $embeddingOptions);
            } else {
                #require_once 'Zend/Pdf/Resource/Font/CidFont/TrueType.php';
                #require_once 'Zend/Pdf/Resource/Font/Type0.php';
                /* Use Composite Type 0 font which supports Unicode character mapping */
                $cidFont = new Zend_Pdf_Resource_Font_CidFont_TrueType($fontParser, $embeddingOptions);
                $font    = new Zend_Pdf_Resource_Font_Type0($cidFont);
            }
        } catch (Zend_Pdf_Exception $e) {
            /* The following exception codes suggest that this isn't really a
             * TrueType font. If we caught such an exception, simply return
             * null. For all other cases, it probably is a TrueType font but has
             * a problem; throw the exception again.
             */
            $fontParser = null;
            #require_once 'Zend/Pdf/Exception.php';
            switch ($e->getCode()) {
                case Zend_Pdf_Exception::WRONG_FONT_TYPE:    // break intentionally omitted
                case Zend_Pdf_Exception::BAD_TABLE_COUNT:    // break intentionally omitted
                case Zend_Pdf_Exception::BAD_MAGIC_NUMBER:
                    return null;

                default:
                    throw new Zend_Pdf_Exception($e->getMessage(), $e->getCode(), $e);
            }
        }
        return $font;
    }
}