TCPDF_STATIC

class TCPDF_STATIC (View source)

Properties

static $alias_tot_pages

String alias for total number of pages.
static $alias_num_page

String alias for page number.
static $alias_group_tot_pages

String alias for total number of pages in a single group.
static $alias_group_num_page

String alias for group page number.
static $alias_right_shift

String alias for right shift compensation used to correctly align page numbers on the right.
static $enc_padding

Encryption padding string.
static Since: 4.6.028 (2009-08-25)
$byterange_string

ByteRange placemark used during digital signature process.
static $pageboxes

Array page boxes names
static array<string,float[]> $page_formats

Array of page formats measures are calculated in this way: (inches 72) or (millimeters 72 / 25.4)

Methods

static string
getTCPDFVersion()

Return the current TCPDF version.

static string
getTCPDFProducer()

Return the current TCPDF producer.

static bool
isValidURL(string $url)

Check if the URL exist.

static string
removeSHY(string $txt = '', bool $unicode = true)

Removes SHY characters from text.

static array
getBorderMode(string|array|int $brd, string $position = 'start', bool $opencell = true)

Get the border mode accounting for multicell position (opens bottom side of multicell crossing pages)

static bool
empty_string(string $str)

Determine whether a string is empty.

static string
getObjFilename(string $type = 'tmp', string $file_id = '')

Returns a temporary filename for caching object on filesystem.

static string
_escape(string $s)

Add "\" before "\", "(" and ")"

static string
_escapeXML(string $str)

Escape some special characters (< > &) for XML output.

static object
objclone(object $object)

Creates a copy of a class object

static 
sendOutputData(string $data, int $length)

Output input data and compress it if possible.

static array
replacePageNumAliases(string $page, array $replace, int $diff = 0)

Replace page number aliases with number.

static int
getTimestamp(string $date)

Returns timestamp in seconds from formatted date-time.

static string
getFormattedDate(int $time)

Returns a formatted date-time.

static string
getRandomSeed(string $seed = '')

Returns a string containing random data to be used as a seed for encryption methods.

static string
_md5_16(string $str)

Encrypts a string using MD5 and returns it's value as a binary string.

static string
_AES(string $key, string $text)

Returns the input text encrypted using AES algorithm and the specified key.

static string
_AESnopad(string $key, string $text)

Returns the input text encrypted using AES algorithm and the specified key.

static string
_RC4(string $key, string $text, string $last_enc_key, string $last_enc_key_c)

Returns the input text encrypted using RC4 algorithm and the specified key.

static 
getUserPermissionCode(array $permissions, int $mode = 0)

Return the permission code used on encryption (P value).

static string
convertHexStringToString(string $bs)

Convert hexadecimal string to string

static string
convertStringToHexString(string $s)

Convert string to hexadecimal string (byte string)

static string
getEncPermissionsString(string $protection)

Convert encryption P value to a string of bytes, low-order byte first.

static string
encodeNameObject(string $name)

Encode a name object.

static array
getAnnotOptFromJSProp(array $prop, array $spot_colors, bool $rtl = false)

Convert JavaScript form fields properties array to Annotation Properties array.

static string
formatPageNumber(int $num)

Format the page numbers.

static string
formatTOCPageNumber(int $num)

Format the page numbers on the Table Of Content.

static array
extractCSSproperties(string $cssdata)

Extracts the CSS properties from a CSS string.

static string
fixHTMLCode(string $html, string $default_css, array|null $tagvs, array|null $tidy_options, array $tagvspaces)

Cleanup HTML code (requires HTML Tidy library).

static true
isValidCSSSelectorForTag(array $dom, int $key, string $selector)

Returns true if the CSS selector is valid for the selected HTML tag

static array
getCSSdataArray(array $dom, int $key, array $css)

Returns the styles array that apply for the selected HTML tag.

static string
getTagStyleFromCSSarray(array $css)

Compact CSS data array into single string.

static string
intToRoman(int $number)

Returns the Roman representation of an integer number

static int|false
revstrpos(string $haystack, string $needle, int $offset = 0)

Find position of last occurrence of a substring in a string

static array
getHyphenPatternsFromTEX(string $file)

Returns an array of hyphenation patterns.

static string
getPathPaintOperator(string $style, string $default = 'S')

Get the Path-Painting Operators.

static array
getTransformationMatrixProduct(array $ta, array $tb)

Get the product of two SVG tranformation matrices

