phpdftk API Documentation

DocumentInspector
in

Abstract inspection interface for conformance validation.

Provides read-only access to the document structure for constraint checking, decoupled from whether the document was built via PdfWriter or parsed via PdfReader.

Table of Contents

Methods

getCatalog()  : Catalog
getFonts()  : iterable<string|int, PdfObject>
getImageXObjects()  : iterable<string|int, ImageXObject>
getInfo()  : Info|null
getPages()  : iterable<string|int, Page>
getReferenceXObjects()  : iterable<string|int, FormXObject>
getRegisteredObjects()  : iterable<string|int, PdfObject>
All registered PdfObject instances.
getThreeDStreams()  : iterable<string|int, ThreeDStream>
getXmpBytes()  : string|null
Raw XMP XML bytes, or null if no metadata stream.
hasEmbeddedFiles()  : bool
Whether the document contains embedded files.
hasEncryption()  : bool
Whether the document has encryption configured.
hasInteractiveForms()  : bool
Whether the document contains interactive forms (AcroForm).
hasJavaScript()  : bool
Whether the document contains JavaScript actions.
hasMultimediaContent()  : bool
Whether the document contains multimedia content (movies, sounds, renditions).
hasOutputIntents()  : bool
Whether the catalog has OutputIntents.
hasOutputIntentWithIccProfile()  : bool
Whether any OutputIntent has an embedded ICC profile (/DestOutputProfile).
hasRasterOnlyContent()  : bool
Whether all page content is raster-only (no text operators, no vector paths).
hasThreeDAnnotations()  : bool
Whether the document contains 3D annotations.
hasTransparency()  : bool
Whether any page uses a transparency group.
hasXmpMetadata()  : bool
Whether the catalog has an XMP metadata stream.

Methods

getReferenceXObjects()

public getReferenceXObjects() : iterable<string|int, FormXObject>
Return values
iterable<string|int, FormXObject> —

All FormXObjects with a /Ref (reference XObject) entry.

getRegisteredObjects()

All registered PdfObject instances.

public getRegisteredObjects() : iterable<string|int, PdfObject>
Return values
iterable<string|int, PdfObject>

getXmpBytes()

Raw XMP XML bytes, or null if no metadata stream.

public getXmpBytes() : string|null
Return values
string|null

hasEmbeddedFiles()

Whether the document contains embedded files.

public hasEmbeddedFiles() : bool
Return values
bool

hasEncryption()

Whether the document has encryption configured.

public hasEncryption() : bool
Return values
bool

hasInteractiveForms()

Whether the document contains interactive forms (AcroForm).

public hasInteractiveForms() : bool
Return values
bool

hasJavaScript()

Whether the document contains JavaScript actions.

public hasJavaScript() : bool
Return values
bool

hasMultimediaContent()

Whether the document contains multimedia content (movies, sounds, renditions).

public hasMultimediaContent() : bool
Return values
bool

hasOutputIntents()

Whether the catalog has OutputIntents.

public hasOutputIntents() : bool
Return values
bool

hasOutputIntentWithIccProfile()

Whether any OutputIntent has an embedded ICC profile (/DestOutputProfile).

public hasOutputIntentWithIccProfile() : bool
Return values
bool

hasRasterOnlyContent()

Whether all page content is raster-only (no text operators, no vector paths).

public hasRasterOnlyContent() : bool
Return values
bool

hasThreeDAnnotations()

Whether the document contains 3D annotations.

public hasThreeDAnnotations() : bool
Return values
bool

hasTransparency()

Whether any page uses a transparency group.

public hasTransparency() : bool
Return values
bool

hasXmpMetadata()

Whether the catalog has an XMP metadata stream.

public hasXmpMetadata() : bool
Return values
bool 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results