lib/ezpdf/classes/class.ezpdftable.php

Show: inherited
Table of Contents

File containing the eZPDFTable class.

Copyright
Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.  
License
eZ Business Use License Agreement Version 2.0  
Package
lib  
Version
4.6.0  

\eZPDFTable

Package: lib

File containing the eZPDFTable class.

Parent(s)
\Cezpdf < \Cpdf
Copyright
Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.  
License
eZ Business Use License Agreement Version 2.0  
Version
4.6.0  

Constants

Constant  NEWLINE = '<C:callNewLine>'
Constant  SPACE = '<C:callSpace>'
Constant  TAB = '<C:callTab>'
Constant  PAGENUM = '#page'
Constant  TOTAL_PAGENUM = '#total'
Constant  HEADER_LEVEL = '#level'
Constant  HEADER_LEVEL_INDEX = '#indexLevel'

Properties

Propertypublic  $DocSpecStack= 'array()'
Default valuearray()Details
Type
n/a
Propertypublic  $DocSpecification= ''
Details
Type
n/a
Propertypublic  $FrontpageID= ''
Details
Type
n/a
Propertypublic  $KeywordArray= ''
Details
Type
n/a
Propertypublic  $LeftMarginArray= 'array()'
inheritedInherited from: \Cezpdf::$$LeftMarginArray
Default valuearray()Details
Type
n/a
Inherited_from
\Cezpdf::$$LeftMarginArray  
Propertypublic  $PageCounter= ''
Details
Type
n/a
Propertypublic  $PreStack= ''
Details
Type
n/a
Propertypublic  $RightMarginArray= 'array()'
inheritedInherited from: \Cezpdf::$$RightMarginArray
Default valuearray()Details
Type
n/a
Inherited_from
\Cezpdf::$$RightMarginArray  
Propertypublic  $TOC= ''
Details
Type
n/a
Propertypublic  $addLooseObjects= 'array()'
inherited

array contains infomation about how the loose objects are to be added to the document

Inherited from: \Cpdf::$$addLooseObjects\Cezpdf::$$addLooseObjects
Default valuearray()Details
Type
n/a
Inherited_from
\Cpdf::$$addLooseObjects  
Inherited_from
\Cezpdf::$$addLooseObjects  
Propertypublic  $arc4= ''''
inherited

the ancryption array for the document encryption is stored here

Inherited from: \Cpdf::$$arc4\Cezpdf::$$arc4
Default value''Details
Type
n/a
Inherited_from
\Cpdf::$$arc4  
Inherited_from
\Cezpdf::$$arc4  
Propertypublic  $arc4_objnum= '0'
inherited

the object Id of the encryption information

Inherited from: \Cpdf::$$arc4_objnum\Cezpdf::$$arc4_objnum
Default value0Details
Type
n/a
Inherited_from
\Cpdf::$$arc4_objnum  
Inherited_from
\Cezpdf::$$arc4_objnum  
Propertypublic  $callback= 'array()'
inherited

array which forms a stack to keep track of nested callback functions

Inherited from: \Cpdf::$$callback\Cezpdf::$$callback
Default valuearray()Details
Type
n/a
Inherited_from
\Cpdf::$$callback  
Inherited_from
\Cezpdf::$$callback  
Propertypublic  $catalogId= ''
inherited

the objectId (number within the objects array) of the document catalog

Inherited from: \Cpdf::$$catalogId\Cezpdf::$$catalogId
Details
Type
n/a
Inherited_from
\Cpdf::$$catalogId  
Inherited_from
\Cezpdf::$$catalogId  
Propertypublic  $checkpoint= ''''
inherited

store the stack for the transaction commands, each item in here is a record of the values of all the variables within the class, so that the user can rollback at will (from each 'start' command) note that this includes the objects array, so these can be large.

Inherited from: \Cpdf::$$checkpoint\Cezpdf::$$checkpoint
Default value''Details
Type
n/a
Inherited_from
\Cpdf::$$checkpoint  
Inherited_from
\Cezpdf::$$checkpoint  
Propertypublic  $currentBaseFont= ''''
inherited

the current base font

Inherited from: \Cpdf::$$currentBaseFont\Cezpdf::$$currentBaseFont
Default value''Details
Type
n/a
Inherited_from
\Cpdf::$$currentBaseFont  
Inherited_from
\Cezpdf::$$currentBaseFont  
Propertypublic  $currentColour= ''
inherited

current colour for fill operations, defaults to inactive value, all three components should be between 0 and 1 inclusive when active

Inherited from: \Cpdf::$$currentColour\Cezpdf::$$currentColour
Details
Type
n/a
Inherited_from
\Cpdf::$$currentColour  
Inherited_from
\Cezpdf::$$currentColour  
Propertypublic  $currentContents= ''
inherited

object number of the currently active contents block

Inherited from: \Cpdf::$$currentContents\Cezpdf::$$currentContents
Details
Type
n/a
Inherited_from
\Cpdf::$$currentContents  
Inherited_from
\Cezpdf::$$currentContents  
Propertypublic  $currentFont= ''''
inherited

a record of the current font

Inherited from: \Cpdf::$$currentFont\Cezpdf::$$currentFont
Default value''Details
Type
n/a
Inherited_from
\Cpdf::$$currentFont  
Inherited_from
\Cezpdf::$$currentFont  
Propertypublic  $currentFontNum= '0'
inherited

the number of the current font within the font array

Inherited from: \Cpdf::$$currentFontNum\Cezpdf::$$currentFontNum
Default value0Details
Type
n/a
Inherited_from
\Cpdf::$$currentFontNum  
Inherited_from
\Cezpdf::$$currentFontNum  
Propertypublic  $currentLineStyle= ''''
inherited

current style that lines are drawn in

Inherited from: \Cpdf::$$currentLineStyle\Cezpdf::$$currentLineStyle
Default value''Details
Type
n/a
Inherited_from
\Cpdf::$$currentLineStyle  
Inherited_from
\Cezpdf::$$currentLineStyle  
Propertypublic  $currentNode= ''
inherited

Inherited from: \Cpdf::$$currentNode\Cezpdf::$$currentNode
Details
Type
n/a
Inherited_from
\Cpdf::$$currentNode  
Inherited_from
\Cezpdf::$$currentNode  
Propertypublic  $currentPage= ''
inherited

object number of the current page

Inherited from: \Cpdf::$$currentPage\Cezpdf::$$currentPage
Details
Type
n/a
Inherited_from
\Cpdf::$$currentPage  
Inherited_from
\Cezpdf::$$currentPage  
Propertypublic  $currentStrokeColour= ''
inherited

current colour for stroke operations (lines etc.)

Inherited from: \Cpdf::$$currentStrokeColour\Cezpdf::$$currentStrokeColour
Details
Type
n/a
Inherited_from
\Cpdf::$$currentStrokeColour  
Inherited_from
\Cezpdf::$$currentStrokeColour  
Propertypublic  $currentTextState= ''''
inherited

track if the current font is bolded or italicised

