construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="wkhtmltox-image-converter.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>wkhtmltox\Image\Converter::__construct</refname>
  <refpurpose>Create a new Image converter</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <constructorsynopsis>
   <modifier>public</modifier> <methodname>wkhtmltox\Image\Converter::__construct</methodname>
   <methodparam choice="opt"><type>string</type><parameter>buffer</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>settings</parameter></methodparam>
  </constructorsynopsis>
  <para>
  Creates an Image converter, optionally taking an input buffer and configuration settings
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>buffer</parameter></term>
    <listitem>
     <para>
      HTML
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>settings</parameter></term>
    <listitem>
     <para>
      <table>
       <title></title>
       <tgroup cols="4">
        <thead>
         <row>
          <entry>Name</entry>
          <entry>Description</entry>
          <entry>Values</entry>
          <entry>Changelog</entry>
         </row>
        </thead>
        <tbody>
         <row>
          <entry>in</entry>
          <entry>URL or path of the input file, if "-" stdin is used</entry>
          <entry>/path/to/markup.html</entry>
          <entry>&gt;= 0.1.0</entry>
         </row>
         <row>
          <entry>out</entry>
          <entry>path of output file, if "-" stdout is used, by default an internal buffer is used</entry>
          <entry>/path/to/output.png</entry>
          <entry>&gt;= 0.1.0</entry>
         </row>
         <row>
          <entry>fmt</entry>
          <entry>output format to use</entry>
          <entry>
           <table>
            <title></title>
            <tgroup cols="2">
             <tbody>
              <row>
               <entry>""</entry>
               <entry>default</entry>
              </row>
              <row>
               <entry>jpg</entry>
               <entry>output as JPEG</entry>
              </row>
              <row>
               <entry>png</entry>
               <entry>output as PNG</entry>
              </row>
              <row>
               <entry>bmp</entry>
               <entry>output as bitmap</entry>
              </row>
              <row>
               <entry>svg</entry>
               <entry>output as SVG</entry>
              </row>
             </tbody>
            </tgroup>
           </table>
          </entry>
          <entry>&gt;= 0.1.0</entry>
         </row>
         <row>
          <entry>transparent</entry>
          <entry>when outputting a PNG or SVG, make the white background transparent</entry>
          <entry>boolean</entry>
          <entry>&gt;= 0.1.0</entry>
         </row>
         <row>
          <entry>screenWidth</entry>
          <entry>the with of the screen used to render in pixels</entry>
          <entry>800</entry>
          <entry>&gt;= 0.1.0</entry>
         </row>
         <row>
          <entry>smartWidth</entry>
          <entry>when true, screenWidth is expanded to the content width</entry>
          <entry>boolean</entry>
          <entry>&gt;= 0.1.0</entry>
         </row>
         <row>
          <entry>quality</entry>
          <entry>compression factor to use when outputting a JPEG image</entry>
          <entry>94</entry>
          <entry>&gt;= 0.1.0</entry>
         </row>
         <row>
          <entry>crop.left</entry>
          <entry>left/x coordinate of the window to capture in pixels</entry>
          <entry>200</entry>
          <entry>&gt;= 0.1.0</entry>
         </row>
         <row>
          <entry>crop.top</entry>
          <entry>top/y coordinate of the window to capture in pixels</entry>
          <entry>200</entry>
          <entry>&gt;= 0.1.0</entry>
         </row>
         <row>
          <entry>crop.width</entry>
          <entry>width of the window to capture in pixels</entry>
          <entry>200</entry>
          <entry>&gt;= 0.1.0</entry>
         </row>
         <row>
          <entry>crop.height</entry>
          <entry>height of the window to capture in pixels</entry>
          <entry>200</entry>
          <entry>&gt;= 0.1.0</entry>
         </row>
         <row>
           <entry>load.cookieJar</entry>
           <entry>path of file used to load and store cookies</entry>
           <entry>/tmp/cookies.txt</entry>
           <entry>&gt;= 0.1.0</entry>
         </row>
         &reference.wkhtmltox.wkhtmltox.bits.load;
         &reference.wkhtmltox.wkhtmltox.bits.web;
        </tbody>
       </tgroup>
      </table>
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <!-- Return values commented out, as constructors generally don't return a
      value. Uncomment this if you do need a return values section (for
      example, because there's also a procedural version of the method).
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   
  </para>
 </refsect1>
 -->



</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->