<!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 Image converter</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="class.wkhtmltox-image-converter.html">wkhtmltox\Image\Converter</a></div> <div class="next" style="text-align: right; float: right;"><a href="wkhtmltox-image-converter.convert.html">wkhtmltox\Image\Converter::convert</a></div> <div class="up"><a href="class.wkhtmltox-image-converter.html">wkhtmltox\Image\Converter</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="wkhtmltox-image-converter.construct" class="refentry"> <div class="refnamediv"> <h1 class="refname">wkhtmltox\Image\Converter::__construct</h1> <p class="verinfo">(wkhtmltox >= 0.1.0)</p><p class="refpurpose"><span class="refname">wkhtmltox\Image\Converter::__construct</span> — <span class="dc-title">Create a new Image converter</span></p> </div> <div class="refsect1 description" id="refsect1-wkhtmltox-image-converter.construct-description"> <h3 class="title">Description</h3> <div class="constructorsynopsis dc-description"> <span class="modifier">public</span> <span class="methodname"><strong>wkhtmltox\Image\Converter::__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 an Image converter, optionally taking an input buffer and configuration settings </p> </div> <div class="refsect1 parameters" id="refsect1-wkhtmltox-image-converter.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>in</td> <td>URL or path of the input file, if "-" stdin is used</td> <td>/path/to/markup.html</td> <td>>= 0.1.0</td> </tr> <tr> <td>out</td> <td>path of output file, if "-" stdout is used, by default an internal buffer is used</td> <td>/path/to/output.png</td> <td>>= 0.1.0</td> </tr> <tr> <td>fmt</td> <td>output format to use</td> <td> <table class="doctable table"> <tbody class="tbody"> <tr> <td>""</td> <td>default</td> </tr> <tr> <td>jpg</td> <td>output as JPEG</td> </tr> <tr> <td>png</td> <td>output as PNG</td> </tr> <tr> <td>bmp</td> <td>output as bitmap</td> </tr> <tr> <td>svg</td> <td>output as SVG</td> </tr> </tbody> </table> </td> <td>>= 0.1.0</td> </tr> <tr> <td>transparent</td> <td>when outputting a PNG or SVG, make the white background transparent</td> <td>boolean</td> <td>>= 0.1.0</td> </tr> <tr> <td>screenWidth</td> <td>the with of the screen used to render in pixels</td> <td>800</td> <td>>= 0.1.0</td> </tr> <tr> <td>smartWidth</td> <td>when true, screenWidth is expanded to the content width</td> <td>boolean</td> <td>>= 0.1.0</td> </tr> <tr> <td>quality</td> <td>compression factor to use when outputting a JPEG image</td> <td>94</td> <td>>= 0.1.0</td> </tr> <tr> <td>crop.left</td> <td>left/x coordinate of the window to capture in pixels</td> <td>200</td> <td>>= 0.1.0</td> </tr> <tr> <td>crop.top</td> <td>top/y coordinate of the window to capture in pixels</td> <td>200</td> <td>>= 0.1.0</td> </tr> <tr> <td>crop.width</td> <td>width of the window to capture in pixels</td> <td>200</td> <td>>= 0.1.0</td> </tr> <tr> <td>crop.height</td> <td>height of the window to capture in pixels</td> <td>200</td> <td>>= 0.1.0</td> </tr> <tr> <td>load.cookieJar</td> <td>path of file used to load and store cookies</td> <td>/tmp/cookies.txt</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-image-converter.html">wkhtmltox\Image\Converter</a></div> <div class="next" style="text-align: right; float: right;"><a href="wkhtmltox-image-converter.convert.html">wkhtmltox\Image\Converter::convert</a></div> <div class="up"><a href="class.wkhtmltox-image-converter.html">wkhtmltox\Image\Converter</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>