Overview

Namespaces

  • Alpha
    • Controller
      • Front
    • Exception
    • Model
      • Type
    • Task
    • Util
      • Backup
      • Cache
      • Code
        • Highlight
        • Metric
      • Config
      • Convertor
      • Email
      • Extension
      • Feed
      • File
      • Graph
      • Helper
      • Http
        • Filter
        • Session
      • Image
      • Logging
      • Search
      • Security
    • View
      • Renderer
        • Html
        • Json
      • Widget

Classes

  • Markdown
  • MarkdownFacade
  • TCPDF
  • TCPDFFacade
  • Overview
  • Namespace
  • Class
  • Tree

Class TCPDF

Custom version of the TCPDF library class, allowing for any required overrides.

TCPDF
Extended by Alpha\Util\Extension\TCPDF
Namespace: Alpha\Util\Extension
Copyright: Copyright (c) 2015, John Collins (founder of Alpha Framework). All rights reserved. <pre> Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the Alpha Framework nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. </pre>
License: The BSD License
Author: John Collins <dev@alphaframework.org>
Since: 1.0
Located at Util/Extension/TCPDF.php
Methods summary
public
# Image( string $file, float $x = '', float $y = '', float $w = 0, float $h = 0, string $type = '', mixed $link = '', string $align = '', boolean $resize = false, integer $dpi = 300, string $palign = '', boolean $ismask = false, mixed $imgmask = false, mixed $border = 0 )

Overrides the TCPDF::Image method to decrypt encrypted $file paths from the Image widget, then pass them to the normal TCPDF::Image along with all of the other (unmodified) parameters.

Overrides the TCPDF::Image method to decrypt encrypted $file paths from the Image widget, then pass them to the normal TCPDF::Image along with all of the other (unmodified) parameters.

Parameters

$file
string $file Name of the file containing the image.
$x
float $x Abscissa of the upper-left corner.
$y
float $y Ordinate of the upper-left corner.
$w
float $w Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
$h
float $h Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
$type
string $type Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.
$link
mixed $link URL or identifier returned by AddLink().
$align
string $align Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:
  • T: top-right for LTR or top-left for RTL
  • M: middle-right for LTR or middle-left for RTL
  • B: bottom-right for LTR or bottom-left for RTL
  • N: next line
$resize
bool $resize If true resize (reduce) the image to fit $w and $h (requires GD library).
$dpi
int $dpi dot-per-inch resolution used on resize
$palign
string $palign Allows to center or align the image on the current line. Possible values are:
  • L : left align
  • C : center
  • R : right align
  • '' : empty string : left for LTR or right for RTL
$ismask
bool $ismask true if this image is a mask, false otherwise
$imgmask
mixed $imgmask image object returned by this function or false
$border
mixed $border Indicates if borders must be drawn around the image. The value can be either a number:
  • 0: no border (default)
  • 1: frame
or a string containing some or all of the following characters (in any order):
  • L: left
  • T: top
  • R: right
  • B: bottom

Since

1.0
Alpha Framework 2.0.4 API Documentation API documentation generated by ApiGen 2.8.0