mPDF supports Truetype fonts, reading and embedding directly from the .ttf font files. Fonts must follow the Truetypespecification and use Unicode mapping to the characters. Truetype collections (.ttc files) and Opentype files (.otf)in Truetype format are also supported.
fontDir configuration parameter or by calling$mpdf->AddFontDirectory() methodfontData parameter arrayMpdf\Language\LanguageToFontInterfaceandMpdf\Language\ScriptToLanguage implementationFor working code example, feel free to look into theexamples repository.
You have 2 font filesFrutiger-Normal.ttf andFrutigerObl-Normal.ttf which you want to be available in mPDF,and you will refer to them in HTML/CSS asfrutiger.
Define the directory with the font viafontDir configuration key or add it after instantiationwith$mpdf->AddFontDirectory() method
Define the font details infontdata configuration variable - font name must containlowercase letters only, i.e.frutiger.
Example below shows how to maintain default fonts and their settings
<?php$defaultConfig=(new\Mpdf\Config\ConfigVariables())->getDefaults();$fontDirs=$defaultConfig['fontDir'];$defaultFontConfig=(new\Mpdf\Config\FontVariables())->getDefaults();$fontData=$defaultFontConfig['fontdata'];$mpdf=new\Mpdf\Mpdf(['fontDir'=>array_merge($fontDirs,[__DIR__.'/custom/font/directory',]),'fontdata'=>$fontData+[// lowercase letters only in font key'frutiger'=>['R'=>'Frutiger-Normal.ttf','I'=>'FrutigerObl-Normal.ttf',]],'default_font'=>'frutiger']);For fonts which handle complex scripts and/or right-to-left text, seeOpenType layout (OTL) fordetails of setting OTL use and support for kashida e.g.
<?php'frutiger'=>['R'=>'Frutiger-Normal.ttf','I'=>'FrutigerObl-Normal.ttf','useOTL'=>0xFF,'useKashida'=>75,],In your HTML or CSS code use something like this:
<pstyle="font-family: frutiger">Text in Frutiger</p>You can use full names even with spaces in CSS font-family definition
<pstyle="font-family: Frutiger">Text in Frutiger</p>To use the font with specific languages you need to extend theMpdf\Language\LanguageToFont class (if you require granular control you should implementMpdf\Language\LanguageToFontInterface yourself).
<?phpclassCustomLanguageToFontImplementationextends\Mpdf\Language\LanguageToFont{publicfunctiongetLanguageOptions($llcc,$adobeCJK){if($llcc==='th'){return[false,'frutiger'];// for thai language, font is not core suitable and the font is Frutiger}returnparent::getLanguageOptions($llcc,$adobeCJK);}}$mpdf=new\Mpdf\Mpdf(['languageToFont'=>newCustomLanguageToFontImplementation()]);This will enable the Frutiger font whenever the lang attribute is set, if the configurable variableautoLangToFont is set totrue (default):
<plang="th">Text in Frutiger</p>When usingautoLangToFont mPDF may identify the script but not the language and$llcc will be set tound-{$script}.
The DejaVu fonts distributed with mPDF contain an extensive set of characters - seeUnicodecoverage of free fonts for details of these and other open-source fonts.
Arabic languages and Hebrew are written in a right-to-left direction (RTL). mPDF recognises both Arabic andHebrew languages and reverses text direction automatically.
ألسّلام عليكم שלום
Arabic languages (but not Hebrew) also change the form of the letter depending on its position in the text e.g.these are the initial, medial, final, and isolated forms of arabic letter ‘ain’:
ع ـع ـعـ عـ
Note: You must enable OpenType layout (OTL) features for a font to correctly display right-to-left scripts.
Other complex scripts require some processing of characters before display. For example some vowels consist of 2characters, to be placed before and after the adjacent consonant e.g.
U+0D1C + U+0D4C [vowel AU] = [written together as ജൌ]
ജ + ൌ = ജൌ
Consonant conjuncts are where two adjacent characters are written as a single ‘conjunct’ form e.g.
प + ॡ = पॣ
Note: You must enable OpenType layout (OTL) features for a font to correctly display complex scripts.
Vertical writing is not supported by mPDF (e.g. Mongolian and Phags-pa) although the individual characterscan be displayed using suitable fonts.
The original Unicode allocated characters between x0000 and xFFFF (65,536 characters). This ‘Basic Multilingual Plane’supported most characters in common use, including a large number of Unified Chinese-Japanese-Korean characters (CJK).Later the Unicode standard was extended to 16 Planes.
The first plane (plane 0), the Basic Multilingual Plane (BMP), is where most characters have been assigned so far.
Plane 1, the Supplementary Multilingual Plane (SMP), is mostly used for historic scripts such as Linear B, but is alsoused for musical and mathematical symbols.
Plane 2, the Supplementary Ideographic Plane (SIP), is used for about 40,000 Unified Han (CJK) Ideographs.
mPDF supports fonts containing characters from all Unicode Planes. By choosing the correct font, almost every singlecharacter from Unicode 5 can be displayed in a PDF file.
The Unicode Supplementary Multilingual Plane contains ranges such as Gothic text and Egyptian Hieroglyphics. as well asother (mainly) ancient scripts - seeUnicodecoverage of free fonts for full list.
mPDF uses a different method to embed fonts in the PDF file if they include characters from SMP or SIP, because thecharacters cannot be represented by a 4 character hex code 0000-FFFF. This method is less efficient than the defaultmethod, and it can be suppressed by adding the font name to the configuration keyBMPonly configuration key.
Note that the DejaVu fonts distributed with mPDF do contain a few characters in the SMP plane, but most users willnot require them and by default they are added to the arrayBMPonly.
Fonts containing CJK characters are large files, typically 10-30MB. Adobe provides a free download of an‘Asian font pack’ allowing you to create PDF files without including (embedding) the font information in the file.This keeps the file size to a minimum and minimises resource usage on your website generating the PDF file. However,users will have to download the Adobe font packs to read the file, and other PDF software will notdisplay the text correctly.
mPDF allows you to embed subsets of CJK fonts keeping file size down, although there is considerable memory usageto generate these files.
Some CJK fonts are broken up into 2 files because of the size of the files. One freely available font with almostcomplete coverage of all CJK characters (in both BMP and SIP) is ‘Sun’ available from Alan Wood’s excellent website:http://www.alanwood.net/unicode/fonts-east-asian.html.This comes as 2 files, Sun-ExtA and Sun-ExtB (both about 20MB in size) containing the characters fromBMP and SIP respectively.
mPDF allows you to treat these as one font by defining the second file as an SIP-extension of the first.
This is an example of the entry in thefontdata configuration key:
<?php'fontdata'=['sun-exta'=>['R'=>'Sun-ExtA.ttf','sip-ext'=>'sun-extb',],'sun-extb'=>['R'=>'Sun-ExtB.ttf',],];This is a sample of HTML code containing CJK characters in both BMP and SIP - note only the sun-exta font-familyneeds to be referenced:
<divstyle="font-family:sun-extA;">鼂鼈鼗𣈏𣈥鼦鼧𣈯𣈱鼹齄𣈲𣈳齅齐𣈴𣉖齓齚𣉢𣊁齢齩𣊉𣊊</div>TrueType Collections (.ttc files) contain more than one font. mPDF treats each font separately by defining theTTCfontID array in the$config mPDF constrctor parameter.
This example uses the Windows MingLiU fonts, which consist of 2 files containing 6 fonts (note that mingliub is nota Bold variant):
Font collection file (mingliu.ttc) contains the following fonts:
Font collection file (mingliub.ttc) contains the following fonts:
This is the entry in the mPDF configuration:
<?php$config=['fontdata'=['mingliu'=>['R'=>'mingliu.ttc','TTCfontID'=>['R'=>1,],'sip-ext'=>'mingliu-extb',],'pmingliu'=>['R'=>'mingliu.ttc','TTCfontID'=>['R'=>2,],'sip-ext'=>'pmingliu-extb',],'mingliu_hkscs'=>['R'=>'mingliu.ttc','TTCfontID'=>['R'=>3,],'sip-ext'=>'mingliu_hkscs-extb',],'mingliu-extb'=>['R'=>'mingliub.ttc','TTCfontID'=>['R'=>1,],],'pmingliu-extb'=>['R'=>'mingliub.ttc','TTCfontID'=>['R'=>2,],],'mingliu_hkscs-extb'=>['R'=>'mingliub.ttc','TTCfontID'=>['R'=>3,],],]];This is an example of HTML code containing CJK characters from both BMP and SIP, and selecting the different fonts:
<divstyle="font-family:mingliu;">鼂鼦齄齐齢齩𣊉𣊊</div><divstyle="font-family:mingliu_hkscs;">鼂鼦齄齐齢齩𣊉𣊊</div><divstyle="font-family:pmingliu;">鼂鼦齄齐齢齩𣊉𣊊</div>