Dompdf\Options
Synopsis
class Options
{
- // members
- private $rootDir;
- private $tempDir;
- private $fontDir;
- private $fontCache;
- private $chroot;
- private $logOutputFile;
- private string $defaultMediaType = "screen";
- private string $defaultPaperSize = "letter";
- private string $defaultPaperOrientation = "portrait";
- private string $defaultFont = "serif";
- private integer $dpi = 96;
- private float $fontHeightRatio = 1.1;
- private bool $isPhpEnabled = false;
- private bool $isRemoteEnabled = false;
- private bool $isJavascriptEnabled = true;
- private bool $isHtml5ParserEnabled = false;
- private bool $isFontSubsettingEnabled = false;
- private bool $debugPng = false;
- private bool $debugKeepTemp = false;
- private bool $debugCss = false;
- private bool $debugLayout = false;
- private bool $debugLayoutLines = true;
- private bool $debugLayoutBlocks = true;
- private bool $debugLayoutInline = true;
- private bool $debugLayoutPaddingBox = true;
- private string $pdfBackend = "CPDF";
- private string $pdflibLicense = "";
- private string $adminUsername = "user";
- private string $adminPassword = "password";
- // methods
- public void __construct()
- public $this set()
- public mixed get()
- public $this setAdminPassword()
- public string getAdminPassword()
- public $this setAdminUsername()
- public string getAdminUsername()
- public $this setPdfBackend()
- public string getPdfBackend()
- public $this setPdflibLicense()
- public string getPdflibLicense()
- public $this setChroot()
- public string getChroot()
- public $this setDebugCss()
- public boolean getDebugCss()
- public $this setDebugKeepTemp()
- public boolean getDebugKeepTemp()
- public $this setDebugLayout()
- public boolean getDebugLayout()
- public $this setDebugLayoutBlocks()
- public boolean getDebugLayoutBlocks()
- public $this setDebugLayoutInline()
- public boolean getDebugLayoutInline()
- public $this setDebugLayoutLines()
- public boolean getDebugLayoutLines()
- public $this setDebugLayoutPaddingBox()
- public boolean getDebugLayoutPaddingBox()
- public $this setDebugPng()
- public boolean getDebugPng()
- public $this setDefaultFont()
- public string getDefaultFont()
- public $this setDefaultMediaType()
- public string getDefaultMediaType()
- public $this setDefaultPaperSize()
- public $this setDefaultPaperOrientation()
- public string getDefaultPaperSize()
- public string getDefaultPaperOrientation()
- public $this setDpi()
- public int getDpi()
- public $this setFontCache()
- public string getFontCache()
- public $this setFontDir()
- public string getFontDir()
- public $this setFontHeightRatio()
- public float getFontHeightRatio()
- public $this setIsFontSubsettingEnabled()
- public boolean getIsFontSubsettingEnabled()
- public boolean isFontSubsettingEnabled()
- public $this setIsHtml5ParserEnabled()
- public boolean getIsHtml5ParserEnabled()
- public boolean isHtml5ParserEnabled()
- public $this setIsJavascriptEnabled()
- public boolean getIsJavascriptEnabled()
- public boolean isJavascriptEnabled()
- public $this setIsPhpEnabled()
- public boolean getIsPhpEnabled()
- public boolean isPhpEnabled()
- public $this setIsRemoteEnabled()
- public boolean getIsRemoteEnabled()
- public boolean isRemoteEnabled()
- public $this setLogOutputFile()
- public string getLogOutputFile()
- public $this setTempDir()
- public string getTempDir()
- public $this setRootDir()
- public string getRootDir()
Members
private
- $adminPassword — string
- $adminUsername — string
- $chroot
—
string
dompdf's "chroot" - $debugCss — Dompdf\bool
- $debugKeepTemp — Dompdf\bool
- $debugLayout — Dompdf\bool
- $debugLayoutBlocks — Dompdf\bool
- $debugLayoutInline — Dompdf\bool
- $debugLayoutLines — Dompdf\bool
- $debugLayoutPaddingBox — Dompdf\bool
- $debugPng — Dompdf\bool
- $defaultFont
—
string
The default font family - $defaultMediaType
—
string
html target media view which should be rendered into pdf. - $defaultPaperOrientation
—
string
The default paper orientation. - $defaultPaperSize
—
string
The default paper size. - $dpi
—
int
Image DPI setting - $fontCache
—
string
The location of the DOMPDF font cache directory - $fontDir
—
string
The location of the DOMPDF font directory - $fontHeightRatio
—
float
A ratio applied to the fonts height to be more like browsers' line height - $isFontSubsettingEnabled
—
Dompdf\bool
Whether to enable font subsetting or not. - $isHtml5ParserEnabled
—
Dompdf\bool
Use the more-than-experimental HTML5 Lib parser - $isJavascriptEnabled
—
Dompdf\bool
Enable inline Javascript - $isPhpEnabled
—
Dompdf\bool
Enable embedded PHP - $isRemoteEnabled
—
Dompdf\bool
Enable remote file access - $logOutputFile — string
- $pdfBackend
—
string
The PDF rendering backend to use - $pdflibLicense
—
string
PDFlib license key - $rootDir
—
string
The root of your DOMPDF installation - $tempDir
—
string
The location of a temporary directory.
Methods
public
- __construct()
- get()
- getAdminPassword()
- getAdminUsername()
- getChroot()
- getDebugCss()
- getDebugKeepTemp()
- getDebugLayout()
- getDebugLayoutBlocks()
- getDebugLayoutInline()
- getDebugLayoutLines()
- getDebugLayoutPaddingBox()
- getDebugPng()
- getDefaultFont()
- getDefaultMediaType()
- getDefaultPaperOrientation()
- getDefaultPaperSize()
- getDpi()
- getFontCache()
- getFontDir()
- getFontHeightRatio()
- getIsFontSubsettingEnabled()
- getIsHtml5ParserEnabled()
- getIsJavascriptEnabled()
- getIsPhpEnabled()
- getIsRemoteEnabled()
- getLogOutputFile()
- getPdfBackend()
- getPdflibLicense()
- getRootDir()
- getTempDir()
- isFontSubsettingEnabled()
- isHtml5ParserEnabled()
- isJavascriptEnabled()
- isPhpEnabled()
- isRemoteEnabled()
- set()
- setAdminPassword()
- setAdminUsername()
- setChroot()
- setDebugCss()
- setDebugKeepTemp()
- setDebugLayout()
- setDebugLayoutBlocks()
- setDebugLayoutInline()
- setDebugLayoutLines()
- setDebugLayoutPaddingBox()
- setDebugPng()
- setDefaultFont()
- setDefaultMediaType()
- setDefaultPaperOrientation()
- setDefaultPaperSize()
- setDpi()
- setFontCache()
- setFontDir()
- setFontHeightRatio()
- setIsFontSubsettingEnabled()
- setIsHtml5ParserEnabled()
- setIsJavascriptEnabled()
- setIsPhpEnabled()
- setIsRemoteEnabled()
- setLogOutputFile()
- setPdfBackend()
- setPdflibLicense()
- setRootDir()
- setTempDir()