2.0 beta

Author: Matthias Isler

README.md

@@ -35,7 +35,46 @@ php composer.phar require spiritix/html-to-pdf
 
 ## Usage
 
-TODO
+The usage of this library is very simple. 
+You just need a converter instance, pass an input and an output handler to it and set some options if you like.
+After running the conversion, the converter will provide you with the output handler instance.
+Now you may use it's specific functionality to get your PDF file.
+
+```php
+use Spiritix\HtmlToPdf\Converter;
+use Spiritix\HtmlToPdf\Input\UrlInput;
+use Spiritix\HtmlToPdf\Output\DownloadOutput;
+
+$input = new UrlInput();
+$input->setUrl('https://www.google.com');
+
+$converter = new Converter($input, new DownloadOutput());
+
+$converter->setOption('d', '300');
+$converter->setOptions([
+    'margin-bottom' => '100',
+    'margin-top' => '100',
+]);
+
+$output = $converter->convert();
+$output->download();
+```
+
+### Input handlers
+
+The following input handlers are available:
+
+- StringInput - Provide the PDF contents as a string
+- UrlInput - Fetch the PDF contents from an URL
+
+### Output handlers
+
+The following output handlers are available:
+
+- StringOutput - Get the PDF contents as a string
+- FileOutput - Store the PDF to your file system
+- DownloadOutput - Force the browser to download the PDF file
+- EmbedOutput - Force the browser to embed the PDF file
 
 ## Options
 

tests/Input/StringInputTest.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Spiritix\HtmlToPdf\Tests\Input;
+
+use Spiritix\HtmlToPdf\Input\StringInput;
+use Spiritix\HtmlToPdf\Tests\TestCase;
+
+class StringInputTest extends TestCase
+{
+    public function testSetHtml()
+    {
+        $html = '<h1>Hello</h1>';
+
+        $input = new StringInput();
+        $input->setHtml($html);
+
+        $this->assertEquals($html, $input->getHtml());
+    }
+}

tests/Input/UrlInputTest.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Spiritix\HtmlToPdf\Tests\Input;
+
+use Spiritix\HtmlToPdf\Input\UrlInput;
+use Spiritix\HtmlToPdf\Tests\TestCase;
+
+class UrlInputTest extends TestCase
+{
+    public function testSetUrl()
+    {
+        $input = new UrlInput();
+        $input->setUrl('https://www.google.com');
+
+        $this->assertContains('Google', $input->getHtml());
+    }
+}

tests/Output/DownloadOutputTest.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Spiritix\HtmlToPdf\Tests\Output;
+
+use Spiritix\HtmlToPdf\Output\DownloadOutput;
+use Spiritix\HtmlToPdf\Tests\TestCase;
+
+class DownloadOutputTest extends TestCase
+{
+    /**
+     * @runInSeparateProcess
+     */
+    public function testDownload()
+    {
+        $pdfData = $this->getPdfSampleData();
+
+        $output = new DownloadOutput();
+        $output->setPdfData($pdfData);
+
+        ob_start();
+        $output->download('sample.pdf', false);
+        $data = ob_get_clean();
+
+        $this->assertEquals($pdfData, $data);
+    }
+}

tests/Output/EmbedOutputTest.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Spiritix\HtmlToPdf\Tests\Output;
+
+use Spiritix\HtmlToPdf\Output\EmbedOutput;
+use Spiritix\HtmlToPdf\Tests\TestCase;
+
+class EmbedOutputTest extends TestCase
+{
+    /**
+     * @runInSeparateProcess
+     */
+    public function testEmbed()
+    {
+        $pdfData = $this->getPdfSampleData();
+
+        $output = new EmbedOutput();
+        $output->setPdfData($pdfData);
+
+        ob_start();
+        $output->embed('sample.pdf', false);
+        $data = ob_get_clean();
+
+        $this->assertEquals($pdfData, $data);
+    }
+}

tests/Output/FileOutputTest.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Spiritix\HtmlToPdf\Tests\Output;
+
+use Spiritix\HtmlToPdf\Output\FileOutput;
+use Spiritix\HtmlToPdf\Tests\TestCase;
+
+class FileOutputTest extends TestCase
+{
+    public function testStore()
+    {
+        $pdfData = $this->getPdfSampleData();
+
+        $output = new FileOutput();
+        $output->setPdfData($pdfData);
+
+        $url = '/tmp/sample.pdf';
+        $output->store($url);
+
+        $this->assertEquals(file_get_contents($url), $pdfData);
+    }
+}

tests/Output/StringOutputTest.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Spiritix\HtmlToPdf\Tests\Output;
+
+use Spiritix\HtmlToPdf\Output\StringOutput;
+use Spiritix\HtmlToPdf\Tests\TestCase;
+
+class StringOutputTest extends TestCase
+{
+    public function testGet()
+    {
+        $pdfData = $this->getPdfSampleData();
+
+        $output = new StringOutput();
+        $output->setPdfData($pdfData);
+
+        $this->assertEquals($pdfData, $output->get());
+    }
+}

tests/TestCase.php

@@ -6,5 +6,8 @@
 
 class TestCase extends PHPUnit_Framework_TestCase
 {
-    //
+    public function getPdfSampleData()
+    {
+        return file_get_contents(__DIR__ . '/pdf/Sample.pdf');
+    }
 }