Inherited from: \Cpdf::$$currentTextState\Cezpdf::$$currentTextState
Default value''Details
Type
n/a
Inherited_from
\Cpdf::$$currentTextState  
Inherited_from
\Cezpdf::$$currentTextState  
Propertypublic  $destinations= 'array()'
inherited

store label->id pairs for named destinations, these will be used to replace internal links done this way so that destinations can be defined after the location that links to them

Inherited from: \Cpdf::$$destinations\Cezpdf::$$destinations
Default valuearray()Details
Type
n/a
Inherited_from
\Cpdf::$$destinations  
Inherited_from
\Cezpdf::$$destinations  
Propertypublic  $encrypted= '0'
inherited

a flag to say if a document is to be encrypted or not

Inherited from: \Cpdf::$$encrypted\Cezpdf::$$encrypted
Default value0Details
Type
n/a
Inherited_from
\Cpdf::$$encrypted  
Inherited_from
\Cezpdf::$$encrypted  
Propertypublic  $encryptionKey= ''''
inherited

the ancryption key for the encryption of all the document content (structure is not encrypted)

Inherited from: \Cpdf::$$encryptionKey\Cezpdf::$$encryptionKey
Default value''Details
Type
n/a
Inherited_from
\Cpdf::$$encryptionKey  
Inherited_from
\Cezpdf::$$encryptionKey  
Propertypublic  $ez= 'array('fontSize'=>10)'
inheritedInherited from: \Cezpdf::$$ez
Default valuearray('fontSize'=>10)Details
Type
n/a
Inherited_from
\Cezpdf::$$ez  
Propertypublic  $ezFrame= ''
Details
Type
n/a
Propertypublic  $ezPageCount= '0'
inheritedInherited from: \Cezpdf::$$ezPageCount
Default value0Details
Type
n/a
Inherited_from
\Cezpdf::$$ezPageCount  
Propertypublic  $ezPages= 'array()'
inheritedInherited from: \Cezpdf::$$ezPages
Default valuearray()Details
Type
n/a
Inherited_from
\Cezpdf::$$ezPages  
Propertypublic  $fileIdentifier= ''''
inherited

the file identifier, used to uniquely identify a pdf document

Inherited from: \Cpdf::$$fileIdentifier\Cezpdf::$$fileIdentifier
Default value''Details
Type
n/a
Inherited_from
\Cpdf::$$fileIdentifier  
Inherited_from
\Cezpdf::$$fileIdentifier  
Propertypublic  $firstPageId= ''
inherited

the objectId of the first page of the document

Inherited from: \Cpdf::$$firstPageId\Cezpdf::$$firstPageId
Details
Type
n/a
Inherited_from
\Cpdf::$$firstPageId  
Inherited_from
\Cezpdf::$$firstPageId  
Propertypublic  $fontFamilies= 'array()'
inherited

store the information about the relationship between font families this used so that the code knows which font is the bold version of another font, etc.

Inherited from: \Cpdf::$$fontFamilies\Cezpdf::$$fontFamilies

the value of this array is initialised in the constuctor function.

Default valuearray()Details
Type
n/a
Inherited_from
\Cpdf::$$fontFamilies  
Inherited_from
\Cezpdf::$$fontFamilies  
Propertypublic  $fonts= 'array()'
inherited

array carrying information about the fonts that the system currently knows about used to ensure that a font is not loaded twice, among other things

Inherited from: \Cpdf::$$fonts\Cezpdf::$$fonts
Default valuearray()Details
Type
n/a
Inherited_from
\Cpdf::$$fonts  
Inherited_from
\Cezpdf::$$fonts  
Propertypublic  $infoObject= '0'
inherited

the objectId of the information object for the document this contains authorship, title etc.

Inherited from: \Cpdf::$$infoObject\Cezpdf::$$infoObject
Default value0Details
Type
n/a
Inherited_from
\Cpdf::$$infoObject  
Inherited_from
\Cezpdf::$$infoObject  
Propertypublic  $looseObjects= 'array()'
inherited

an array which contains information about the objects which are not firmly attached to pages these have been added with the addObject function