static array
getSVGTransformMatrix(string $attribute)

Get the tranformation matrix from SVG transform attribute

static 
getVectorsAngle(int $x1, int $y1, int $x2, int $y2)

Returns the angle in radiants between two vectors

static array
pregSplit(string $pattern, string $modifiers, string $subject, int $limit = NULL, int $flags = NULL)

Split string by a regular expression.

static resource|false
fopenLocal(string $filename, string $mode)

Wrapper to use fopen only with local files

static bool
url_exists(string $url)

Check if the URL exist.

static string
encodeUrlQuery(string $url)

Encode query params in URL

static bool
file_exists(string $filename)

Wrapper for file_exists.

static string|false
fileGetContents(string $file)

Reads entire file into a string.

static int
_getULONG(string $str, int $offset)

Get ULONG from string (Big Endian 32-bit unsigned integer).

static int
_getUSHORT(string $str, int $offset)

Get USHORT from string (Big Endian 16-bit unsigned integer).

static int
_getSHORT(string $str, int $offset)

Get SHORT from string (Big Endian 16-bit signed integer).

static int
_getFWORD(string $str, int $offset)

Get FWORD from string (Big Endian 16-bit signed integer).

static int
_getUFWORD(string $str, int $offset)

Get UFWORD from string (Big Endian 16-bit unsigned integer).

static int
_getFIXED(string $str, int $offset)

