phpdftk API Documentation

FormXObject extends PdfStream
in package

Form XObject (/Subtype /Form) — ISO 32000-2 §8.10, Table 95.

A self-contained content stream that can be placed on a page. Carries its own resource dictionary, optional transparency group, optional reference-XObject pointer, and optional metadata.

Table of Contents

Constants

PDF_SUBTYPE  = 'Form'
PDF_TYPE  = 'XObject'

Properties

$af  : PdfArray|null
$bBox  : PdfArray
$data  : string
$dictionary  : PdfDictionary
$formType  : PdfName|null
$generationNumber  : int
$group  : GroupAttributes|Serializable|null
$lastModified  : PdfString|null
$matrix  : PdfArray|null
$measure  : PdfReference|null
$metadata  : PdfReference|null
$name  : PdfName|null
$objectNumber  : int
$oc  : PdfReference|null
$opi  : PdfDictionary|null
$pieceInfo  : PdfReference|null
$ptData  : PdfReference|null
$ref  : PdfReference|null
$resources  : Resources|PdfDictionary|null
$structParent  : int|null
$structParents  : int|null

Methods

__construct()  : mixed
setFilter()  : void
Set a filter to encode/decode the stream data.
toIndirectObject()  : string
Wrap the object in an indirect object structure: X Y obj ... endobj
toPdf()  : string
Returns the stream body: dictionary, stream keyword, data, endstream.

Constants

Properties

$generationNumber

public int $generationNumber = 0

$structParents

public int|null $structParents = null

Methods

setFilter()

Set a filter to encode/decode the stream data.

public setFilter(FilterInterface $filter, string $pdfFilterName) : void
Parameters
$filter : FilterInterface

The filter implementation

$pdfFilterName : string

The PDF filter name (e.g. 'FlateDecode', 'ASCII85Decode')

toIndirectObject()

Wrap the object in an indirect object structure: X Y obj ... endobj

public toIndirectObject() : string
Return values
string

toPdf()

Returns the stream body: dictionary, stream keyword, data, endstream.

public toPdf() : string

/Length is injected into the dictionary at serialization time. If a filter is set, the data is encoded before writing.

Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results