Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The code snippet example will allow you to create a PDF file from HTML code that you pass to the PDF service. You will then be returned either a download link, or optionally the PDF file contents in the API response.

Code Snippet Example:


Code Block
languagephp
themeRDark
titleBuild PDF
//Import the pdf service classes
$t->runInteraction("Pdf.class.php");
$t->runInteraction("Config.class.php");

//Set header, footer, and page content HTML Code
//HTML5 and CSS3 is supported
$header_html = "{_BLINK_PAGE_NO_}/{_BLINK_PAGES_}<br><hr>";
$footer_html = "<hr><br>{_BLINK_PAGE_NO_}/{_BLINK_PAGES_}";
$body = "<table><td>PDF Example: " . date("c") . "</td></tr></table>";

$content = array(
   "page" => array(
       "orientation" => "Portrait",
       "size" => "A4",
       "margins" => array(
           "top" => "5mm",
           "right" => "1cm",
           "bottom" => "5mm",
           "left" => "1cm"
       )
   ),
   "header" => array(
       "height" => "2cm",
       "html" => $header_html
   ),
   "footer" => array(
       "height" => "2cm",
       "html" => $footer_html
   ),
   "body" => array(
       "html" => $body
   )
);


//Call the PDF Service
$pdf = new PDFBuilder(Config::$PDF);

//Setting $includeBase64Content to true will include the PDF file content in the response object
//Set to false to access the PDF file from a time limited URL instead
$includeBase64Content = true;
$result = $pdf->build($content, $includeBase64Content);


 

Explanation:

The first two "runInteraction" lines will simply "include" the class files you already uploaded. Make sure your have used the correct interaction names. You will need to put both of these lines on any page, or interaction, that you will be calling the class.

$header_html (string)

The header will be displayed at the top of each page of your PDF document. You can use HTML code and styles to display your header.

...

The content array contains the parameters required to produce a PDF document, including layout options and content.

 

Code Block
languagejs
themeRDark
titleDefault Page Parametres
 "page": {
    "orientation": "P",
    "size": "A4",
    "margins": {
      "top": "5mm",
      "right": "1cm",
      "bottom": "5mm",
      "left": "1cm"
    }

...

After running this method, you will receive a response object array:

Code Block
languagephp
themeRDark
titleResult Array
$result = array(
   "id" => "<UNIQUE OBJECT ID>",
   "url" => "http://url.to.pdf/valid.for.3.minutes",
   "content" => "base64 pdf content"
}

...