Documentation

ExtractedPdf
in package

An extracted sub-Pdf.

Table of Contents

Properties

$filename  : string
Name of the original file.
$pdfBytes  : string
File object for an ExtractedPdf.

Methods

__construct()  : mixed
Initializes a new instance of the ExtractedPdf class.
asInputSource()  : BytesInput
Return the file in a format suitable for sending to MindeeClient for parsing.
getFilename()  : string
getPageCount()  : int
Wrapper for pdf GetPageCount().
getPdfBytes()  : string
writeToFile()  : void
Write the PDF to a file.

Properties

$filename

Name of the original file.

protected string $filename

$pdfBytes

File object for an ExtractedPdf.

protected string $pdfBytes

Methods

__construct()

Initializes a new instance of the ExtractedPdf class.

public __construct(string $pdfBytes, string $filename) : mixed
Parameters
$pdfBytes : string

A binary string representation of the PDF.

$filename : string

Name of the original file.

Tags
throws
MindeeUnhandledException

Throws if PDF operations aren't supported.

asInputSource()

Return the file in a format suitable for sending to MindeeClient for parsing.

public asInputSource() : BytesInput
Return values
BytesInput

Bytes input for the image.

getFilename()

public getFilename() : string
Return values
string

The name of the file.

getPageCount()

Wrapper for pdf GetPageCount().

public getPageCount() : int
Tags
throws
MindeePDFException

Throws if FPDI is unable to process the file.

Return values
int

The number of pages in the file.

getPdfBytes()

public getPdfBytes() : string
Return values
string

The pdf bytes.

writeToFile()

Write the PDF to a file.

public writeToFile(string $outputPath) : void
Parameters
$outputPath : string

The output directory (must exist).


        
On this page

Search results