Com\Tecnick\Pdf\Output
Output PDF data
Tags
Table of Contents
- $byterange : string
- ByteRange placemark used during digital signature process.
- $objid : array<string|int, mixed>
- Array containing the ID of some named PDF objects.
- $sigmaxlen : int
- Digital signature max length.
- $xobject : array<string|int, mixed>
- Store XObject.
- getOutPDFString() : string
- Returns the RAW PDF string.
- applySignatureTimestamp() : string
- -- NOT YET IMPLEMENTED -- Add TSA timestamp to the signature.
- getAnnotationAppearanceStream() : string
- Returns the Annotation code for Appearance Stream.
- getAnnotationBorder() : string
- Returns the Annotation code for Borders.
- getAnnotationFlagsCode() : int
- Returns the Annotation Flags code.
- getAnnotationRadiobuttonGroups() : string
- Returns the Annotation code for Radio buttons.
- getColorStringFromArray() : string
- Convert a color array into a string representation for annotations.
- getLayerDic() : string
- Get the PDF output string for Layer resources dictionary.
- getOnOff() : string
- Returns 'ON' if $val is true, 'OFF' otherwise.
- getOutAnnotationFlags() : string
- Returns the Annotation code for Flags.
- getOutAnnotationMarkups() : string
- Returns the Annotation code for Makups.
- getOutAnnotationOptSubtype() : string
- Returns the output code associated with the annotation opt.subtype.
- getOutAnnotationOptSubtype3D() : string
- Returns the output code associated with the annotation opt.subtype.3d.
- getOutAnnotationOptSubtypeCaret() : string
- Returns the output code associated with the annotation opt.subtype.caret.
- getOutAnnotationOptSubtypeCircle() : string
- Returns the output code associated with the annotation opt.subtype.circle.
- getOutAnnotationOptSubtypeFileattachment() : string
- Returns the output code associated with the annotation opt.subtype.fileattachment.
- getOutAnnotationOptSubtypeFreetext() : string
- Returns the output code associated with the annotation opt.subtype.freetext.
- getOutAnnotationOptSubtypeHighlight() : string
- Returns the output code associated with the annotation opt.subtype.highlight.
- getOutAnnotationOptSubtypeInk() : string
- Returns the output code associated with the annotation opt.subtype.ink.
- getOutAnnotationOptSubtypeLine() : string
- Returns the output code associated with the annotation opt.subtype.line.
- getOutAnnotationOptSubtypeLink() : string
- Returns the output code associated with the annotation opt.subtype.link.
- getOutAnnotationOptSubtypeMovie() : string
- Returns the output code associated with the annotation opt.subtype.movie.
- getOutAnnotationOptSubtypePolygon() : string
- Returns the output code associated with the annotation opt.subtype.polygon.
- getOutAnnotationOptSubtypePolyline() : string
- Returns the output code associated with the annotation opt.subtype.polyline.
- getOutAnnotationOptSubtypePopup() : string
- Returns the output code associated with the annotation opt.subtype.popup.
- getOutAnnotationOptSubtypePrintermark() : string
- Returns the output code associated with the annotation opt.subtype.printermark.
- getOutAnnotationOptSubtypeScreen() : string
- Returns the output code associated with the annotation opt.subtype.screen.
- getOutAnnotationOptSubtypeSound() : string
- Returns the output code associated with the annotation opt.subtype.sound.
- getOutAnnotationOptSubtypeSquare() : string
- Returns the output code associated with the annotation opt.subtype.square.
- getOutAnnotationOptSubtypeSquiggly() : string
- Returns the output code associated with the annotation opt.subtype.squiggly.
- getOutAnnotationOptSubtypeStamp() : string
- Returns the output code associated with the annotation opt.subtype.stamp.
- getOutAnnotationOptSubtypeStrikeout() : string
- Returns the output code associated with the annotation opt.subtype.strikeout.
- getOutAnnotationOptSubtypeText() : string
- Returns the output code associated with the annotation opt.subtype.text.
- getOutAnnotationOptSubtypeTrapnet() : string
- Returns the output code associated with the annotation opt.subtype.trapnet.
- getOutAnnotationOptSubtypeUnderline() : string
- Returns the output code associated with the annotation opt.subtype.
- getOutAnnotationOptSubtypeWatermark() : string
- Returns the output code associated with the annotation opt.subtype.watermark.
- getOutAnnotationOptSubtypeWidget() : string
- Returns the output code associated with the annotation opt.subtype.widget.
- getOutAnnotations() : string
- Returns the PDF Annotations entry.
- getOutAPXObjects() : int
- Returns the PDF Annotation code for Apearance Stream XObjects entry.
- getOutBookmarks() : string
- Returns the PDF Bookmarks entry.
- getOutCatalog() : string
- Returns the PDF Catalog entry.
- getOutDestinations() : string
- Returns the PDF Destinations entry.
- getOutEmbeddedFiles() : string
- Returns the PDF Embedded Files entry.
- getOutFontDic() : string
- Get the PDF output string for Font resources dictionary.
- getOutICC() : string
- Returns the PDF object to include a standard sRGB_IEC61966-2.1 blackscaled ICC colour profile.
- getOutJavascript() : string
- Returns the PDF Javascript entry.
- getOutOCG() : string
- Returns the PDF OCG entry.
- getOutPDFBody() : string
- Returns the raw PDF Body section.
- getOutPDFHeader() : string
- Returns the PDF document header.
- getOutPDFTrailer() : string
- Returns the PDF Trailer section.
- getOutPDFXref() : string
- Returns the PDF XREF section.
- getOutputIntents() : string
- Set OutputIntents.
- getOutputIntentsPdfX() : string
- Get OutputIntents for PDF-X if required.
- getOutputIntentsSrgb() : string
- Get OutputIntents for sRGB IEC61966-2.1 if required.
- getOutResourcesDict() : string
- Returns the PDF Resources Dictionary entry.
- getOutSignature() : string
- Returns the PDF signarure entry.
- getOutSignatureDocMDP() : string
- Returns the PDF signarure entry.
- getOutSignatureFields() : string
- Returns the PDF Signature Fields entry.
- getOutSignatureInfo() : string
- Returns the PDF signarure info section.
- getOutSignatureUserRights() : string
- Returns the PDF signarure entry.
- getOutXObjects() : string
- Returns the PDF XObjects entry.
- getPDFLayers() : string
- Get the PDF layers.
- getPDFObjectOffsets() : array<string|int, mixed>
- Returns the ordered offset array for each object.
- getXObjectDic() : string
- Get the PDF output string for XObject resources dictionary.
- processPrevNextBookmarks() : int
- Process the bookmarks to get the previous and next one.
- signDocument() : string
- Sign the document.
- sortBookmarks() : mixed
- Sort bookmarks by page and original position.
- unhtmlentities() : string
- Reverse function for htmlentities.
Properties
$byterange
ByteRange placemark used during digital signature process.
protected static string $byterange = '/ByteRange[0 **********
********** **********]'$objid
Array containing the ID of some named PDF objects.
protected array<string|int,
mixed> $objid = array()$sigmaxlen
Digital signature max length.
protected static int $sigmaxlen = 11742$xobject
Store XObject.
protected array<string|int,
mixed> $xobject = array()Methods
getOutPDFString()
Returns the RAW PDF string.
public getOutPDFString()
: string
Return values
string —applySignatureTimestamp()
-- NOT YET IMPLEMENTED -- Add TSA timestamp to the signature.
protected applySignatureTimestamp(string $signature)
: string
Parameters
- $signature : string
-
Digital signature as binary string
Return values
string —getAnnotationAppearanceStream()
Returns the Annotation code for Appearance Stream.
protected getAnnotationAppearanceStream(mixed $annot,
int $width,
int $height)
: string
Parameters
- $annot : mixed
- $width : int
-
Annotation width.
- $height : int
-
Annotation height.
Tags
Return values
string —getAnnotationBorder()
Returns the Annotation code for Borders.
protected getAnnotationBorder(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getAnnotationFlagsCode()
Returns the Annotation Flags code.
protected getAnnotationFlagsCode(mixed $flags)
: int
Parameters
- $flags : mixed
Tags
Return values
int —getAnnotationRadiobuttonGroups()
Returns the Annotation code for Radio buttons.
protected getAnnotationRadiobuttonGroups(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getColorStringFromArray()
Convert a color array into a string representation for annotations.
protected static getColorStringFromArray(array<string|int,
mixed> $colors)
: string
The number of array elements determines the colour space in which the colour shall be defined: 0 No colour; transparent 1 DeviceGray 3 DeviceRGB 4 DeviceCMYK
Parameters
- $colors : array<string|int, mixed>
-
Array of colors.
Return values
string —getLayerDic()
Get the PDF output string for Layer resources dictionary.
protected getLayerDic()
: string
Return values
string —getOnOff()
Returns 'ON' if $val is true, 'OFF' otherwise.
protected getOnOff(mixed $val)
: string
Parameters
- $val : mixed
-
Item to parse for boolean value.
Return values
string —getOutAnnotationFlags()
Returns the Annotation code for Flags.
protected getOutAnnotationFlags(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationMarkups()
Returns the Annotation code for Makups.
protected getOutAnnotationMarkups(mixed $annot,
mixed $oid)
: string
Parameters
- $annot : mixed
- $oid : mixed
Tags
Return values
string —getOutAnnotationOptSubtype()
Returns the output code associated with the annotation opt.subtype.
protected getOutAnnotationOptSubtype(mixed $annot,
mixed $pagenum,
mixed $oid,
mixed $key)
: string
Parameters
- $annot : mixed
- $pagenum : mixed
- $oid : mixed
- $key : mixed
Tags
Return values
string —getOutAnnotationOptSubtype3D()
Returns the output code associated with the annotation opt.subtype.3d.
protected getOutAnnotationOptSubtype3D(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeCaret()
Returns the output code associated with the annotation opt.subtype.caret.
protected getOutAnnotationOptSubtypeCaret(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeCircle()
Returns the output code associated with the annotation opt.subtype.circle.
protected getOutAnnotationOptSubtypeCircle(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeFileattachment()
Returns the output code associated with the annotation opt.subtype.fileattachment.
protected getOutAnnotationOptSubtypeFileattachment(mixed $annot,
mixed $key)
: string
Parameters
- $annot : mixed
- $key : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeFreetext()
Returns the output code associated with the annotation opt.subtype.freetext.
protected getOutAnnotationOptSubtypeFreetext(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeHighlight()
Returns the output code associated with the annotation opt.subtype.highlight.
protected getOutAnnotationOptSubtypeHighlight(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeInk()
Returns the output code associated with the annotation opt.subtype.ink.
protected getOutAnnotationOptSubtypeInk(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeLine()
Returns the output code associated with the annotation opt.subtype.line.
protected getOutAnnotationOptSubtypeLine(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeLink()
Returns the output code associated with the annotation opt.subtype.link.
protected getOutAnnotationOptSubtypeLink(mixed $annot,
mixed $pagenum,
mixed $oid)
: string
Parameters
- $annot : mixed
- $pagenum : mixed
- $oid : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeMovie()
Returns the output code associated with the annotation opt.subtype.movie.
protected getOutAnnotationOptSubtypeMovie(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypePolygon()
Returns the output code associated with the annotation opt.subtype.polygon.
protected getOutAnnotationOptSubtypePolygon(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypePolyline()
Returns the output code associated with the annotation opt.subtype.polyline.
protected getOutAnnotationOptSubtypePolyline(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypePopup()
Returns the output code associated with the annotation opt.subtype.popup.
protected getOutAnnotationOptSubtypePopup(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypePrintermark()
Returns the output code associated with the annotation opt.subtype.printermark.
protected getOutAnnotationOptSubtypePrintermark(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeScreen()
Returns the output code associated with the annotation opt.subtype.screen.
protected getOutAnnotationOptSubtypeScreen(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeSound()
Returns the output code associated with the annotation opt.subtype.sound.
protected getOutAnnotationOptSubtypeSound(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeSquare()
Returns the output code associated with the annotation opt.subtype.square.
protected getOutAnnotationOptSubtypeSquare(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeSquiggly()
Returns the output code associated with the annotation opt.subtype.squiggly.
protected getOutAnnotationOptSubtypeSquiggly(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeStamp()
Returns the output code associated with the annotation opt.subtype.stamp.
protected getOutAnnotationOptSubtypeStamp(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeStrikeout()
Returns the output code associated with the annotation opt.subtype.strikeout.
protected getOutAnnotationOptSubtypeStrikeout(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeText()
Returns the output code associated with the annotation opt.subtype.text.
protected getOutAnnotationOptSubtypeText(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeTrapnet()
Returns the output code associated with the annotation opt.subtype.trapnet.
protected getOutAnnotationOptSubtypeTrapnet(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeUnderline()
Returns the output code associated with the annotation opt.subtype.
protected getOutAnnotationOptSubtypeUnderline(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeWatermark()
Returns the output code associated with the annotation opt.subtype.watermark.
protected getOutAnnotationOptSubtypeWatermark(mixed $annot)
: string
Parameters
- $annot : mixed
Tags
Return values
string —getOutAnnotationOptSubtypeWidget()
Returns the output code associated with the annotation opt.subtype.widget.
protected getOutAnnotationOptSubtypeWidget(mixed $annot,
mixed $oid)
: string
Parameters
- $annot : mixed
- $oid : mixed
Tags
Return values
string —getOutAnnotations()
Returns the PDF Annotations entry.
protected getOutAnnotations()
: string
Return values
string —getOutAPXObjects()
Returns the PDF Annotation code for Apearance Stream XObjects entry.
protected getOutAPXObjects(int $width,
int $height[,
string $stream
= ''
]) : int
Parameters
- $width : int
-
annotation width
- $height : int
-
annotation height
- $stream : string = ''
-
appearance stream
Return values
int —getOutBookmarks()
Returns the PDF Bookmarks entry.
protected getOutBookmarks()
: string
Return values
string —getOutCatalog()
Returns the PDF Catalog entry.
protected getOutCatalog()
: string
Return values
string —getOutDestinations()
Returns the PDF Destinations entry.
protected getOutDestinations()
: string
Return values
string —getOutEmbeddedFiles()
Returns the PDF Embedded Files entry.
protected getOutEmbeddedFiles()
: string
Return values
string —getOutFontDic()
Get the PDF output string for Font resources dictionary.
protected getOutFontDic()
: string
Return values
string —getOutICC()
Returns the PDF object to include a standard sRGB_IEC61966-2.1 blackscaled ICC colour profile.
protected getOutICC()
: string
Return values
string —getOutJavascript()
Returns the PDF Javascript entry.
protected getOutJavascript()
: string
Return values
string —getOutOCG()
Returns the PDF OCG entry.
protected getOutOCG()
: string
Return values
string —getOutPDFBody()
Returns the raw PDF Body section.
protected getOutPDFBody()
: string
Return values
string —getOutPDFHeader()
Returns the PDF document header.
protected getOutPDFHeader()
: string
Return values
string —getOutPDFTrailer()
Returns the PDF Trailer section.
protected getOutPDFTrailer()
: string
Return values
string —getOutPDFXref()
Returns the PDF XREF section.
protected getOutPDFXref(array<string|int,
mixed> $offset)
: string
Parameters
- $offset : array<string|int, mixed>
-
Ordered offset array for each PDF object
Return values
string —getOutputIntents()
Set OutputIntents.
protected getOutputIntents()
: string
Return values
string —getOutputIntentsPdfX()
Get OutputIntents for PDF-X if required.
protected getOutputIntentsPdfX()
: string
Return values
string —getOutputIntentsSrgb()
Get OutputIntents for sRGB IEC61966-2.1 if required.
protected getOutputIntentsSrgb()
: string
Return values
string —getOutResourcesDict()
Returns the PDF Resources Dictionary entry.
protected getOutResourcesDict()
: string
Return values
string —getOutSignature()
Returns the PDF signarure entry.
protected getOutSignature()
: string
Return values
string —getOutSignatureDocMDP()
Returns the PDF signarure entry.
protected getOutSignatureDocMDP()
: string
Return values
string —getOutSignatureFields()
Returns the PDF Signature Fields entry.
protected getOutSignatureFields()
: string
Return values
string —getOutSignatureInfo()
Returns the PDF signarure info section.
protected getOutSignatureInfo()
: string
Return values
string —getOutSignatureUserRights()
Returns the PDF signarure entry.
protected getOutSignatureUserRights()
: string
Return values
string —getOutXObjects()
Returns the PDF XObjects entry.
protected getOutXObjects()
: string
Return values
string —getPDFLayers()
Get the PDF layers.
protected getPDFLayers()
: string
Return values
string —getPDFObjectOffsets()
Returns the ordered offset array for each object.
protected getPDFObjectOffsets(string $data)
: array<string|int,
mixed>
Parameters
- $data : string
-
Raw PDF data
Return values
array<string|int, mixed> —getXObjectDic()
Get the PDF output string for XObject resources dictionary.
protected getXObjectDic()
: string
Return values
string —processPrevNextBookmarks()
Process the bookmarks to get the previous and next one.
protected processPrevNextBookmarks()
: int
Return values
int —first bookmark object ID
signDocument()
Sign the document.
protected signDocument(string $pdfdoc)
: string
Parameters
- $pdfdoc : string
-
string containing the PDF document
Return values
string —sortBookmarks()
Sort bookmarks by page and original position.
protected sortBookmarks()
: mixed
Return values
mixed —unhtmlentities()
Reverse function for htmlentities.
protected unhtmlentities(string $text_to_convert)
: string
Parameters
- $text_to_convert : string
-
Text to convert.
Return values
string —converted text string