/** * Add meta information to the PDF after rendering. * * @param string $label Label of the value (Creator, Producer, etc.) * @param string $value The text to set */ public function addInfo(string $label, string $value): void { $this->canvas->add_info($label, $value); } /** * Streams the PDF to the client. * * The file will open a download dialog by default. The options * parameter controls the output. Accepted options (array keys) are: * * 'compress' = > 1 (=default) or 0: * Apply content stream compression * * 'Attachment' => 1 (=default) or 0: * Set the 'Content-Disposition:' HTTP header to 'attachment' * (thereby causing the browser to open a download dialog) * * @param string $filename the name of the streamed file * @param array $options header options (see above) */ public function stream($filename = "document.pdf", $options = []) { $this->setPhpConfig(); $this->canvas->stream($filename, $options); $this->restorePhpConfig(); } /** * Returns the PDF as a string. * * The options parameter controls the output. Accepted options are: * * 'compress' = > 1 or 0 - apply content stream compression, this is * on (1) by default * * @param array $options options (see above) * * @return string|null */ public function output($options = []) { $this->setPhpConfig(); $output = $this->canvas->output($options); $this->restorePhpConfig(); return $output; } /** * @return string * @deprecated */ public function output_html() { return $this->outputHtml(); } /** * Returns the underlying HTML document as a string * * @return string */ public function outputHtml() { return $this->dom->saveHTML(); } /** * Get the dompdf option value * * @param string $key * @return mixed * @deprecated */ public function get_option($key) { return $this->options->get($key); } /** * @param string $key * @param mixed $value * @return $this * @deprecated */ public function set_option($key, $value) { $this->options->set($key, $value); return $this; } /** * @param array $options * @return $this * @deprecated */ public function set_options(array $options) { $this->options->set($options); return $this; } /** * @param string $size * @param string $orientation * @deprecated */ public function set_paper($size, $orientation = "portrait") { $this->setPaper($size, $orientation); } /** * Sets the paper size & orientation * * @param string|float[] $size 'letter', 'legal', 'A4', etc. {@link Dompdf\Adapter\CPDF::$PAPER_SIZES} * @param string $orientation 'portrait' or 'landscape' * @return $this */ public function setPaper($size, string $orientation = "portrait"): self { $this->paperSize = $size; $this->paperOrientation = $orientation; return $this; } /** * Gets the paper size * * @return float[] A four-element float array */ public function getPaperSize(): array { $paper = $this->paperSize; $orientation = $this->paperOrientation; if (is_array($paper)) { $size = array_map("floatval", $paper); } else { $paper = strtolower($paper); $size = CPDF::$PAPER_SIZES[$paper] ?? CPDF::$PAPER_SIZES["letter"]; } if (strtolower($orientation) === "landscape") { [$size[2], $size[3]] = [$size[3], $size[2]]; } return $size; } /** * Gets the paper orientation * * @return string Either "portrait" or "landscape" */ public function getPaperOrientation(): string { return $this->paperOrientation; } /** * @param FrameTree $tree * @return $this */ public function setTree(FrameTree $tree) { $this->tree = $tree; return $this; } /** * @return FrameTree * @deprecated */ public function get_tree() { return $this->getTree(); } /** * Returns the underlying {@link FrameTree} object * * @return FrameTree */ public function getTree() { return $this->tree; } /** * @param string $protocol * @return $this * @deprecated */ public function set_protocol($protocol) { return $this->setProtocol($protocol); } /** * Sets the protocol to use * FIXME validate these * * @param string $protocol * @return $this */ public function setProtocol(string $protocol) { $this->protocol = $protocol; return $this; } /** * @return string * @deprecated */ public function get_protocol() { return $this->getProtocol(); } /** * Returns the protocol in use * * @return string */ public function getProtocol() { return $this->protocol; } /** * @param string $host * @deprecated */ public function set_host($host) { $this->setBaseHost($host); } /** * Sets the base hostname * * @param string $baseHost * @return $this */ public function setBaseHost(string $baseHost) { $this->baseHost = $baseHost; return $this; } /** * @return string * @deprecated */ public function get_host() { return $this->getBaseHost(); } /** * Returns the base hostname * * @return string */ public function getBaseHost() { return $this->baseHost; } /** * Sets the base path * * @param string $path * @deprecated */ public function set_base_path($path) { $this->setBasePath($path); } /** * Sets the base path * * @param string $basePath * @return $this */ public function setBasePath(string $basePath) { $this->basePath = $basePath; return $this; } /** * @return string * @deprecated */ public function get_base_path() { return $this->getBasePath(); } /** * Returns the base path * * @return string */ public function getBasePath() { return $this->basePath; } /** * @param string $default_view The default document view * @param array $options The view's options * @return $this * @deprecated */ public function set_default_view($default_view, $options) { return $this->setDefaultView($default_view, $options); } /** * Sets the default view * * @param string $defaultView The default document view * @param array $options The view's options * @return $this */ public function setDefaultView($defaultView, $options) { $this->defaultView = $defaultView; $this->defaultViewOptions = $options; return $this; } /** * @param resource $http_context * @return $this * @deprecated */ public function set_http_context($http_context) { return $this->setHttpContext($http_context); } /** * Sets the HTTP context * * @param resource|array $httpContext * @return $this */ public function setHttpContext($httpContext) { $this->options->setHttpContext($httpContext); return $this; } /** * @return resource * @deprecated */ public function get_http_context() { return $this->getHttpContext(); } /** * Returns the HTTP context * * @return resource */ public function getHttpContext() { return $this->options->getHttpContext(); } /** * Set a custom `Canvas` instance to render the document to. * * Be aware that the instance will be replaced on render if the document * defines a paper size different from the canvas. * * @param Canvas $canvas * @return $this */ public function setCanvas(Canvas $canvas) { $this->canvas = $canvas; return $this; } /** * @return Canvas * @deprecated */ public function get_canvas() { return $this->getCanvas(); } /** * Return the underlying Canvas instance (e.g. Dompdf\Adapter\CPDF, Dompdf\Adapter\GD) * * @return Canvas */ public function getCanvas() { return $this->canvas; } /** * @param Stylesheet $css * @return $this */ public function setCss(Stylesheet $css) { $this->css = $css; return $this; } /** * @return Stylesheet * @deprecated */ public function get_css() { return $this->getCss(); } /** * Returns the stylesheet * * @return Stylesheet */ public function getCss() { return $this->css; } /** * @param DOMDocument $dom * @return $this */ public function setDom(DOMDocument $dom) { $this->dom = $dom; return $this; } /** * @return DOMDocument * @deprecated */ public function get_dom() { return $this->getDom(); } /** * @return DOMDocument */ public function getDom() { return $this->dom; } /** * @param Options $options * @return $this */ public function setOptions(Options $options) { // For backwards compatibility if ($this->options && $this->options->getHttpContext() && !$options->getHttpContext()) { $options->setHttpContext($this->options->getHttpContext()); } $this->options = $options; $fontMetrics = $this->fontMetrics; if (isset($fontMetrics)) { $fontMetrics->setOptions($options); } return $this; } /** * @return Options */ public function getOptions() { return $this->options; } /** * @return array * @deprecated */ public function get_callbacks() { return $this->getCallbacks(); } /** * Returns the callbacks array * * @return array */ public function getCallbacks() { return $this->callbacks; } /** * @param array $callbacks the set of callbacks to set * @return $this * @deprecated */ public function set_callbacks($callbacks) { return $this->setCallbacks($callbacks); } /** * Define callbacks that allow modifying the document during render. * * The callbacks array should contain arrays with `event` set to a callback * event name and `f` set to a function or any other callable. * * The available callback events are: * * `begin_page_reflow`: called before page reflow * * `begin_frame`: called before a frame is rendered * * `end_frame`: called after frame rendering is complete * * `begin_page_render`: called before a page is rendered * * `end_page_render`: called after page rendering is complete * * `end_document`: called for every page after rendering is complete * * The function `f` receives three arguments `Frame $frame`, `Canvas $canvas`, * and `FontMetrics $fontMetrics` for all events but `end_document`. For * `end_document`, the function receives four arguments `int $pageNumber`, * `int $pageCount`, `Canvas $canvas`, and `FontMetrics $fontMetrics` instead. * * @param array $callbacks The set of callbacks to set. * @return $this */ public function setCallbacks(array $callbacks): self { $this->callbacks = []; foreach ($callbacks as $c) { if (is_array($c) && isset($c["event"]) && isset($c["f"])) { $event = $c["event"]; $f = $c["f"]; if (is_string($event) && is_callable($f)) { $this->callbacks[$event][] = $f; } } } return $this; } /** * @return boolean * @deprecated */ public function get_quirksmode() { return $this->getQuirksmode(); } /** * Get the quirks mode * * @return boolean true if quirks mode is active */ public function getQuirksmode() { return $this->quirksmode; } /** * @param FontMetrics $fontMetrics * @return $this */ public function setFontMetrics(FontMetrics $fontMetrics) { $this->fontMetrics = $fontMetrics; return $this; } /** * @return FontMetrics */ public function getFontMetrics() { return $this->fontMetrics; } /** * PHP5 overloaded getter * Along with {@link Dompdf::__set()} __get() provides access to all * properties directly. Typically __get() is not called directly outside * of this class. * * @param string $prop * * @throws Exception * @return mixed */ function __get($prop) { switch ($prop) { case 'version': return $this->version; default: throw new Exception('Invalid property: ' . $prop); } } }