Get FIXED from string (32-bit signed fixed-point number (16.16).

static int
_getBYTE(string $str, int $offset)

Get BYTE from string (8-bit unsigned integer).

static string|false
rfread(resource $handle, int $length)

Binary-safe and URL-safe file read.

static int
_freadint(resource $f)

Read a 4-byte (32 bit) integer from file.

static array
getPageSizeFromFormat(mixed $format)

Get page dimensions from format name.

static array
setPageBoxes(int $page, string $type, float $llx, float $lly, float $urx, float $ury, bool $points, float $k, array $pagedim = array())

Set page boundaries.

static array
swapPageBoxCoordinates(int $page, array $pagedim)

Swap X and Y coordinates of page boxes (change page boxes orientation).

static string
getPageLayoutMode(string $layout = 'SinglePage')

Get the canonical page layout mode.

static string
getPageMode(string $mode = 'UseNone')

Get the canonical page layout mode.

Details

at line 117
static string getTCPDFVersion()

Since: 5.9.012 (2010-11-10)

Return the current TCPDF version.

Return Value

string

TCPDF version string

at line 127
static string getTCPDFProducer()

Since: 6.0.000 (2013-03-16)

Return the current TCPDF producer.

Return Value

string

TCPDF producer string

at line 138
static bool isValidURL(string $url)

Since: 5.9.204 (2013-01-28)

Check if the URL exist.

Parameters

string $url

URL to check.

Return Value

bool

true if the URl exist, false otherwise.

at line 163
static string removeSHY(string $txt = '', bool $unicode = true)

Since: (4.5.019) 2009-02-28

Removes SHY characters from text.

Unicode Data:

  • Name : SOFT HYPHEN, commonly abbreviated as SHY
  • HTML Entity (decimal): "&#173;"
  • HTML Entity (hex): "&#xad;"
  • HTML Entity (named): "&shy;"
  • How to type in Microsoft Windows: [Alt +00AD] or [Alt 0173]
  • UTF-8 (hex): 0xC2 0xAD (c2ad)
  • UTF-8 character: chr(194).chr(173)

Parameters

string $txt

input string
bool $unicode

True if we are in unicode mode, false otherwise.

Return Value

string

without SHY characters.

at line 181
static array getBorderMode(string|array|int $brd, string $position = 'start', bool $opencell = true)

Since: 4.4.002 (2008-12-09)

Get the border mode accounting for multicell position (opens bottom side of multicell crossing pages)

Parameters

string|array|int $brd

Indicates if borders must be drawn around the cell block. The value can be 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
or an array of line styles for each border group: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
string $position

multicell position: 'start', 'middle', 'end'
bool $opencell

True when the cell is left open at the page bottom, false otherwise.

Return Value

array

border mode array

at line 253
static bool empty_string(string $str)

Since: 4.5.044 (2009-04-16)

Determine whether a string is empty.

Parameters

string $str

string to be checked

Return Value

bool

true if string is empty

at line 265
static string getObjFilename(string $type = 'tmp', string $file_id = '')

Since: 4.5.000 (2008-12-31)

Returns a temporary filename for caching object on filesystem.

Parameters

string $type

Type of file (name of the subdir on the tcpdf cache folder).
string $file_id

TCPDF file_id.

Return Value

string filename.

at line 275
static string _escape(string $s)

Add "\" before "\", "(" and ")"

Parameters

string $s

string to escape.

Return Value

string

escaped string.

at line 287
static string _escapeXML(string $str)

Since: 5.9.121 (2011-09-28)

Escape some special characters (< > &) for XML output.

Parameters

string $str

Input string to convert.

Return Value

string

converted string

at line 300
static object objclone(object $object)

Since: 4.5.029 (2009-03-19)

Creates a copy of a class object

Parameters

object $object

class object to be cloned

Return Value

object

cloned object

at line 315
static sendOutputData(string $data, int $length)

Since: 5.9.086

Output input data and compress it if possible.

Parameters

string $data

Data to output.
int $length

Data length in bytes.

at line 331
static array replacePageNumAliases(string $page, array $replace, int $diff = 0)

Replace page number aliases with number.

Parameters

string $page

Page content.
array $replace

Array of replacements (array keys are replacement strings, values are alias arrays).
int $diff

If passed, this will be set to the total char number difference between alias and replacements.

Return Value

array

replaced page content and updated $diff parameter as array.

at line 350
static int getTimestamp(string $date)

Since: 5.9.152 (2012-03-23)

Returns timestamp in seconds from formatted date-time.

Parameters

string $date

Formatted date-time.

Return Value

int seconds.

at line 365
static string getFormattedDate(int $time)

Since: 5.9.152 (2012-03-23)

Returns a formatted date-time.

Parameters

int $time

Time in seconds.

Return Value

string

escaped date string.

at line 377
static string getRandomSeed(string $seed = '')

Since: 5.9.006 (2010-10-19)

Returns a string containing random data to be used as a seed for encryption methods.

Parameters

string $seed

starting seed value

Return Value

string

containing random data

at line 403
static string _md5_16(string $str)

Since: 2.0.000 (2008-01-02)

Encrypts a string using MD5 and returns it's value as a binary string.

Parameters

string $str

input string

Return Value

string

MD5 encrypted binary string

at line 417
static string _AES(string $key, string $text)

Since: 5.0.005 (2010-05-11)

Returns the input text encrypted using AES algorithm and the specified key.

This method requires openssl or mcrypt. Text is padded to 16bytes blocks

Parameters

string $key

encryption key
string $text

input text to be encrypted

Return Value

string

encrypted text

at line 446
static string _AESnopad(string $key, string $text)

Since: TODO

Returns the input text encrypted using AES algorithm and the specified key.

This method requires openssl or mcrypt. Text is not padded

Parameters

string $key

encryption key
string $text

input text to be encrypted

Return Value

string

encrypted text

at line 473
static string _RC4(string $key, string $text, string $last_enc_key, string $last_enc_key_c)

Since: 2.0.000 (2008-01-02)

Returns the input text encrypted using RC4 algorithm and the specified key.

RC4 is the standard encryption algorithm used in PDF format

Parameters

string $key

Encryption key.
string $text

Input text to be encrypted.
string $last_enc_key

Reference to last RC4 key encrypted.
string $last_enc_key_c

Reference to last RC4 computed key.

Return Value

string

encrypted text

at line 517
static getUserPermissionCode(array $permissions, int $mode = 0)

Since: 5.0.005 (2010-05-12)

Return the permission code used on encryption (P value).

Parameters

array $permissions

the set of permissions (specify the ones you want to block).
int $mode

encryption strength: 0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit.

at line 554
static string convertHexStringToString(string $bs)

Since: 5.0.005 (2010-05-12)

Convert hexadecimal string to string

Parameters

string $bs

byte-string to convert

Return Value

string

at line 576
static string convertStringToHexString(string $s)

Since: 5.0.010 (2010-05-17)

Convert string to hexadecimal string (byte string)

Parameters

string $s

string to convert

Return Value

string

byte string

at line 593
static string getEncPermissionsString(string $protection)

Since: 5.0.005 (2010-05-12)

Convert encryption P value to a string of bytes, low-order byte first.

Parameters

string $protection

32bit encryption permission value (P value)

Return Value

string

at line 610
static string encodeNameObject(string $name)

Since: 5.9.097 (2011-06-23)

Encode a name object.

Parameters

string $name

Name object to encode.

Return Value

string

Encoded name object.

at line 634
static array getAnnotOptFromJSProp(array $prop, array $spot_colors, bool $rtl = false)

Since: 4.8.000 (2009-09-06)

Convert JavaScript form fields properties array to Annotation Properties array.

Parameters

array $prop

javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
array $spot_colors

Reference to spot colors array.
bool $rtl

True if in Right-To-Left text direction mode, false otherwise.

Return Value

array

of annotation properties

at line 999
static string formatPageNumber(int $num)

Since: 4.2.005 (2008-11-06)

Format the page numbers.

This method can be overridden for custom formats.

Parameters

int $num

page number

Return Value

string

at line 1012
static string formatTOCPageNumber(int $num)

Since: 4.5.001 (2009-01-04)

Format the page numbers on the Table Of Content.

This method can be overridden for custom formats.

Parameters

int $num

page number

Return Value

string

See also

addTOC()
addHTMLTOC()

at line 1024
static array extractCSSproperties(string $cssdata)

Since: 5.1.000 (2010-05-25)

Extracts the CSS properties from a CSS string.

Parameters

string $cssdata

string containing CSS definitions.

Return Value

array

An array where the keys are the CSS selectors and the values are the CSS properties.

at line 1120
static string fixHTMLCode(string $html, string $default_css, array|null $tagvs, array|null $tidy_options, array $tagvspaces)

Since: 5.9.017 (2010-11-16)

Cleanup HTML code (requires HTML Tidy library).

Parameters

string $html

htmlcode to fix
string $default_css

CSS commands to add
array|null $tagvs

parameters for setHtmlVSpace method
array|null $tidy_options

options for tidy_parse_string function
array $tagvspaces

Array of vertical spaces for tags.

Return Value

string

XHTML code cleaned up

See also

setHtmlVSpace()

at line 1186
static true isValidCSSSelectorForTag(array $dom, int $key, string $selector)

Since: 5.1.000 (2010-05-25)

Returns true if the CSS selector is valid for the selected HTML tag

Parameters

array $dom

array of HTML tags and properties
int $key

key of the current HTML tag
string $selector

CSS selector string

Return Value

true

if the selector is valid, false otherwise

at line 1346
static array getCSSdataArray(array $dom, int $key, array $css)

Since: 5.1.000 (2010-05-25)

Returns the styles array that apply for the selected HTML tag.

Parameters

array $dom

array of HTML tags and properties
int $key

key of the current HTML tag
array $css

array of CSS properties

Return Value

array

containing CSS properties

at line 1391
static string getTagStyleFromCSSarray(array $css)

Since: 5.9.070 (2011-04-19)

Compact CSS data array into single string.

Parameters

array $css

array of CSS properties

Return Value

string

containing merged CSS properties

at line 1422
static string intToRoman(int $number)

Since: 4.4.004 (2008-12-10)

Returns the Roman representation of an integer number

Parameters

int $number

number to convert

Return Value

string

roman representation of the specified number

at line 1492
static int|false revstrpos(string $haystack, string $needle, int $offset = 0)

Since: 4.8.038 (2010-03-13)

Find position of last occurrence of a substring in a string

Parameters

string $haystack

The string to search in.
string $needle

substring to search.
int $offset

May be specified to begin searching an arbitrary number of characters into the string.

Return Value

int|false

Returns the position where the needle exists. Returns FALSE if the needle was not found.

at line 1507
static array getHyphenPatternsFromTEX(string $file)

Since: 4.9.012 (2010-04-12)

Returns an array of hyphenation patterns.

Parameters

string $file

TEX file containing hypenation patterns. TEX patterns can be downloaded from http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/

Return Value

array

of hyphenation patterns

at line 1554
static string getPathPaintOperator(string $style, string $default = 'S')

Since: 5.0.000 (2010-04-30)

Get the Path-Painting Operators.

Parameters

string $style

Style of rendering. Possible values are:

  • S or D: Stroke the path.
  • s or d: Close and stroke the path.
  • f or F: Fill the path, using the nonzero winding number rule to determine the region to fill.
  • f* or F*: Fill the path, using the even-odd rule to determine the region to fill.
  • B or FD or DF: Fill and then stroke the path, using the nonzero winding number rule to determine the region to fill.
  • B* or F*D or DF*: Fill and then stroke the path, using the even-odd rule to determine the region to fill.
  • b or fd or df: Close, fill, and then stroke the path, using the nonzero winding number rule to determine the region to fill.
  • b or f*d or df*: Close, fill, and then stroke the path, using the even-odd rule to determine the region to fill.
  • CNZ: Clipping mode using the even-odd rule to determine which regions lie inside the clipping path.
  • CEO: Clipping mode using the nonzero winding number rule to determine which regions lie inside the clipping path
  • n: End the path object without filling or stroking it.
string $default

default style

Return Value

string

at line 1633
static array getTransformationMatrixProduct(array $ta, array $tb)

Since: 5.0.000 (2010-05-02)

Get the product of two SVG tranformation matrices

Parameters

array $ta

first SVG tranformation matrix
array $tb

second SVG tranformation matrix

Return Value

array

transformation array

at line 1652
static array getSVGTransformMatrix(string $attribute)

Since: 5.0.000 (2010-05-02)

Get the tranformation matrix from SVG transform attribute

Parameters

string $attribute transformation

Return Value

array

of transformations

at line 1749
static getVectorsAngle(int $x1, int $y1, int $x2, int $y2)

Since: 5.0.000 (2010-05-04)

Returns the angle in radiants between two vectors

Parameters

int $x1

X coordinate of first vector point
int $y1

Y coordinate of first vector point
int $x2

X coordinate of second vector point
int $y2

Y coordinate of second vector point

at line 1776
static array pregSplit(string $pattern, string $modifiers, string $subject, int $limit = NULL, int $flags = NULL)

Since: 6.0.023

Split string by a regular expression.

This is a wrapper for the preg_split function to avoid the bug: https://bugs.php.net/bug.php?id=45850

Parameters

string $pattern

The regular expression pattern to search for without the modifiers, as a string.
string $modifiers

The modifiers part of the pattern,
string $subject

The input string.
int $limit

If specified, then only substrings up to limit are returned with the rest of the string being placed in the last substring. A limit of -1, 0 or NULL means "no limit" and, as is standard across PHP, you can use NULL to skip to the flags parameter.
int $flags

The flags as specified on the preg_split PHP function.

Return Value

array

Returns an array containing substrings of subject split along boundaries matched by pattern.modifier

at line 1808
static resource|false fopenLocal(string $filename, string $mode)

Wrapper to use fopen only with local files

Parameters

string $filename

Name of the file to open
string $mode

Return Value

resource|false

Returns a file pointer resource on success, or FALSE on error.

at line 1824
static bool url_exists(string $url)

Since: 6.2.25

Check if the URL exist.

Parameters

string $url

URL to check.

Return Value

bool

Returns TRUE if the URL exists; FALSE otherwise.

at line 1857
static string encodeUrlQuery(string $url)

Since: 6.3.3 (2019-11-01)

Encode query params in URL

Parameters

string $url

Return Value

string

at line 1878
static bool file_exists(string $filename)

Wrapper for file_exists.

Checks whether a file or directory exists. Only allows some protocols and local files.

Parameters

string $filename

Path to the file or directory.

Return Value

bool

Returns TRUE if the file or directory specified by filename exists; FALSE otherwise.

at line 1897
static string|false fileGetContents(string $file)

Since: 6.0.025

Reads entire file into a string.

The file can be also an URL.

Parameters

string $file

Name of the file or URL to read.

Return Value

string|false

The function returns the read data or FALSE on failure.

at line 1997
static int _getULONG(string $str, int $offset)

Since: 5.2.000 (2010-06-02)

Get ULONG from string (Big Endian 32-bit unsigned integer).

Parameters

string $str

string from where to extract value
int $offset

point from where to read the data

Return Value

int

32 bit value

at line 2011
static int _getUSHORT(string $str, int $offset)

Since: 5.2.000 (2010-06-02)

Get USHORT from string (Big Endian 16-bit unsigned integer).

Parameters

string $str

string from where to extract value
int $offset

point from where to read the data

Return Value

int

16 bit value

at line 2025
static int _getSHORT(string $str, int $offset)

Since: 5.2.000 (2010-06-02)

Get SHORT from string (Big Endian 16-bit signed integer).

Parameters

string $str

String from where to extract value.
int $offset

Point from where to read the data.

Return Value

int

16 bit value

at line 2039
static int _getFWORD(string $str, int $offset)

Since: 5.9.123 (2011-09-30)

Get FWORD from string (Big Endian 16-bit signed integer).

Parameters

string $str

String from where to extract value.
int $offset

Point from where to read the data.

Return Value

int

16 bit value

at line 2056
static int _getUFWORD(string $str, int $offset)

Since: 5.9.123 (2011-09-30)

Get UFWORD from string (Big Endian 16-bit unsigned integer).

Parameters

string $str

string from where to extract value
int $offset

point from where to read the data

Return Value

int

16 bit value

at line 2070
static int _getFIXED(string $str, int $offset)

Since: 5.9.123 (2011-09-30)

Get FIXED from string (32-bit signed fixed-point number (16.16).

Parameters

string $str

string from where to extract value
int $offset

point from where to read the data

Return Value

int

16 bit value

at line 2088
static int _getBYTE(string $str, int $offset)

Since: 5.2.000 (2010-06-02)

Get BYTE from string (8-bit unsigned integer).

Parameters

string $str

String from where to extract value.
int $offset

Point from where to read the data.

Return Value

int

8 bit value

at line 2102
static string|false rfread(resource $handle, int $length)

Since: 4.5.027 (2009-03-16)

Binary-safe and URL-safe file read.

Reads up to length bytes from the file pointer referenced by handle. Reading stops as soon as one of the following conditions is met: length bytes have been read; EOF (end of file) is reached.

Parameters

resource $handle
int $length

Return Value

string|false

Returns the read string or FALSE in case of error.

at line 2120
static int _freadint(resource $f)

Read a 4-byte (32 bit) integer from file.

Parameters

resource $f

file resource.

Return Value

int

4-byte integer

at line 2491
static array getPageSizeFromFormat(mixed $format)

Since: 5.0.010 (2010-05-17)

Get page dimensions from format name.

Parameters

mixed $format

The format name self::$page_format

Return Value

array

containing page width and height in points

at line 2513
static array setPageBoxes(int $page, string $type, float $llx, float $lly, float $urx, float $ury, bool $points, float $k, array $pagedim = array())

Since: 5.0.010 (2010-05-17)

Set page boundaries.

Parameters

int $page

page number
string $type

valid values are:

  • 'MediaBox' : the boundaries of the physical medium on which the page shall be displayed or printed;
  • 'CropBox' : the visible region of default user space;
  • 'BleedBox' : the region to which the contents of the page shall be clipped when output in a production environment;
  • 'TrimBox' : the intended dimensions of the finished page after trimming;
  • 'ArtBox' : the page's meaningful content (including potential white space).
float $llx

lower-left x coordinate in user units.
float $lly

lower-left y coordinate in user units.
float $urx

upper-right x coordinate in user units.
float $ury

upper-right y coordinate in user units.
bool $points

If true uses user units as unit of measure, otherwise uses PDF points.
float $k

Scale factor (number of points in user unit).
array $pagedim

Array of page dimensions.

Return Value

array

pagedim array of page dimensions.

at line 2539
static array swapPageBoxCoordinates(int $page, array $pagedim)

Since: 5.0.010 (2010-05-17)

Swap X and Y coordinates of page boxes (change page boxes orientation).

Parameters

int $page

page number
array $pagedim

Array of page dimensions.

Return Value

array

pagedim array of page dimensions.

at line 2560
static string getPageLayoutMode(string $layout = 'SinglePage')

Get the canonical page layout mode.

Parameters

string $layout

The page layout. Possible values are:

  • SinglePage Display one page at a time
  • OneColumn Display the pages in one column
  • TwoColumnLeft Display the pages in two columns, with odd-numbered pages on the left
  • TwoColumnRight Display the pages in two columns, with odd-numbered pages on the right
  • TwoPageLeft (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the left
  • TwoPageRight (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the right

Return Value

string

Canonical page layout name.

at line 2603
static string getPageMode(string $mode = 'UseNone')

Get the canonical page layout mode.

Parameters

string $mode

A name object specifying how the document should be displayed when opened:

  • UseNone Neither document outline nor thumbnail images visible
  • UseOutlines Document outline visible
  • UseThumbs Thumbnail images visible
  • FullScreen Full-screen mode, with no menu bar, window controls, or any other window visible
  • UseOC (PDF 1.5) Optional content group panel visible
  • UseAttachments (PDF 1.6) Attachments panel visible

Return Value

string

Canonical page mode name.