<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Create a new PDF Object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.wkhtmltox-pdf-object.html">wkhtmltox\PDF\Object</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.wkhtmltox-image-converter.html">wkhtmltox\Image\Converter</a></div>
<div class="up"><a href="class.wkhtmltox-pdf-object.html">wkhtmltox\PDF\Object</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="wkhtmltox-pdf-object.construct" class="refentry">
<div class="refnamediv">
<h1 class="refname">wkhtmltox\PDF\Object::__construct</h1>
<p class="verinfo">(wkhtmltox >= 0.1.0)</p><p class="refpurpose"><span class="refname">wkhtmltox\PDF\Object::__construct</span> — <span class="dc-title">Create a new PDF Object</span></p>
</div>
<div class="refsect1 description" id="refsect1-wkhtmltox-pdf-object.construct-description">
<h3 class="title">Description</h3>
<div class="constructorsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><strong>wkhtmltox\PDF\Object::__construct</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$buffer</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$settings</code></span>
] )</div>
<p class="para rdfs-comment">
Creates a new PDF Object from the given buffer and optional configuration settings
</p>
</div>
<div class="refsect1 parameters" id="refsect1-wkhtmltox-pdf-object.construct-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">buffer</code></dt>
<dd>
<p class="para">
HTML
</p>
</dd>
<dt>
<code class="parameter">settings</code></dt>
<dd>
<p class="para">
<table class="doctable table">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Values</th>
<th>Changelog</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>page</td>
<td>URL or path of the HTML to convert</td>
<td class="empty"> </td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>useExternalLinks</td>
<td>set true to convert external links in the input into external PDF links in the output</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>useLocalLinks</td>
<td>set true to convert internal links in the input into internal PDF links in the output</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>produceForms</td>
<td>set true to turn HTML forms into PDF forms</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>replacements</td>
<td>undocumented</td>
<td class="empty"> </td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>includeInOutline</td>
<td>set true to include sections from this object in the outline and toc</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>pagesCount</td>
<td>set true to make page count in toc inclusive of the number of pages in this object</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>tocXsl</td>
<td>set to style sheet to convert this object into a toc object</td>
<td class="empty"> </td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>toc.useDottedLines</td>
<td>set true to use dotted lines in toc</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>toc.captionText</td>
<td>the caption text for toc</td>
<td class="empty"> </td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>toc.forwardLinks</td>
<td>set true to create links from toc to content</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>toc.backLinks</td>
<td>set true to create links from content to toc</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>toc.indentation</td>
<td>indentation for toc</td>
<td>2em</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>toc.fontScale</td>
<td>the factor to scale down the font at every toc level</td>
<td>0.8</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>header.fontSize</td>
<td>font size for use in header</td>
<td>13</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>header.fontName</td>
<td>name of font for use in header</td>
<td>times</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>header.left</td>
<td>text for left of header</td>
<td class="empty"> </td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>header.center</td>
<td>text for center of header</td>
<td class="empty"> </td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>header.right</td>
<td>text for right of header</td>
<td class="empty"> </td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>header.line</td>
<td>enable or disable horizontal rule under header</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>header.spacing</td>
<td>space between header and content</td>
<td>1.8</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>header.htmlUrl</td>
<td>URL or path of HTML to use in header</td>
<td class="empty"> </td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>footer.fontSize</td>
<td>font size for use in footer</td>
<td>13</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>footer.fontName</td>
<td>name of font for use in footer</td>
<td>times</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>footer.left</td>
<td>text for left of footer</td>
<td class="empty"> </td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>footer.center</td>
<td>text for center of footer</td>
<td class="empty"> </td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>footer.right</td>
<td>text for right of footer</td>
<td class="empty"> </td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>footer.line</td>
<td>enable or disable horizontal rule under footer</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>footer.spacing</td>
<td>space between footer and content</td>
<td>1.8</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>footer.htmlUrl</td>
<td>URL or path of HTML to use in footer</td>
<td class="empty"> </td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>load.username</td>
<td>user name to use when loging into a website</td>
<td>bart</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>load.password</td>
<td>the password to used when logging into a website</td>
<td>elbarto</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>load.jsdelay</td>
<td>the amount of time in milliseconds to wait after a page is loaded until it is captured</td>
<td>1200</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>load.zoomFactor</td>
<td>how much zoom should be applied to the content</td>
<td>2.2</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>load.customHeaders</td>
<td>custom headers to send when requesting the main web page</td>
<td class="empty"> </td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>load.repertCustomHeaders</td>
<td>set true to send with all requests</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>load.cookies</td>
<td>cookie string to send when requesting the main web page</td>
<td class="empty"> </td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>load.post</td>
<td>post string to send when requesting the main web page</td>
<td class="empty"> </td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>load.blockLocalFileAccess</td>
<td>disallow local and piped files to access other local files</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>load.stopSlowScript</td>
<td>stop slow running javascript</td>
<td>boolean</td>
<td class="empty"> </td>
</tr>
<tr>
<td>load.debugJavascript</td>
<td>allow javascript to raise warnings</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>load.loadErrorHandling</td>
<td>set error handling strategy</td>
<td>
<table class="doctable table">
<tbody class="tbody">
<tr>
<td>abort</td>
<td>abort the convertion process</td>
</tr>
<tr>
<td>skip</td>
<td>do not add the object to the final output</td>
</tr>
<tr>
<td>ignore</td>
<td>try to add the object to the final output</td>
</tr>
</tbody>
</table>
</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>load.proxy</td>
<td class="empty"> </td>
<td class="empty"> </td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>web.background</td>
<td>include background image in output</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>web.loadImages</td>
<td>include images in output</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>web.enableJavascript</td>
<td>enable or disable javascript</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>web.enableIntelligentShrinking</td>
<td>enable to attempt to fit more content on page, only applies to PDF output</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>web.minimumFontSize</td>
<td>the minimum font size allowed</td>
<td>9</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>web.printMediaType</td>
<td>print content using print media type instead of screen media type</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>web.defaultEncoding</td>
<td>content to use where no encoding is specified</td>
<td>utf-8</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>web.userStyleSheet</td>
<td>URL or path to a user specified style sheet</td>
<td>/path/to/style.css</td>
<td>>= 0.1.0</td>
</tr>
<tr>
<td>web.enablePlugins</td>
<td>enable or disable NS plugins</td>
<td>boolean</td>
<td>>= 0.1.0</td>
</tr>
</tbody>
</table>
</p>
</dd>
</dl>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.wkhtmltox-pdf-object.html">wkhtmltox\PDF\Object</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.wkhtmltox-image-converter.html">wkhtmltox\Image\Converter</a></div>
<div class="up"><a href="class.wkhtmltox-pdf-object.html">wkhtmltox\PDF\Object</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
