Documentation

API Documentation

Table of Contents

Namespaces

ext
intranet

Classes

Datamatrix
PDF417
QRcode
TCPDF_COLORS
TCPDF_FILTERS
TCPDF_FONT_DATA
TCPDF_FONTS
TCPDF_IMAGES
TCPDF_STATIC
TCPDF
TCPDFBarcode
TCPDF2DBarcode
TCPDF_IMPORT
TCPDF_PARSER

Constants

DATAMATRIXDEFS  = \true
Indicate that definitions for this class are set
ENC_ASCII  = 0
ASCII encoding: ASCII character 0 to 127 (1 byte per CW)
ENC_ASCII_EXT  = 6
ASCII extended encoding: ASCII character 128 to 255 (1/2 byte per CW)
ENC_ASCII_NUM  = 7
ASCII number encoding: ASCII digits (2 bytes per CW)
ENC_BASE256  = 5
BASE 256 encoding: ASCII character 0 to 255 (1 byte per CW)
ENC_C40  = 1
C40 encoding: Upper-case alphanumeric (3/2 bytes per CW)
ENC_EDF  = 4
EDIFACT encoding: ASCII character 32 to 94 (4/3 bytes per CW)
ENC_TXT  = 2
TEXT encoding: Lower-case alphanumeric (3/2 bytes per CW)
ENC_X12  = 3
X12 encoding: ANSI X12 (3/2 byte per CW)
HEAD_MAGNIFICATION  = 1.1
Magnification factor for titles.
HEAD_MAGNIFICATION  = 1.1
K_ALLOWED_TCPDF_TAGS  = ''
List of TCPDF methods that are allowed to be called using HTML syntax.
K_ALLOWED_TCPDF_TAGS  = ''
K_BLANK_IMAGE  = '_blank.png'
Generic name for a blank image.
K_BLANK_IMAGE  = '_blank.png'
K_CELL_HEIGHT_RATIO  = 1.25
Height of cell respect font height.
K_CELL_HEIGHT_RATIO  = 1.25
K_PATH_CACHE  = $K_PATH_CACHE
K_PATH_FONTS  = $fdir
K_PATH_FONTS  = \K_PATH_MAIN . 'fonts/'
K_PATH_MAIN  = \dirname(__FILE__) . '/'
K_PATH_URL  = $k_path_url
K_SMALL_RATIO  = 2 / 3
Reduction factor for small font.
K_SMALL_RATIO  = 2 / 3
K_TCPDF_CALLS_IN_HTML  = \false
If true allows to call TCPDF methods using HTML syntax IMPORTANT: For security reason, disable this feature if you are printing user HTML content.
K_TCPDF_CALLS_IN_HTML  = \false
K_TCPDF_THROW_EXCEPTION_ERROR  = \false
If true and PHP version is greater than 5, then the Error() method throw new exception instead of terminating the execution.
K_TCPDF_THROW_EXCEPTION_ERROR  = \false
K_THAI_TOPCHARS  = \true
Set to true to enable the special procedure used to avoid the overlappind of symbols on Thai language.
K_THAI_TOPCHARS  = \true
K_TIMEZONE  = 'UTC'
Default timezone for datetime functions
K_TIMEZONE  = @\date_default_timezone_get()
K_TITLE_MAGNIFICATION  = 1.3
Title magnification respect main font size.
K_TITLE_MAGNIFICATION  = 1.3
MATRIX_CLIENT_URL  = "/_matrix/client/r0"
MATRIX_MEDIA_DOWNLOAD_URL  = '/_matrix/media/r0/download'
MATRIX_MEDIA_UPLOAD_URL  = '/_matrix/media/r0/upload'
MATRIX_REGISTER_URL  = "/_matrix/client/r0/admin/register"
MAX_STRUCTURED_SYMBOLS  = 16
Max number of symbols for structured mode
N1  = 3
Down point base value for case 1 mask pattern (concatenation of same color in a line or a column)
N2  = 3
Down point base value for case 2 mask pattern (module block of same color)
N3  = 40
Down point base value for case 3 mask pattern (1:1:3:1:1(dark:bright:dark:bright:dark)pattern in a line or a column)
N4  = 10
Down point base value for case 4 mask pattern (ration of dark modules in whole)
path  = \dirname(__DIR__)
path  = \dirname(__DIR__)
path  = \dirname(__DIR__) . '/..'
path  = \dirname(__DIR__)
path  = \dirname(__DIR__)
path  = \dirname(__DIR__)
path  = \dirname(__DIR__)
path  = \dirname(__DIR__)
path  = \dirname(__DIR__)
PDF417DEFS  = \true
Indicate that definitions for this class are set
PDF_AUTHOR  = 'Ticketsystem der Bitstore Gruppe'
Document author.
PDF_AUTHOR  = 'TCPDF'
PDF_CREATOR  = 'Ticketsystem der Bitstore Gruppe'
Document creator.
PDF_CREATOR  = 'TCPDF'
PDF_FONT_MONOSPACED  = 'courier'
Default monospaced font name.
PDF_FONT_MONOSPACED  = 'courier'
PDF_FONT_NAME_DATA  = 'helvetica'
Default data font name.
PDF_FONT_NAME_DATA  = 'helvetica'
PDF_FONT_NAME_MAIN  = 'helvetica'
Default main font name.
PDF_FONT_NAME_MAIN  = 'helvetica'
PDF_FONT_SIZE_DATA  = 8
Default data font size.
PDF_FONT_SIZE_DATA  = 8
PDF_FONT_SIZE_MAIN  = 10
Default main font size.
PDF_FONT_SIZE_MAIN  = 10
PDF_HEADER_LOGO  = $tcpdf_header_logo
PDF_HEADER_LOGO_WIDTH  = 0
PDF_HEADER_STRING  = "Bericht aus dem Ticketsystem der Bitstore Gruppe"
Header description string.
PDF_HEADER_STRING  = "by Nicola Asuni - Tecnick.com\nwww.tcpdf.org"
PDF_HEADER_TITLE  = 'Bericht'
Header title.
PDF_HEADER_TITLE  = 'TCPDF Example'
PDF_IMAGE_SCALE_RATIO  = 1.25
Ratio used to adjust the conversion of pixels to user units.
PDF_IMAGE_SCALE_RATIO  = 1.25
PDF_MARGIN_BOTTOM  = 25
Bottom margin.
PDF_MARGIN_BOTTOM  = 25
PDF_MARGIN_FOOTER  = 10
Footer margin.
PDF_MARGIN_FOOTER  = 10
PDF_MARGIN_HEADER  = 5
Header margin.
PDF_MARGIN_HEADER  = 5
PDF_MARGIN_LEFT  = 15
Left margin.
PDF_MARGIN_LEFT  = 15
PDF_MARGIN_RIGHT  = 15
Right margin.
PDF_MARGIN_RIGHT  = 15
PDF_MARGIN_TOP  = 27
Top margin.
PDF_MARGIN_TOP  = 27
PDF_PAGE_FORMAT  = 'A4'
Page format.
PDF_PAGE_FORMAT  = 'A4'
PDF_PAGE_ORIENTATION  = 'P'
Page orientation (P=portrait, L=landscape).
PDF_PAGE_ORIENTATION  = 'P'
PDF_UNIT  = 'mm'
Document unit of measure [pt=point, mm=millimeter, cm=centimeter, in=inch].
PDF_UNIT  = 'mm'
QR_DEFAULT_MASK  = 2
when QR_FIND_BEST_MASK === false
QR_ECLEVEL_H  = 3
Error correction level H : About 30% or less errors can be corrected.
QR_ECLEVEL_L  = 0
Error correction level L : About 7% or less errors can be corrected.
QR_ECLEVEL_M  = 1
Error correction level M : About 15% or less errors can be corrected.
QR_ECLEVEL_Q  = 2
Error correction level Q : About 25% or less errors can be corrected.
QR_FIND_BEST_MASK  = \true
if true, estimates best mask (spec. default, but extremally slow; set to false to significant performance boost but (propably) worst quality code
QR_FIND_FROM_RANDOM  = 2
if false, checks all masks available, otherwise value tells count of masks need to be checked, mask id are got randomly
QR_MODE_8B  = 2
Encoding mode 8bit byte data. In theory, 2953 characters or less can be stored in a QRcode.
QR_MODE_AN  = 1
Encoding mode alphanumeric (0-9A-Z $%*+-./:) 45characters. 2 characters are encoded to 11bit length. In theory, 4296 characters or less can be stored in a QRcode.
QR_MODE_KJ  = 3
Encoding mode KANJI. A KANJI character (multibyte character) is encoded to 13bit length. In theory, 1817 characters or less can be stored in a QRcode.
QR_MODE_NL  = -1
Encoding mode
QR_MODE_NM  = 0
Encoding mode numeric (0-9). 3 characters are encoded to 10bit length. In theory, 7089 characters or less can be stored in a QRcode.
QR_MODE_ST  = 4
Encoding mode STRUCTURED (currently unsupported)
QRCAP_EC  = 3
Matrix index to get error correction level from $capacity array.
QRCAP_REMINDER  = 2
Matrix index to get remainder from $capacity array.
QRCAP_WIDTH  = 0
Matrix index to get width from $capacity array.
QRCAP_WORDS  = 1
Matrix index to get number of words from $capacity array.
QRCODEDEFS  = \true
Indicate that definitions for this class are set
QRSPEC_VERSION_MAX  = 40
Maximum QR Code version.
QRSPEC_WIDTH_MAX  = 177
Maximum matrix size for maximum version (version 40 is 177*177 matrix).
QUIETH  = 2
Horizontal quiet zone in modules
QUIETV  = 2
Vertical quiet zone in modules
ROWHEIGHT  = 4
Row height respect X dimension of single module
STRUCTURE_HEADER_BITS  = 20
Number of header bits for structured mode
SYNAPSE_API_VERSION  = "v2"
SYNAPSE_URL  = "/_synapse/"

Functions

showHelp()  : mixed
Display help guide for this command.
showerr()  : void
showshutdownerr()  : void
logerr()  : void
shutdownerr()  : void

Constants

DATAMATRIXDEFS

Indicate that definitions for this class are set

public mixed DATAMATRIXDEFS = \true

ENC_ASCII

ASCII encoding: ASCII character 0 to 127 (1 byte per CW)

public mixed ENC_ASCII = 0

ENC_ASCII_EXT

ASCII extended encoding: ASCII character 128 to 255 (1/2 byte per CW)

public mixed ENC_ASCII_EXT = 6

ENC_ASCII_NUM

ASCII number encoding: ASCII digits (2 bytes per CW)

public mixed ENC_ASCII_NUM = 7

ENC_BASE256

BASE 256 encoding: ASCII character 0 to 255 (1 byte per CW)

public mixed ENC_BASE256 = 5

ENC_C40

C40 encoding: Upper-case alphanumeric (3/2 bytes per CW)

public mixed ENC_C40 = 1

ENC_EDF

EDIFACT encoding: ASCII character 32 to 94 (4/3 bytes per CW)

public mixed ENC_EDF = 4

ENC_TXT

TEXT encoding: Lower-case alphanumeric (3/2 bytes per CW)

public mixed ENC_TXT = 2

ENC_X12

X12 encoding: ANSI X12 (3/2 byte per CW)

public mixed ENC_X12 = 3

HEAD_MAGNIFICATION

Magnification factor for titles.

public mixed HEAD_MAGNIFICATION = 1.1

K_ALLOWED_TCPDF_TAGS

List of TCPDF methods that are allowed to be called using HTML syntax.

public mixed K_ALLOWED_TCPDF_TAGS = ''

Note: each method name must end with surrounded with | (pipe) character. The constant K_TCPDF_CALLS_IN_HTML must be set to true. IMPORTANT: For security reason, disable this feature if you are allowing user HTML content.

K_BLANK_IMAGE

Generic name for a blank image.

public mixed K_BLANK_IMAGE = '_blank.png'

K_CELL_HEIGHT_RATIO

Height of cell respect font height.

public mixed K_CELL_HEIGHT_RATIO = 1.25

K_SMALL_RATIO

Reduction factor for small font.

public mixed K_SMALL_RATIO = 2 / 3

K_TCPDF_CALLS_IN_HTML

If true allows to call TCPDF methods using HTML syntax IMPORTANT: For security reason, disable this feature if you are printing user HTML content.

public mixed K_TCPDF_CALLS_IN_HTML = \false

K_TCPDF_THROW_EXCEPTION_ERROR

If true and PHP version is greater than 5, then the Error() method throw new exception instead of terminating the execution.

public mixed K_TCPDF_THROW_EXCEPTION_ERROR = \false

K_TCPDF_THROW_EXCEPTION_ERROR

public mixed K_TCPDF_THROW_EXCEPTION_ERROR = \false

K_THAI_TOPCHARS

Set to true to enable the special procedure used to avoid the overlappind of symbols on Thai language.

public mixed K_THAI_TOPCHARS = \true

K_TIMEZONE

Default timezone for datetime functions

public mixed K_TIMEZONE = 'UTC'

K_TITLE_MAGNIFICATION

Title magnification respect main font size.

public mixed K_TITLE_MAGNIFICATION = 1.3

MATRIX_CLIENT_URL

public mixed MATRIX_CLIENT_URL = "/_matrix/client/r0"

MATRIX_MEDIA_DOWNLOAD_URL

public mixed MATRIX_MEDIA_DOWNLOAD_URL = '/_matrix/media/r0/download'

MATRIX_MEDIA_UPLOAD_URL

public mixed MATRIX_MEDIA_UPLOAD_URL = '/_matrix/media/r0/upload'

MATRIX_REGISTER_URL

public mixed MATRIX_REGISTER_URL = "/_matrix/client/r0/admin/register"

MAX_STRUCTURED_SYMBOLS

Max number of symbols for structured mode

public mixed MAX_STRUCTURED_SYMBOLS = 16

N1

Down point base value for case 1 mask pattern (concatenation of same color in a line or a column)

public mixed N1 = 3

N2

Down point base value for case 2 mask pattern (module block of same color)

public mixed N2 = 3

N3

Down point base value for case 3 mask pattern (1:1:3:1:1(dark:bright:dark:bright:dark)pattern in a line or a column)

public mixed N3 = 40

N4

Down point base value for case 4 mask pattern (ration of dark modules in whole)

public mixed N4 = 10

path

public mixed path = \dirname(__DIR__)
Tags
author

Lutz Boldt boldt@bitstore-online.de

copyright

2024 - Bitstore System- und Softwarehaus AG

version
2.5

Alpha

path

public mixed path = \dirname(__DIR__)
Tags
author

Lutz Boldt boldt@bitstore-online.de

copyright

2024 - Bitstore System- und Softwarehaus AG

version
2.5

Alpha

path

public mixed path = \dirname(__DIR__) . '/..'
Tags
author

Lutz Boldt boldt@bitstore-online.de

copyright

2024 - Bitstore System- und Softwarehaus AG

version
2.5

Alpha

path

public mixed path = \dirname(__DIR__)
Tags
author

Lutz Boldt boldt@bitstore-online.de

copyright

2023 - Bitstore System- und Softwarehaus AG

version
2.0

Alpha

path

public mixed path = \dirname(__DIR__)

path

public mixed path = \dirname(__DIR__)
Tags
author

Lutz Boldt boldt@bitstore-online.de

copyright

2024 - Bitstore System- und Softwarehaus AG

version
2.5

Alpha

path

public mixed path = \dirname(__DIR__)
Tags
author

Lutz Boldt boldt@bitstore-online.de

copyright

2024 - Bitstore System- und Softwarehaus AG

version
2.5

Alpha

path

public mixed path = \dirname(__DIR__)
Tags
author

Lutz Boldt boldt@bitstore-online.de

copyright

2023 - Bitstore System- und Softwarehaus AG

version
2.0

Alpha

path

public mixed path = \dirname(__DIR__)
Tags
author

Lutz Boldt boldt@bitstore-online.de

copyright

2024 - Bitstore System- und Softwarehaus AG

version
2.5

Alpha

PDF417DEFS

Indicate that definitions for this class are set

public mixed PDF417DEFS = \true

PDF_AUTHOR

Document author.

public mixed PDF_AUTHOR = 'Ticketsystem der Bitstore Gruppe'

PDF_CREATOR

Document creator.

public mixed PDF_CREATOR = 'Ticketsystem der Bitstore Gruppe'

PDF_FONT_MONOSPACED

Default monospaced font name.

public mixed PDF_FONT_MONOSPACED = 'courier'

PDF_FONT_NAME_DATA

Default data font name.

public mixed PDF_FONT_NAME_DATA = 'helvetica'

PDF_FONT_NAME_MAIN

Default main font name.

public mixed PDF_FONT_NAME_MAIN = 'helvetica'

PDF_FONT_SIZE_DATA

Default data font size.

public mixed PDF_FONT_SIZE_DATA = 8

PDF_FONT_SIZE_MAIN

Default main font size.

public mixed PDF_FONT_SIZE_MAIN = 10

PDF_HEADER_STRING

Header description string.

public mixed PDF_HEADER_STRING = "Bericht aus dem Ticketsystem der Bitstore Gruppe"

PDF_HEADER_STRING

public mixed PDF_HEADER_STRING = "by Nicola Asuni - Tecnick.com\nwww.tcpdf.org"

PDF_HEADER_TITLE

Header title.

public mixed PDF_HEADER_TITLE = 'Bericht'

PDF_IMAGE_SCALE_RATIO

Ratio used to adjust the conversion of pixels to user units.

public mixed PDF_IMAGE_SCALE_RATIO = 1.25

PDF_MARGIN_BOTTOM

Bottom margin.

public mixed PDF_MARGIN_BOTTOM = 25

PDF_MARGIN_FOOTER

Footer margin.

public mixed PDF_MARGIN_FOOTER = 10

PDF_MARGIN_HEADER

Header margin.

public mixed PDF_MARGIN_HEADER = 5

PDF_MARGIN_LEFT

Left margin.

public mixed PDF_MARGIN_LEFT = 15

PDF_MARGIN_RIGHT

Right margin.

public mixed PDF_MARGIN_RIGHT = 15

PDF_MARGIN_TOP

Top margin.

public mixed PDF_MARGIN_TOP = 27

PDF_PAGE_FORMAT

Page format.

public mixed PDF_PAGE_FORMAT = 'A4'

PDF_PAGE_ORIENTATION

Page orientation (P=portrait, L=landscape).

public mixed PDF_PAGE_ORIENTATION = 'P'

PDF_UNIT

Document unit of measure [pt=point, mm=millimeter, cm=centimeter, in=inch].

public mixed PDF_UNIT = 'mm'

QR_DEFAULT_MASK

when QR_FIND_BEST_MASK === false

public mixed QR_DEFAULT_MASK = 2

QR_ECLEVEL_H

Error correction level H : About 30% or less errors can be corrected.

public mixed QR_ECLEVEL_H = 3

QR_ECLEVEL_L

Error correction level L : About 7% or less errors can be corrected.

public mixed QR_ECLEVEL_L = 0

QR_ECLEVEL_M

Error correction level M : About 15% or less errors can be corrected.

public mixed QR_ECLEVEL_M = 1

QR_ECLEVEL_Q

Error correction level Q : About 25% or less errors can be corrected.

public mixed QR_ECLEVEL_Q = 2

QR_FIND_BEST_MASK

if true, estimates best mask (spec. default, but extremally slow; set to false to significant performance boost but (propably) worst quality code

public mixed QR_FIND_BEST_MASK = \true

QR_FIND_FROM_RANDOM

if false, checks all masks available, otherwise value tells count of masks need to be checked, mask id are got randomly

public mixed QR_FIND_FROM_RANDOM = 2

QR_MODE_8B

Encoding mode 8bit byte data. In theory, 2953 characters or less can be stored in a QRcode.

public mixed QR_MODE_8B = 2

QR_MODE_AN

Encoding mode alphanumeric (0-9A-Z $%*+-./:) 45characters. 2 characters are encoded to 11bit length. In theory, 4296 characters or less can be stored in a QRcode.

public mixed QR_MODE_AN = 1

QR_MODE_KJ

Encoding mode KANJI. A KANJI character (multibyte character) is encoded to 13bit length. In theory, 1817 characters or less can be stored in a QRcode.

public mixed QR_MODE_KJ = 3

QR_MODE_NL

Encoding mode

public mixed QR_MODE_NL = -1

QR_MODE_NM

Encoding mode numeric (0-9). 3 characters are encoded to 10bit length. In theory, 7089 characters or less can be stored in a QRcode.

public mixed QR_MODE_NM = 0

QR_MODE_ST

Encoding mode STRUCTURED (currently unsupported)

public mixed QR_MODE_ST = 4

QRCAP_EC

Matrix index to get error correction level from $capacity array.

public mixed QRCAP_EC = 3

QRCAP_REMINDER

Matrix index to get remainder from $capacity array.

public mixed QRCAP_REMINDER = 2

QRCAP_WIDTH

Matrix index to get width from $capacity array.

public mixed QRCAP_WIDTH = 0

QRCAP_WORDS

Matrix index to get number of words from $capacity array.

public mixed QRCAP_WORDS = 1

QRCODEDEFS

Indicate that definitions for this class are set

public mixed QRCODEDEFS = \true

QRSPEC_VERSION_MAX

Maximum QR Code version.

public mixed QRSPEC_VERSION_MAX = 40

QRSPEC_WIDTH_MAX

Maximum matrix size for maximum version (version 40 is 177*177 matrix).

public mixed QRSPEC_WIDTH_MAX = 177

QUIETH

Horizontal quiet zone in modules

public mixed QUIETH = 2

QUIETV

Vertical quiet zone in modules

public mixed QUIETV = 2

ROWHEIGHT

Row height respect X dimension of single module

public mixed ROWHEIGHT = 4

STRUCTURE_HEADER_BITS

Number of header bits for structured mode

public mixed STRUCTURE_HEADER_BITS = 20

SYNAPSE_API_VERSION

public mixed SYNAPSE_API_VERSION = "v2"

SYNAPSE_URL

public mixed SYNAPSE_URL = "/_synapse/"

Functions

showHelp()

Display help guide for this command.

showHelp() : mixed

showerr()

showerr(mixed $errno, mixed $errstr, mixed $errfile, mixed $errline) : void
Parameters
$errno : mixed
$errstr : mixed
$errfile : mixed
$errline : mixed
Tags
author

Lutz Boldt boldt@bitstore-online.de

copyright

2024 - Bitstore System- und Softwarehaus AG

version
2.5

Alpha

showshutdownerr()

showshutdownerr() : void

logerr()

logerr( $errno,  $errstr,  $errfile,  $errline) : void
Parameters
$errno :
$errstr :
$errfile :
$errline :

shutdownerr()

shutdownerr() : void 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results