Overview

Namespaces

  • None
  • PHP
  • WkHtmlToPdf
    • Options

Classes

  • WkHtmlToPdf
  • Overview
  • Namespace
  • Class
  • Tree

Class WkHtmlToPdf

Description of Wkp2p.

WkHtmlToPdf\WkHtmlToPdf uses WkHtmlToPdf\Options\GlobalOptionsTrait, WkHtmlToPdf\Options\OutlineOptionsTrait, WkHtmlToPdf\Options\PageOptionsTrait, WkHtmlToPdf\Options\HeaderFooterOptionsTrait, WkHtmlToPdf\Options\TocOptionsTrait
Namespace: WkHtmlToPdf
Author: ivanpepelko
Located at WkHtmlToPdf/WkHtmlToPdf.php
Methods summary
public
# __construct( string $wkhtml2pdf, string $tmpDir = '/tmp', boolean $debug = false )

Parameters

$wkhtml2pdf
Path to wkhtmltopdf binary
$tmpDir
Path to tmp dir
$debug

Throws

Exception
public WkHtmlToPdf\WkHtmlToPdf
# setInputPath( string $path )

Set input file path.

Set input file path.

Parameters

$path

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setInputHtml( string $html )

Set input html.

Set input html.

Parameters

$html

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setOutputPath( string $path )

Set output file path.

Set output file path.

Parameters

$path

Returns

WkHtmlToPdf\WkHtmlToPdf
public string
# getOutput( )

Get pdf as string.

Get pdf as string.

Returns

string
public WkHtmlToPdf\WkHtmlToPdf
# useRecommendedOptions( )

PnP method to get you going ASAP. Sets margins to 6.3mm, viewport size to 800x1280, enables low quality and enables media-print if available.

PnP method to get you going ASAP. Sets margins to 6.3mm, viewport size to 800x1280, enables low quality and enables media-print if available.

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# convert( )

Do conversion.

Do conversion.

Returns

WkHtmlToPdf\WkHtmlToPdf

Throws

Exception
public WkHtmlToPdf\WkHtmlToPdf
# enablePrefetch( )

Prefetch html and feed local file to wkhtmltopdf.

Prefetch html and feed local file to wkhtmltopdf.

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# disablePrefetch( )

Disable html prefetching.

Disable html prefetching.

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setArg( string $arg, mixed $val = null )

Set argument (works only when constructor param $debug == true). All pdf generation related args have their dedicated method.

Set argument (works only when constructor param $debug == true). All pdf generation related args have their dedicated method.

Parameters

$arg
$val

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# unsetArg( string $arg )

Unset argument (works only when constructor param $debug == true). All pdf generation related args have their dedicated method.

Unset argument (works only when constructor param $debug == true). All pdf generation related args have their dedicated method.

Parameters

$arg

Returns

WkHtmlToPdf\WkHtmlToPdf
Methods used from WkHtmlToPdf\Options\GlobalOptionsTrait
disableCollate(), disableGrayscale(), disableLowQuality(), disablePdfCompression(), disableXserver(), enableCollate(), enableGrayscale(), enableLowQuality(), enablePdfCompression(), enableXserver(), setCookieJar(), setCopies(), setDocumentTitle(), setDpi(), setImageDpi(), setImageQuality(), setMarginBottom(), setMarginLeft(), setMarginRight(), setMarginTop(), setMargins(), setMarginsAll(), setOrientation(), setPageHeight(), setPageSize(), setPageWidth(), setTitle()
Methods used from WkHtmlToPdf\Options\OutlineOptionsTrait
disableOutline(), enableOutline(), setDumpOutline(), setOutline()
Methods used from WkHtmlToPdf\Options\PageOptionsTrait
addAllowedPath(), addAllowedPaths(), addCookie(), addCookies(), addCustomHttpHeader(), addCustomHttpHeaders(), addDefaultHeader(), addHttpPostField(), addHttpPostFields(), addHttpPostFile(), addHttpPostFiles(), addScript(), addScripts(), disableBackground(), disableCustomHttpHeaderPropagination(), disableExternalLinks(), disableForms(), disableImages(), disableInternalLinks(), disableJavascript(), disableJavascriptDebugging(), disableLocalFileAccess(), disablePlugins(), disablePrintMediaType(), disableSlowScripts(), disableSmartShrinking(), disableTocBackLinks(), enableBackground(), enableCustomHttpHeaderPropagination(), enableExternalLinks(), enableForms(), enableImages(), enableInternalLinks(), enableJavascript(), enableJavascriptDebugging(), enableLocalFileAccess(), enablePlugins(), enablePrintMediaType(), enableSlowScripts(), enableSmartShrinking(), enableTocBackLinks(), excludeFromOutline(), includeInOutline(), keepRelativeLinks(), resolveRelativeLinks(), setBypassProxy(), setCacheDir(), setCheckboxCheckedSvg(), setCheckboxUncheckedSvg(), setEncoding(), setHttpAuthPassword(), setHttpAuthUsername(), setJavascriptDelay(), setLoadErrorHandling(), setLoadMediaErrorHandling(), setMinimumFontSize(), setPageOffset(), setProxy(), setRadiobuttonCheckedSvg(), setRadiobuttonUncheckedSvg(), setUserStyleSheet(), setViewportSize(), setZoom(), waitWindowStatus()
Methods used from WkHtmlToPdf\Options\HeaderFooterOptionsTrait
addHeaderFooterVar(), addHeaderFooterVars(), disableFooterLine(), disableHeaderLine(), enableFooterLine(), enableHeaderLine(), setFooterCenterText(), setFooterFontName(), setFooterFontSize(), setFooterHtml(), setFooterHtmlPath(), setFooterLeftText(), setFooterRightText(), setFooterSpacing(), setHeaderCenterText(), setHeaderFontName(), setHeaderFontSize(), setHeaderHtml(), setHeaderHtmlPath(), setHeaderLeftText(), setHeaderRightText(), setHeaderSpacing()
Methods used from WkHtmlToPdf\Options\TocOptionsTrait
disableTocDottedLines(), disableTocLinks(), enableTocDottedLines(), enableTocLinks(), setTocHeaderText(), setTocLevelIndentation(), setTocTextSizeShrinking(), setTocXslStyleSheet()
wkp2p API documentation generated by ApiGen