majkel89/tcpdf-warper

TCPDF Warper
============

[![Build Status](https://travis-ci.org/majkel89/tcpdf-warper.svg?branch=master)](https://travis-ci.org/majkel89/tcpdf-warper)
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/151eec45-478b-41e4-aa58-0c2d86d4f36a/mini.png)](https://insight.sensiolabs.com/projects/151eec45-478b-41e4-aa58-0c2d86d4f36a)
[![Code Climate](https://codeclimate.com/github/majkel89/tcpdf-warper/badges/gpa.svg)](https://codeclimate.com/github/majkel89/tcpdf-warper)
[![Test Coverage](https://codeclimate.com/github/majkel89/tcpdf-warper/badges/coverage.svg)](https://codeclimate.com/github/majkel89/tcpdf-warper/coverage)
[![Latest Stable Version](https://poser.pugx.org/majkel.org/tcpdf-warper/v/stable)](https://packagist.org/packages/majkel.org/tcpdf-warper)
[![Latest Unstable Version](https://poser.pugx.org/majkel.org/tcpdf-warper/v/unstable)](https://packagist.org/packages/majkel.org/tcpdf-warper)
![PHP Version](https://img.shields.io/badge/version-PHP%205.4%2B-lightgrey.svg)
[![License](https://poser.pugx.org/majkel.org/tcpdf-warper/license)](https://packagist.org/packages/majkel.org/tcpdf-warper)

Installation
------------

     composer require tecnick.com/tcpdf       ### or any TCPDF library
     composer require org.majkel/tcpdfwarper

About
-----

Provides fluent statement builders for TCPDF library.

Mine intention was to make calls to methods, with many arguments,
clearer and more maintainable.

    // instead of
    $pdf = new \TCPDF();
    $pdf->Image($file, $x, $y, $w, $h, '', '', '', true, 300, '',
             true, false, 10, true, false, false, true, $altimgs);

    // you can use this
    $pdf = new \org\majkel\tcpdfwarper\TCPDFWarper();
    $pdf->buildImage()->setFile($file)
        ->setPos(20, 20)->setSize(64, 64)
        ->setAlt(true)->setAltImgs($altimgs)
        ->render();

No more hassle with remembering which argument is which or hardcodeing long list of
parameters just to change last one of them.

Following methods are supported

  * Cell (buildCell)
  * Multicell (buildMulticell)
  * Image (buildImage)
  * ImageSvg (buildImageSvg)
  * ImageEps (buildImageEps)
  * Text (buildText)
  * writeHTML (buildHtml)
  * writeHTMLCell (buildHtmlCell)
  * write1DBarcode (buildBarcode1d)
  * write2DBarcode (buildBarcode2d)
  * Write (buildWrite)

If you are using some kind of fork of TCPDF, you can write your own warper.
Every statement builder allows you to inject $tcpdf object.

     $image = new \org\majkel\tcpdfwarper\ImageOp($tcpdf);
     $image->setFile($file)
         ->setPos(20, 20)->setSize(64, 64)
         ->render();

Features
========

  - Fully unit tested
  - Full code coverage
  - Code completion friendly (including documentation)
  - Tested against multiple php versions (5.4 - 7.0, hhvm)
  - Tested against multiple TCPDF libraries (see travis)

License
=======

The MIT License (MIT)

Copyright (c) 2015 Michał (majkel) Kowalik

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/majkel89/tcpdf-warper/trend.png)](https://bitdeli.com/free "Bitdeli Badge")