Inherited from: \Cpdf::$$looseObjects\Cezpdf::$$looseObjects
Default valuearray()Details
Type
n/a
Inherited_from
\Cpdf::$$looseObjects  
Inherited_from
\Cezpdf::$$looseObjects  
Propertypublic  $messages= ''''
inherited

messages are stored here during processing, these can be selected afterwards to give some useful debug information

Inherited from: \Cpdf::$$messages\Cezpdf::$$messages
Default value''Details
Type
n/a
Inherited_from
\Cpdf::$$messages  
Inherited_from
\Cezpdf::$$messages  
Propertypublic  $nCallback= '0'
inherited

the number of callback functions in the callback array

Inherited from: \Cpdf::$$nCallback\Cezpdf::$$nCallback
Default value0Details
Type
n/a
Inherited_from
\Cpdf::$$nCallback  
Inherited_from
\Cezpdf::$$nCallback  
Propertypublic  $nStack= '0'
inherited

number of elements within the object Id storage stack

Inherited from: \Cpdf::$$nStack\Cezpdf::$$nStack
Default value0Details
Type
n/a
Inherited_from
\Cpdf::$$nStack  
Inherited_from
\Cezpdf::$$nStack  
Propertypublic  $nStateStack= '0'
inherited

number of elements within the state stack

Inherited from: \Cpdf::$$nStateStack\Cezpdf::$$nStateStack
Default value0Details
Type
n/a
Inherited_from
\Cpdf::$$nStateStack  
Inherited_from
\Cezpdf::$$nStateStack  
Propertypublic  $numFonts= '0'
inherited

number of fonts within the system

Inherited from: \Cpdf::$$numFonts\Cezpdf::$$numFonts
Default value0Details
Type
n/a
Inherited_from
\Cpdf::$$numFonts  
Inherited_from
\Cezpdf::$$numFonts  
Propertypublic  $numImages= '0'
inherited

number of images being tracked within the document

Inherited from: \Cpdf::$$numImages\Cezpdf::$$numImages
Default value0Details
Type
n/a
Inherited_from
\Cpdf::$$numImages  
Inherited_from
\Cezpdf::$$numImages  
Propertypublic  $numObj= '0'
inherited

the current number of pdf objects in the document

Inherited from: \Cpdf::$$numObj\Cezpdf::$$numObj
Default value0Details
Type
n/a
Inherited_from
\Cpdf::$$numObj  
Inherited_from
\Cezpdf::$$numObj  
Propertypublic  $numPages= '0'
inherited

number of page objects within the document

Inherited from: \Cpdf::$$numPages\Cezpdf::$$numPages
Default value0Details
Type
n/a
Inherited_from
\Cpdf::$$numPages  
Inherited_from
\Cezpdf::$$numPages  
Propertypublic  $objects= 'array()'
inherited

this array contains all of the pdf objects, ready for final assembly

Inherited from: \Cpdf::$$objects\Cezpdf::$$objects
Default valuearray()Details
Type
n/a
Inherited_from
\Cpdf::$$objects  
Inherited_from
\Cezpdf::$$objects  
Propertypublic  $options= 'array( 'compression' => 1 )'
inherited

an array containing options about the document it defaults to turning on the compression of the objects

Inherited from: \Cpdf::$$options\Cezpdf::$$options
Default valuearray( 'compression' => 1 )Details
Type
n/a
Inherited_from
\Cpdf::$$options  
Inherited_from
\Cezpdf::$$options  
Propertypublic  $procsetObjectId= ''
inherited

the object Id of the procset object

Inherited from: \Cpdf::$$procsetObjectId\Cezpdf::$$procsetObjectId
Details
Type
n/a
Inherited_from
\Cpdf::$$procsetObjectId  
Inherited_from
\Cezpdf::$$procsetObjectId  
Propertypublic  $stack= 'array()'
inherited

object Id storage stack

Inherited from: \Cpdf::$$stack\Cezpdf::$$stack
Default valuearray()Details
Type
n/a
Inherited_from
\Cpdf::$$stack  
Inherited_from
\Cezpdf::$$stack  
Propertypublic  $stateStack= 'array()'
inherited

an array which is used to save the state of the document, mainly the colours and styles it is used to temporarily change to another state, the change back to what it was before

Inherited from: \Cpdf::$$stateStack\Cezpdf::$$stateStack
Default valuearray()Details
Type
n/a
Inherited_from
\Cpdf::$$stateStack  
Inherited_from
\Cezpdf::$$stateStack  
Propertypublic  $textStateStack= 'array( '' )'
Default valuearray( '' )Details
Type
n/a
Inherited_from
\Cpdf::$$textStateStack  
Inherited_from
\Cezpdf::$$textStateStack  
Propertypublic  $wordSpaceAdjust= '0'
inherited

used to track the last used value of the inter-word spacing, this is so that it is known when the spacing is changed.

Inherited from: \Cpdf::$$wordSpaceAdjust\Cezpdf::$$wordSpaceAdjust
Default value0Details
Type
n/a
Inherited_from
\Cpdf::$$wordSpaceAdjust  
Inherited_from
\Cezpdf::$$wordSpaceAdjust  
Propertypublic  $y= ''
inheritedInherited from: \Cezpdf::$$y
Details
Type
n/a
Inherited_from
\Cezpdf::$$y  

Methods

methodpublicARC4(  $text ) : void
inherited

ARC4 encrypt a text string

Inherited from: \Cpdf::ARC4()\Cezpdf::ARC4()
Parameters
Name Type Description
$text
methodpublicARC4_init(  $key = '' ) : void
inherited

initialize the ARC4 encryption

Inherited from: \Cpdf::ARC4_init()\Cezpdf::ARC4_init()
Parameters
Name Type Description
$key
methodpublicCezpdf(  $paper = 'a4',  $orientation = 'portrait' ) : void
inherited

Inherited from: \Cezpdf::Cezpdf()
Parameters
Name Type Description
$paper
$orientation
methodpublicCpdf(  $pageSize = array( 0, 0, 612, 792 ) ) : void
inherited

class constructor this will start a new document

Inherited from: \Cpdf::Cpdf()\Cezpdf::Cpdf()
Parameters
Name Type Description
$pageSize
Details
array
array of 4 numbers, defining the bottom left and upper right corner of the page. first two are normally zero.
methodpublicPRVT_getBytes(  $data,  $pos,  $num ) : void
inherited

extract an integer from a position in a byte stream

Inherited from: \Cpdf::PRVT_getBytes()\Cezpdf::PRVT_getBytes()
Parameters
Name Type Description
$data
$pos
$num
Details
Access
private  
methodpublicPRVTadjustWrapText(  $text,  $actual,  $width,  $x,  $adjust,  $justification ) : void
inherited

do a part of the calculation for sorting out the justification of the text

Inherited from: \Cpdf::PRVTadjustWrapText()\Cezpdf::PRVTadjustWrapText()
Parameters
Name Type Description
$text
$actual
$width
$x
$adjust
$justification
Details
Access
private  
methodpublicPRVTcheckTextDirective(  $text,  $i,  $f,  $final = 0 ) : void
inherited

wrapper function for PRVTcheckTextDirective1

Inherited from: \Cpdf::PRVTcheckTextDirective()\Cezpdf::PRVTcheckTextDirective()
Parameters
Name Type Description
$text
$i
$f
$final
Details
Access
private  
methodpublicPRVTcheckTextDirective1(  $text,  $i,  $f,  $final,  $x,  $y,  $size = 0,  $angle = 0,  $wordSpaceAdjust = 0 ) : void
inherited

checks if the text stream contains a control directive if so then makes some changes and returns the number of characters involved in the directive this has been re-worked to include everything neccesary to fins the current writing point, so that the location can be sent to the callback function if required if the directive does not require a font change, then $f should be set to 0

Inherited from: \Cpdf::PRVTcheckTextDirective1()\Cezpdf::PRVTcheckTextDirective1()
Parameters
Name Type Description
$text
$i
$f
$final
$x
$y
$size
$angle
$wordSpaceAdjust
Details
Access
private  
methodpublicPRVTgetTextPosition(  $x,  $y,  $angle,  $size,  $wa,  $text ) : void
inherited

given a start position and information about how text is to be laid out, calculate where on the page the text will end

Inherited from: \Cpdf::PRVTgetTextPosition()\Cezpdf::PRVTgetTextPosition()
Parameters
Name Type Description
$x
$y
$angle
$size
$wa
$text
Details
Access
private  
methodpublicaddContent(  $content ) : void
inherited

add content to the currently active object

Inherited from: \Cpdf::addContent()\Cezpdf::addContent()
Parameters
Name Type Description
$content
Details
Access
private  
methodpublicaddDestination(  $label,  $style,  $a = 0,  $b = 0,  $c = 0 ) : void
inherited

create a labelled destination within the document

Inherited from: \Cpdf::addDestination()\Cezpdf::addDestination()
Parameters
Name Type Description
$label
$style
$a
$b
$c
methodpublicaddDocSpecFunction(  $functionName,  $parameters ) : void

Function for adding function to doc specification

param - text to add

Parameters
Name Type Description
$functionName
$parameters
methodpublicaddDocSpecification(  $text ) : void

Function for adding text to doc specification

param - text to add

Parameters
Name Type Description
$text
methodpublicaddImage(  $img,  $x,  $y,  $w = 0,  $h = 0,  $quality = 75 ) : void
inherited

add an image into the document, from a GD object this function is not all that reliable, and I would probably encourage people to use the file based functions

Inherited from: \Cpdf::addImage()\Cezpdf::addImage()
Parameters
Name Type Description
$img
$x
$y
$w
$h
$quality
methodpublicaddInfo(  $label,  $value = 0 ) : void
inherited

add content to the documents info object

Inherited from: \Cpdf::addInfo()\Cezpdf::addInfo()
Parameters
Name Type Description
$label
$value
methodpublicaddInternalLink(  $label,  $x0,  $y0,  $x1,  $y1 ) : void
inherited

add a link in the document to an internal destination (ie. within the document)

Inherited from: \Cpdf::addInternalLink()\Cezpdf::addInternalLink()
Parameters
Name Type Description
$label
$x0
$y0
$x1
$y1
methodpublicaddJpegFromFile(  $img,  $x,  $y,  $w = 0,  $h = 0 ) : void
inherited

add a JPEG image into the document, from a file

Inherited from: \Cpdf::addJpegFromFile()\Cezpdf::addJpegFromFile()
Parameters
Name Type Description
$img
$x
$y
$w
$h
methodpublicaddJpegImage_common(  $data,  $x,  $y,  $w = 0,  $h = 0,  $imageWidth,  $imageHeight,  $channels = 3 ) : void
inherited

common code used by the two JPEG adding functions

Inherited from: \Cpdf::addJpegImage_common()\Cezpdf::addJpegImage_common()
Parameters
Name Type Description
$data
$x
$y
$w
$h
$imageWidth
$imageHeight
$channels
Details
Access
private  
methodpublicaddLink(  $url,  $x0,  $y0,  $x1,  $y1 ) : void
inherited

add a link in the document to an external URL

Inherited from: \Cpdf::addLink()\Cezpdf::addLink()
Parameters
Name Type Description
$url
$x0
$y0
$x1
$y1
methodpublicaddMessage(  $message ) : void
inherited

used to add messages for use in debugging

Inherited from: \Cpdf::addMessage()\Cezpdf::addMessage()
Parameters
Name Type Description
$message
methodpublicaddObject(  $id,  $options = 'add' ) : void
inherited

after an object has been created, it wil only show if it has been added, using this function.

Inherited from: \Cpdf::addObject()\Cezpdf::addObject()
Parameters
Name Type Description
$id
$options
methodpublicaddPngFromFile(  $file,  $x,  $y,  $w = 0,  $h = 0 ) : void
inherited

add a PNG image into the document, from a file this should work with remote files

Inherited from: \Cpdf::addPngFromFile()\Cezpdf::addPngFromFile()

\return true if adding image succeded

Parameters
Name Type Description
$file
$x
$y
$w
$h
methodpublicaddText(  $x,  $y,  $size,  $text,  $angle = 0,  $wordSpaceAdjust = 0 ) : void
inherited

add text to the document, at a specified location, size and angle on the page

Inherited from: \Cpdf::addText()\Cezpdf::addText()

\return array( 'height' => )

Parameters
Name Type Description
$x
$y
$size
$text
$angle
$wordSpaceAdjust
methodpublicaddTextWrap(  $x,  $y,  $width,  $size,  $text,  $justification = 'left',  $angle = 0,  $test = 0 ) : void
inherited

add text to the page, but ensure that it fits within a certain width if it does not fit then put in as much as possible, splitting at word boundaries and return the remainder.

Inherited from: \Cpdf::addTextWrap()\Cezpdf::addTextWrap()

justification and angle can also be specified for the text

return array ('text' => , 'width' => , 'height' => )

Parameters
Name Type Description
$x
$y
$width
$size
$text
$justification
$angle
$test
methodpublicaddToPreStack(  $options = array() ) : void

function for adding font specification to PreStack array

Possible $options setting: - justification - fontSize - fontName

Parameters
Name Type Description
$options
methodpublicalink(  $info,  $internal = 0 ) : void
inherited

Inherited from: \Cezpdf::alink()
Parameters
Name Type Description
$info
$internal
methodpubliccallAnchor(  $info ) : void

Callback function to set anchor

Parameters
Name Type Description
$info
methodpubliccallBlockFrame(  $params,  $text ) : void

Parameters
Name Type Description
$params
$text
methodpubliccallCircle(  $info ) : void

Parameters
Name Type Description
$info
methodpubliccallDrawLine(  $info ) : void

Parameters
Name Type Description
$info
methodpubliccallFilledRectangle(  $info ) : void

Parameters
Name Type Description
$info
methodpubliccallFont(  $params ) : void

Callback function to set font

Parameters
Name Type Description
$params
methodpubliccallFrame(  $params,  $text ) : void

Parameters
Name Type Description
$params
$text
methodpubliccallFrameLine(  $info ) : void

Parameters
Name Type Description
$info
methodpubliccallFrameMargins(  $info ) : void

Parameters
Name Type Description
$info
methodpubliccallFrontpage(  $params,  $text ) : void

Parameters
Name Type Description
$params
$text
methodpubliccallHeader(  $params ) : void

Callback function to set header

Parameters
Name Type Description
$params
methodpubliccallImage(  $info ) : void

Function for insert image

Parameters
Name Type Description
$info
methodpubliccallIndex(  $info ) : void

Parameters
Name Type Description
$info
methodpubliccallInsertTOC(  $info ) : void

function for inserting TOC

Parameters
Name Type Description
$info
methodpubliccallKeyword(  $info ) : void

function for inserting keyword

Parameters
Name Type Description
$info
methodpubliccallLine(  $params,  $text ) : void

Parameters
Name Type Description
$params
$text
methodpubliccallNewPage(  $info ) : void

Callback function for creating new page

Parameters
Name Type Description
$info
methodpubliccallRectangle(  $info ) : void

Parameters
Name Type Description
$info
methodpubliccallSetMargin(  $info ) : void

Parameters
Name Type Description
$info
methodpubliccallStartPageCounter(  $info ) : void

Parameters
Name Type Description
$info
methodpubliccallTOC(  $info ) : void

Callback function for inserting TOC

Parameters
Name Type Description
$info
methodpubliccallTable(  $params,  $text ) : void

Parameters
Name Type Description
$params
$text
methodpubliccallText(  $params ) : void

Callback function for adding text

Parameters
Name Type Description
$params
methodpubliccallTextBox(  $params,  $text ) : void

Parameters
Name Type Description
$params
$text
methodpubliccallTextFrame(  $params,  $text ) : void

Parameters
Name Type Description
$params
$text
methodpubliccheckAllHere( ) : void
inherited

should be used for internal checks, not implemented as yet

Inherited from: \Cpdf::checkAllHere()\Cezpdf::checkAllHere()
methodpubliccloseObject( ) : void
inherited

close an object

Inherited from: \Cpdf::closeObject()\Cezpdf::closeObject()
methodpubliccompareCMYK(  $cmykArray1,  $cmykArray2 ) : void
inherited

Inherited from: \Cpdf::compareCMYK()\Cezpdf::compareCMYK()
Parameters
Name Type Description
$cmykArray1
$cmykArray2
methodpubliccurrentFont( ) : void
inherited

Get current font

Inherited from: \Cpdf::currentFont()\Cezpdf::currentFont()

\return current font name

methodpubliccurve(  $x0,  $y0,  $x1,  $y1,  $x2,  $y2,  $x3,  $y3 ) : void
inherited

draw a bezier curve based on 4 control points

Inherited from: \Cpdf::curve()\Cezpdf::curve()
Parameters
Name Type Description
$x0
$y0
$x1
$y1
$x2
$y2
$x3
$y3
methodpublicdots(  $info ) : void

Parameters
Name Type Description
$info
methodpubliceZCalculateColumnWidth(  $columnWidthArray,  $options,  $marginWidth,  $minWidthArray,  $totalWidth,  $fixedSizeArray = array() ) : void

Parameters
Name Type Description
$columnWidthArray
$options
$marginWidth
$minWidthArray
$totalWidth
$fixedSizeArray
methodpubliceZGetMaxWordWidth(  $size,  $text ) : void
inherited

Inherited from: \Cezpdf::eZGetMaxWordWidth()
Parameters
Name Type Description
$size
$text
methodpubliceZPDFTable(  $paper = 'a4',  $orientation = 'portrait' ) : void

Constructor. This class is only used to encapsulate a table.

Parameters
Name Type Description
$paper
$orientation
methodpublicellipse(  $x0,  $y0,  $r1,  $r2 = 0,  $angle = 0,  $nSeg = 8,  $astart = 0,  $afinish = 360,  $close = 1,  $fill = 0 ) : void
inherited

draw an ellipse note that the part and filled ellipse are just special cases of this function

Inherited from: \Cpdf::ellipse()\Cezpdf::ellipse()

draws an ellipse in the current line style centered at $x0,$y0, radii $r1,$r2 if $r2 is not set, then a circle is drawn nSeg is not allowed to be less than 2, as this will simply draw a line (and will even draw a pretty crappy shape at 2, as we are approximating with bezier curves.

Parameters
Name Type Description
$x0
$y0
$r1
$r2
$angle
$nSeg
$astart
$afinish
$close
$fill
methodpublicencryptInit(  $id ) : void
inherited

initialize the encryption for processing a particular object

Inherited from: \Cpdf::encryptInit()\Cezpdf::encryptInit()
Parameters
Name Type Description
$id
methodpublicexecTemplate(  $id,  $data = array(),  $options = array() ) : void
inherited

Inherited from: \Cezpdf::execTemplate()
Parameters
Name Type Description
$id
$data
$options
methodpublicextractFunction(  $text,  $offSet,  $functionName,  $parameters,  $type = 'ezCall' ) : void

Function for extracting function name and parameters from text.

\param text \param offset \param function name (reference) \param parameters array (reference)

\return end offset of function

Parameters
Name Type Description
$text
$offSet
$functionName
$parameters
$type
methodpublicextractParameters(  $text,  $offSet,  $parameters,  $skipFirstChar = false ) : void

Function for extracting parameters from : separated key:value list callback functions

\param text \param offset \param parameters array (reference)

\return end offset of function

Parameters
Name Type Description
$text
$offSet
$parameters
$skipFirstChar
methodpublicezColumnsStart(  $options = array() ) : void
inherited

Inherited from: \Cezpdf::ezColumnsStart()
Parameters
Name Type Description
$options
methodpublicezColumnsStop( ) : void
inherited

Inherited from: \Cezpdf::ezColumnsStop()
methodpublicezGetCurrentPageNumber( ) : void
inherited

Inherited from: \Cezpdf::ezGetCurrentPageNumber()
methodpublicezImage(  $image,  $pad = 5,  $width = 0,  $resize = 'full',  $just = 'center',  $border = '' ) : void
inherited

Inherited from: \Cezpdf::ezImage()
Parameters
Name Type Description
$image
$pad
$width
$resize
$just
$border
methodpublicezInsertBlockFrame(  $text,  $textParameters ) : void

Parameters
Name Type Description
$text
$textParameters
methodpublicezInsertFrame(  $text,  $textParameters ) : void

Parameters
Name Type Description
$text
$textParameters
methodpublicezInsertLine(  $params ) : void

Parameters
Name Type Description
$params
methodpublicezInsertMode(  $status = 1,  $pageNum = 1,  $pos = 'before' ) : void
inherited

Inherited from: \Cezpdf::ezInsertMode()
Parameters
Name Type Description
$status
$pageNum
$pos
methodpublicezNewPage( ) : void
inherited

Inherited from: \Cezpdf::ezNewPage()
methodpublicezOutput(  $options = 0 ) : void
inherited

Inherited from: \Cezpdf::ezOutput()
Parameters
Name Type Description
$options
methodpublicezPRVTaddPageNumbers( ) : void
inherited

Inherited from: \Cezpdf::ezPRVTaddPageNumbers()
methodpublicezPRVTcleanUp( ) : void
inherited

Inherited from: \Cezpdf::ezPRVTcleanUp()
methodpublicezPRVTpageNumberSearch(  $lbl,  $tmp ) : void
inherited

Inherited from: \Cezpdf::ezPRVTpageNumberSearch()
Parameters
Name Type Description
$lbl
$tmp
methodpublicezProcessText(  $text ) : void
inherited

Inherited from: \Cezpdf::ezProcessText()
Parameters
Name Type Description
$text
methodpublicezPrvtGetTextWidth(  $size,  $text ) : void
inherited

Inherited from: \Cezpdf::ezPrvtGetTextWidth()
Parameters
Name Type Description
$size
$text
methodpublicezPrvtTableColumnHeadings(  $cols,  $pos,  $maxWidth,  $height,  $decender,  $gap,  $size,  $y,  $optionsAll = array() ) : void
inherited

Inherited from: \Cezpdf::ezPrvtTableColumnHeadings()
Parameters
Name Type Description
$cols
$pos
$maxWidth
$height
$decender
$gap
$size
$y
$optionsAll
methodpublicezPrvtTableDrawLines(  $pos,  $gap,  $x0,  $x1,  $y0,  $y1,  $y2,  $col,  $inner,  $outer,  $opt = 1 ) : void

Parameters
Name Type Description
$pos
$gap
$x0
$x1
$y0
$y1
$y2
$col
$inner
$outer
$opt
methodpublicezSetCmMargins(  $top,  $bottom,  $left,  $right ) : void
inherited

Inherited from: \Cezpdf::ezSetCmMargins()
Parameters
Name Type Description
$top
$bottom
$left
$right
methodpublicezSetDy(  $dy,  $mod = '' ) : void
inherited

Inherited from: \Cezpdf::ezSetDy()
Parameters
Name Type Description
$dy
$mod
methodpublicezSetMargins(  $top,  $bottom,  $left,  $right ) : void
inherited

Inherited from: \Cezpdf::ezSetMargins()
Parameters
Name Type Description
$top
$bottom
$left
$right
methodpublicezSetY(  $y ) : void
inherited

Inherited from: \Cezpdf::ezSetY()
Parameters
Name Type Description
$y
methodpublicezShadedRectangle(  $x1,  $y1,  $width,  $height,  $col1,  $col2,  $direction = 'vertical' ) : void
inherited

Draw a shaded rectangle

Inherited from: \Cezpdf::ezShadedRectangle()

direction is optional and set to vertical by default

\param x1 \param y1 \param width \param height \param col1 \param col2 \param direction ('vertical', 'horizontal', or angle)

Parameters
Name Type Description
$x1
$y1
$width
$height
$col1
$col2
$direction
methodpublicezStartPageNumbers(  $x,  $y,  $size,  $pos = 'left',  $pattern = '{PAGENUM} of {TOTALPAGENUM}',  $num = '' ) : void
inherited

Inherited from: \Cezpdf::ezStartPageNumbers()
Parameters
Name Type Description
$x
$y
$size
$pos
$pattern
$num
methodpublicezStopPageNumbers(  $stopTotal = 0,  $next = 0,  $i = 0 ) : void
inherited

Inherited from: \Cezpdf::ezStopPageNumbers()
Parameters
Name Type Description
$stopTotal
$next
$i
methodpublicezStream(  $options = '' ) : void
inherited

Inherited from: \Cezpdf::ezStream()
Parameters
Name Type Description
$options
methodpublicezTable(  $data,  $cols = '',  $title = '',  $options = '' ) : void

Parameters
Name Type Description
$data
$cols
$title
$options
methodpublicezText(  $text,  $size = 0,  $options = array(),  $test = 0 ) : void

Function overriding the default ezText function for doing preprocessing of text

Parameters
Name Type Description
$text
$size
$options
$test
methodpublicezWhatPageNumber(  $pageNum,  $identifier = false ) : void

Parameters
Name Type Description
$pageNum
$identifier
methodpublicfilledEllipse(  $x0,  $y0,  $r1,  $r2 = 0,  $angle = 0,  $nSeg = 8,  $astart = 0,  $afinish = 360 ) : void
inherited

draw a filled ellipse

Inherited from: \Cpdf::filledEllipse()\Cezpdf::filledEllipse()
Parameters
Name Type Description
$x0
$y0
$r1
$r2
$angle
$nSeg
$astart
$afinish
methodpublicfilledRectangle(  $x1,  $y1,  $width,  $height ) : void
inherited

a filled rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not the coordinates of the upper-right corner

Inherited from: \Cpdf::filledRectangle()\Cezpdf::filledRectangle()
Parameters
Name Type Description
$x1
$y1
$width
$height
methodpublicfilterText(  $text ) : void
inherited

filter the text, this is applied to all text just before being inserted into the pdf document it escapes the various things that need to be escaped, and so on

Inherited from: \Cpdf::filterText()\Cezpdf::filterText()
Parameters
Name Type Description
$text
Details
Access
private  
methodpublicfixWhitespace(  $text ) : void

Parameters
Name Type Description
$text
methodpublicfixupTableCellText(  $text ) : void

Parameters
Name Type Description
$text
methodpublicfontSize( ) : void
inherited

Inherited from: \Cezpdf::fontSize()
methodpublicgetFirstPageId( ) : void
inherited

function for the user to find out what the ID is of the first page that was created during startup - useful if they wish to add something to it later.

Inherited from: \Cpdf::getFirstPageId()\Cezpdf::getFirstPageId()
methodpublicgetFontDecender(  $size = false ) : void
inherited

return the font decender, this will normally return a negative number if you add this number to the baseline, you get the level of the bottom of the font it is in the pdf user units

Inherited from: \Cpdf::getFontDecender()\Cezpdf::getFontDecender()
Parameters
Name Type Description
$size
methodpublicgetFontHeight(  $size = false ) : void
inherited

return the height in units of the current font in the given size

Inherited from: \Cpdf::getFontHeight()\Cezpdf::getFontHeight()
Parameters
Name Type Description
$size
methodpublicgetTextWidth(  $size,  $text ) : void
inherited

calculate how wide a given text string will be on a page, at a given size.

Inherited from: \Cpdf::getTextWidth()\Cezpdf::getTextWidth()

this can be called externally, but is alse used by the other class functions

Parameters
Name Type Description
$size
$text
methodpublicheaderIndex(  $page,  $level ) : void

Parameters
Name Type Description
$page
$level
methodpublicheaderLabel(  $page,  $level ) : void

Parameters
Name Type Description
$page
$level
methodpublicilink(  $info ) : void
inherited

Inherited from: \Cezpdf::ilink()
Parameters
Name Type Description
$info
methodpublicinitFrameMargins( ) : void

methodpublicinsertFrontpage(  $params,  $text ) : void

Parameters
Name Type Description
$params
$text
methodpublicinsertTOC(  $sizeArray = array( 20, 18, 16, 14, 12 ),  $indentArray = array( 0, 4, 6, 8, 10 ),  $dots = true,  $contentText = '',  $level = 3 ) : void

Parameters
Name Type Description
$sizeArray
$indentArray
$dots
$contentText
$level
methodpublicinsertTextBox(  $params,  $text ) : void

Parameters
Name Type Description
$params
$text
methodpublicinsertTextFrame(  $params,  $text ) : void

Parameters
Name Type Description
$params
$text
methodpublicjustification( ) : void
inherited

Inherited from: \Cezpdf::justification()
methodpublicleftMargin(  $yOffset = false ) : void
inherited

Inherited from: \Cezpdf::leftMargin()
Parameters
Name Type Description
$yOffset
methodpublicline(  $x1,  $y1,  $x2,  $y2 ) : void
inherited

draw a line from one set of coordinates to another

Inherited from: \Cpdf::line()\Cezpdf::line()
Parameters
Name Type Description
$x1
$y1
$x2
$y2
methodpubliclineHeight(  $options = array() ) : void
inherited

Get current line height

Inherited from: \Cezpdf::lineHeight()
Parameters
Name Type Description
$options
methodpublicloadTemplate(  $templateFile ) : void
inherited

Inherited from: \Cezpdf::loadTemplate()
Parameters
Name Type Description
$templateFile
methodpublicmd5_16(  $string ) : void
inherited

calculate the 16 byte version of the 128 bit md5 digest of the string

Inherited from: \Cpdf::md5_16()\Cezpdf::md5_16()
Parameters
Name Type Description
$string
methodpublicnewDocument(  $pageSize = array(0,0,612,792) ) : void
inherited

intialize a new document if this is called on an existing document results may be unpredictable, but the existing document would be lost at minimum this function is called automatically by the constructor function

Inherited from: \Cpdf::newDocument()\Cezpdf::newDocument()
Parameters
Name Type Description
$pageSize
Details
Access
private  
methodpublicnewPage(  $insert = 0,  $id = 0,  $pos = 'after' ) : void
inherited

add a new page to the document this also makes the new page the current active object

Inherited from: \Cpdf::newPage()\Cezpdf::newPage()
Parameters
Name Type Description
$insert
$id
$pos
methodpublico_action(  $id,  $action,  $options = '' ) : void
inherited

an action object, used to link to URLS initially

Inherited from: \Cpdf::o_action()\Cezpdf::o_action()
Parameters
Name Type Description
$id
$action
$options
methodpublico_annotation(  $id,  $action,  $options = '' ) : void
inherited

an annotation object, this will add an annotation to the current page.

Inherited from: \Cpdf::o_annotation()\Cezpdf::o_annotation()

initially will support just link annotations

Parameters
Name Type Description
$id
$action
$options
methodpublico_catalog(  $id,  $action,  $options = '' ) : void
inherited

define the document catalog, the overall controller for the document

Inherited from: \Cpdf::o_catalog()\Cezpdf::o_catalog()
Parameters
Name Type Description
$id
$action
$options
methodpublico_contents(  $id,  $action,  $options = '' ) : void
inherited

the contents objects hold all of the content which appears on pages

Inherited from: \Cpdf::o_contents()\Cezpdf::o_contents()
Parameters
Name Type Description
$id
$action
$options
methodpublico_destination(  $id,  $action,  $options = '' ) : void
inherited

destination object, used to specify the location for the user to jump to, presently on opening

Inherited from: \Cpdf::o_destination()\Cezpdf::o_destination()
Parameters
Name Type Description
$id
$action
$options
methodpublico_encryption(  $id,  $action,  $options = '' ) : void
inherited

encryption object.

Inherited from: \Cpdf::o_encryption()\Cezpdf::o_encryption()
Parameters
Name Type Description
$id
$action
$options
methodpublico_font(  $id,  $action,  $options = '' ) : void
inherited

an object to hold the font description

Inherited from: \Cpdf::o_font()\Cezpdf::o_font()
Parameters
Name Type Description
$id
$action
$options
methodpublico_fontDescriptor(  $id,  $action,  $options = '' ) : void
inherited

a font descriptor, needed for including additional fonts

Inherited from: \Cpdf::o_fontDescriptor()\Cezpdf::o_fontDescriptor()
Parameters
Name Type Description
$id
$action
$options
methodpublico_fontEncoding(  $id,  $action,  $options = '' ) : void
inherited

the font encoding

Inherited from: \Cpdf::o_fontEncoding()\Cezpdf::o_fontEncoding()
Parameters
Name Type Description
$id
$action
$options
methodpublico_function(  $id,  $action,  $options = '' ) : void
inherited

Add object to hold Function properties Only partial support for type 0, 3 and 4

Inherited from: \Cpdf::o_function()\Cezpdf::o_function()

\param object id. \param action \param options

Parameters
Name Type Description
$id
$action
$options
methodpublico_image(  $id,  $action,  $options = '' ) : void
inherited

an image object, will be an XObject in the document, includes description and data

Inherited from: \Cpdf::o_image()\Cezpdf::o_image()
Parameters
Name Type Description
$id
$action
$options
methodpublico_info(  $id,  $action,  $options = '' ) : void
inherited

define the document information

Inherited from: \Cpdf::o_info()\Cezpdf::o_info()
Parameters
Name Type Description
$id
$action
$options
methodpublico_outlines(  $id,  $action,  $options = '' ) : void
inherited

define the outlines in the doc, empty for now

Inherited from: \Cpdf::o_outlines()\Cezpdf::o_outlines()
Parameters
Name Type Description
$id
$action
$options
methodpublico_page(  $id,  $action,  $options = '' ) : void
inherited

a page object, it also creates a contents object to hold its contents

Inherited from: \Cpdf::o_page()\Cezpdf::o_page()
Parameters
Name Type Description
$id
$action
$options
methodpublico_pages(  $id,  $action,  $options = '' ) : void
inherited

object which is a parent to the pages in the document

Inherited from: \Cpdf::o_pages()\Cezpdf::o_pages()
Parameters
Name Type Description
$id
$action
$options
methodpublico_pattern(  $id,  $action,  $options = '' ) : void
inherited

Add object to hold pattern properties

Inherited from: \Cpdf::o_pattern()\Cezpdf::o_pattern()

\param object id. \param action \param options

\return action 'new' - dictionary name 'out' - pdf output

Parameters
Name Type Description
$id
$action
$options
methodpublico_procset(  $id,  $action,  $options = '' ) : void
inherited

the document procset, solves some problems with printing to old PS printers

Inherited from: \Cpdf::o_procset()\Cezpdf::o_procset()
Parameters
Name Type Description
$id
$action
$options
methodpublico_shading(  $id,  $action,  $options = '' ) : void
inherited

Add object to hold shading properties

Inherited from: \Cpdf::o_shading()\Cezpdf::o_shading()

\param object id. \param action \param options

\return action 'new' - dictionary name 'out' - pdf output

Parameters
Name Type Description
$id
$action
$options
methodpublico_viewerPreferences(  $id,  $action,  $options = '' ) : void
inherited

set the viewer preferences

Inherited from: \Cpdf::o_viewerPreferences()\Cezpdf::o_viewerPreferences()
Parameters
Name Type Description
$id
$action
$options
methodpublicopenFont(  $font ) : void
inherited

open the font file and return a php structure containing it.

Inherited from: \Cpdf::openFont()\Cezpdf::openFont()

first check if this one has been done before and saved in a form more suited to php note that if a php serialized version does not exist it will try and make one, but will require write access to the directory to do it... it is MUCH faster to have these serialized files.

Parameters
Name Type Description
$font
Details
Access
private  
methodpublicopenHere(  $style,  $a = 0,  $b = 0,  $c = 0 ) : void
inherited

specify where the document should open when it first starts

Inherited from: \Cpdf::openHere()\Cezpdf::openHere()
Parameters
Name Type Description
$style
$a
$b
$c
methodpublicopenObject( ) : void
inherited

make a loose object, the output will go into this object, until it is closed, then will revert to the current one.

Inherited from: \Cpdf::openObject()\Cezpdf::openObject()

this object will not appear until it is included within a page. the function will return the object number

methodpublicoutput(  $debug = 0 ) : void
inherited

return the pdf stream as a string returned from the function

Inherited from: \Cpdf::output()\Cezpdf::output()
Parameters
Name Type Description
$debug
methodpublicoutputDocSpecification( ) : void

Loop through all document specification settings and print specified text

\return new Y offset

methodpublicpartEllipse(  $x0,  $y0,  $astart,  $afinish,  $r1,  $r2 = 0,  $angle = 0,  $nSeg = 8 ) : void
inherited

draw a part of an ellipse

Inherited from: \Cpdf::partEllipse()\Cezpdf::partEllipse()
Parameters
Name Type Description
$x0
$y0
$astart
$afinish
$r1
$r2
$angle
$nSeg
methodpublicpolygon(  $p,  $np,  $f = 0 ) : void
inherited

draw a polygon, the syntax for this is similar to the GD polygon command

Inherited from: \Cpdf::polygon()\Cezpdf::polygon()
Parameters
Name Type Description
$p
$np
$f
methodpublicpopStack( ) : void

methodpublicpopTextState( ) : void
methodpublicpushStack(  $continous = true ) : void

Parameters
Name Type Description
$continous
methodpublicpushTextState(  $newState ) : void
Parameters
Name Type Description
$newState
methodpublicrectangle(  $x1,  $y1,  $width,  $height ) : void
inherited

draw a rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not the coordinates of the upper-right corner

Inherited from: \Cpdf::rectangle()\Cezpdf::rectangle()
Parameters
Name Type Description
$x1
$y1
$width
$height
methodpublicreopenObject(  $id ) : void
inherited

open an existing object for editing

Inherited from: \Cpdf::reopenObject()\Cezpdf::reopenObject()
Parameters
Name Type Description
$id
methodpublicrestoreState(  $pageEnd = 0 ) : void
inherited

restore a previously saved state

Inherited from: \Cpdf::restoreState()\Cezpdf::restoreState()
Parameters
Name Type Description
$pageEnd
methodpublicrightMargin(  $yOffset = false ) : void
inherited

Inherited from: \Cezpdf::rightMargin()
Parameters
Name Type Description
$yOffset
methodpublicsaveState(  $pageEnd = 0 ) : void
inherited

this will be called at a new page to return the state to what it was on the end of the previous page, before the stack was closed down This is to get around not being able to have open 'q' across pages

Inherited from: \Cpdf::saveState()\Cezpdf::saveState()
Parameters
Name Type Description
$pageEnd
methodpublicselectFont(  $fontName,  $encoding = '',  $set = 1 ) : void
inherited

if the font is not loaded then load it and make the required object else just make it the current font the encoding array can contain 'encoding'=> 'none','WinAnsiEncoding','MacRomanEncoding' or 'MacExpertEncoding' note that encoding='none' will need to be used for symbolic fonts and 'differences' => an array of mappings between numbers 0->255 and character names.

Inherited from: \Cpdf::selectFont()\Cezpdf::selectFont()
Parameters
Name Type Description
$fontName
$encoding
$set
methodpublicsetColor(  $cmykArray,  $force = 0 ) : void
inherited

Inherited from: \Cpdf::setColor()\Cezpdf::setColor()
Parameters
Name Type Description
$cmykArray
$force
methodpublicsetColorRGB(  $r,  $g,  $b,  $force = 0 ) : void
inherited

sets the colour for fill operations

Inherited from: \Cpdf::setColorRGB()\Cezpdf::setColorRGB()
Parameters
Name Type Description
$r
$g
$b
$force
methodpublicsetCurrentFont( ) : void
inherited

sets up the current font, based on the font families, and the current text state note that this system is quite flexible, a font can be completely different to a font, and even will have to be defined within the family to have meaning This function is to be called whenever the currentTextState is changed, it will update the currentFont setting to whatever the appropriatte family one is.

Inherited from: \Cpdf::setCurrentFont()\Cezpdf::setCurrentFont()

If the user calls selectFont themselves then that will reset the currentBaseFont, and the currentFont This function will change the currentFont to whatever it should be, but will not change the currentBaseFont.

Details
Access
private  
methodpublicsetEncryption(  $userPass = '',  $ownerPass = '',  $pc = array() ) : void
inherited

set the encryption of the document can be used to turn it on and/or set the passwords which it will have.

Inherited from: \Cpdf::setEncryption()\Cezpdf::setEncryption()

also the functions that the user will have are set here, such as print, modify, add

Parameters
Name Type Description
$userPass
$ownerPass
$pc
methodpublicsetFontFamily(  $family,  $options = '' ) : void
inherited

define font families, this is used to initialize the font families for the default fonts and for the user to add new ones for their fonts. The default bahavious can be overridden should that be desired.

Inherited from: \Cpdf::setFontFamily()\Cezpdf::setFontFamily()
Parameters
Name Type Description
$family
$options
methodpublicsetFontSize(  $size ) : void
inherited

Inherited from: \Cezpdf::setFontSize()
Parameters
Name Type Description
$size
methodpublicsetJustification(  $align ) : void
inherited

Inherited from: \Cezpdf::setJustification()
Parameters
Name Type Description
$align
methodpublicsetLimitedLeftMargin(  $startY,  $stopY,  $leftMargin ) : void
inherited

Inherited from: \Cezpdf::setLimitedLeftMargin()
Parameters
Name Type Description
$startY
$stopY
$leftMargin
methodpublicsetLimitedRightMargin(  $startY,  $stopY,  $rightMargin ) : void
inherited

Inherited from: \Cezpdf::setLimitedRightMargin()
Parameters
Name Type Description
$startY
$stopY
$rightMargin
methodpublicsetLineStyle(  $width = 1,  $cap = '',  $join = '',  $dash = '',  $phase = 0 ) : void
inherited

this sets the line drawing style.

Inherited from: \Cpdf::setLineStyle()\Cezpdf::setLineStyle()

width, is the thickness of the line in user units cap is the type of cap to put on the line, values can be 'butt','round','square' where the diffference between 'square' and 'butt' is that 'square' projects a flat end past the end of the line. join can be 'miter', 'round', 'bevel' dash is an array which sets the dash pattern, is a series of length values, which are the lengths of the on and off dashes. (2) represents 2 on, 2 off, 2 on , 2 off ... (2,1) is 2 on, 1 off, 2 on, 1 off.. etc phase is a modifier on the dash pattern which is used to shift the point at which the pattern starts.

Parameters
Name Type Description
$width
$cap
$join
$dash
$phase
methodpublicsetPreferences(  $label,  $value = 0 ) : void
inherited

set the viewer preferences of the document, it is up to the browser to obey these.

Inherited from: \Cpdf::setPreferences()\Cezpdf::setPreferences()
Parameters
Name Type Description
$label
$value
methodpublicsetStrokeColor(  $cmykArray,  $force = 0 ) : void
Parameters
Name Type Description
$cmykArray
$force
methodpublicsetStrokeColorRGB(  $r,  $g,  $b,  $force = 0 ) : void
inherited

sets the colour for stroke operations

Inherited from: \Cpdf::setStrokeColorRGB()\Cezpdf::setStrokeColorRGB()
Parameters
Name Type Description
$r
$g
$b
$force
methodpublicsetXOffset(  $xOffset ) : void

Parameters
Name Type Description
$xOffset
methodpublicsetYOffset(  $yOffset ) : void

Parameters
Name Type Description
$yOffset
methodpublicshadedRectangle(  $x1,  $y1,  $width,  $height,  $options ) : void
inherited

Create shaded rectangle area

Inherited from: \Cpdf::shadedRectangle()\Cezpdf::shadedRectangle()

\param x1 \param x2 \param width \param height \param options array ( 'orientation' => <vertical|horizontal ( optianal )>, 'color0' => , 'color1' => )

Parameters
Name Type Description
$x1
$y1
$width
$height
$options
methodpublicstopObject(  $id ) : void
inherited

stop an object from appearing on pages from this point on

Inherited from: \Cpdf::stopObject()\Cezpdf::stopObject()
Parameters
Name Type Description
$id
methodpublicstream(  $options = '' ) : void
inherited

output the pdf code, streaming it to the browser the relevant headers are set so that hopefully the browser will recognise it

Inherited from: \Cpdf::stream()\Cezpdf::stream()
Parameters
Name Type Description
$options
methodpublicstrike(  $info ) : void
inherited

Inherited from: \Cezpdf::strike()
Parameters
Name Type Description
$info
methodpublictransaction(  $action ) : void
inherited

a few functions which should allow the document to be treated transactionally.

Inherited from: \Cpdf::transaction()\Cezpdf::transaction()
Parameters
Name Type Description
$action
methodpubliculine(  $info ) : void
inherited

Inherited from: \Cezpdf::uline()
Parameters
Name Type Description
$info
methodpublicxOffset( ) : void

Get the current X offset

methodpublicyOffset( ) : void

Get the current Y offset

Documentation was generated by DocBlox 0.18.1.