Admidio API
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Packages

  • com
    • tecnick
      • tcpdf
  • None
  • PHPMailer
    • easypeasyics
  • PHPWavUtils
  • Securimage
    • classes

Classes

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

Functions

  • str_split

Class TCPDF_PARSER

Package: com\tecnick\tcpdf
Author: Nicola Asuni - info@tecnick.com
Version: 1.0.15
Brief: This is a PHP class for parsing PDF documents..
Class:

TCPDF_PARSER This is a PHP class for parsing PDF documents.


Located at tcpdf_parser.php

Methods summary

public
# __construct( $data, $cfg = array() )

Parse a PDF document an return an array of objects.

Parse a PDF document an return an array of objects.

Parameters

$data
PDF data to parse.
$cfg

Array of configuration parameters: 'die_for_errors' : if true termitate the program execution in case of error, otherwise thows an exception; 'ignore_filter_decoding_errors' : if true ignore filter decoding errors; 'ignore_missing_filter_decoders' : if true ignore missing filter decoding errors.

Since

1.0.000 (2011-05-24)

Public
protected
# setConfig( $cfg )

Set the configuration parameters.

Set the configuration parameters.

Parameters

$cfg

Array of configuration parameters: 'die_for_errors' : if true termitate the program execution in case of error, otherwise thows an exception; 'ignore_filter_decoding_errors' : if true ignore filter decoding errors; 'ignore_missing_filter_decoders' : if true ignore missing filter decoding errors.

Public
public (array)
# getParsedData( )

Return an array of parsed PDF document objects.

Return an array of parsed PDF document objects.

Returns

(array)
Array of parsed PDF document objects.

Since

1.0.000 (2011-06-26)

Public
protected Array
# getXrefData( $offset = 0, $xref = array() )

Get Cross-Reference (xref) table and trailer data from PDF document data.

Get Cross-Reference (xref) table and trailer data from PDF document data.

Parameters

$offset
xref offset (if know).
$xref
previous xref array (if any).

Returns

Array
containing xref and trailer data.

Since

1.0.000 (2011-05-24)

Protected
protected Array
# decodeXref( $startxref, $xref = array() )

Decode the Cross-Reference section

Decode the Cross-Reference section

Parameters

$startxref
Offset at which the xref section starts (position of the 'xref' keyword).
$xref
Previous xref array (if any).

Returns

Array
containing xref and trailer data.

Since

1.0.000 (2011-06-20)

Protected
protected Array
# decodeXrefStream( $startxref, $xref = array() )

Decode the Cross-Reference Stream section

Decode the Cross-Reference Stream section

Parameters

$startxref
Offset at which the xref section starts.
$xref
Previous xref array (if any).

Returns

Array
containing xref and trailer data.

Since

1.0.003 (2013-03-16)

Protected
protected array
# getRawObject( $offset = 0 )

Get object type, raw value and offset to next object

Get object type, raw value and offset to next object

Parameters

$offset
Object offset.

Returns

array
containing object type, raw value and offset to next object

Since

1.0.000 (2011-06-20)

Protected
protected array
# getIndirectObject( $obj_ref, $offset = 0, $decoding = true )

Get content of indirect object.

Get content of indirect object.

Parameters

$obj_ref
Object number and generation number separated by underscore character.
$offset
Object offset.
$decoding
If true decode streams.

Returns

array
containing object data.

Since

1.0.000 (2011-05-24)

Protected
protected array
# getObjectVal( $obj )

Get the content of object, resolving indect object reference if necessary.

Get the content of object, resolving indect object reference if necessary.

Parameters

$obj
Object value.

Returns

array
containing object data.

Since

1.0.000 (2011-06-26)

Protected
protected array
# decodeStream( $sdic, $stream )

Decode the specified stream.

Decode the specified stream.

Parameters

$sdic
Stream's dictionary array.
$stream
Stream to decode.

Returns

array
containing decoded stream data and remaining filters.

Since

1.0.000 (2011-06-22)

Protected
public
# Error( $msg )

Throw an exception or print an error message and die if the K_TCPDF_PARSER_THROW_EXCEPTION_ERROR constant is set to true.

Throw an exception or print an error message and die if the K_TCPDF_PARSER_THROW_EXCEPTION_ERROR constant is set to true.

Parameters

$msg
The error message

Since

1.0.000 (2011-05-23)

Public

Properties summary

private string $pdfdata

Raw content of the PDF document.

Raw content of the PDF document.

Private
# ''
protected array $xref

XREF data.

XREF data.

Protected
# array()
protected array $objects

Array of PDF objects.

Array of PDF objects.

Protected
# array()
private $FilterDecoders

Class object for decoding filters.

Class object for decoding filters.

Private
#
private array $cfg

Array of configuration parameters.

Array of configuration parameters.

Private
# array( 'die_for_errors' => false, 'ignore_filter_decoding_errors' => true, 'ignore_missing_filter_decoders' => true, )
Admidio API API documentation generated by ApiGen