Heratio Framework API Reference

TiffPdfMergeService
in package

Service for merging TIFF/image files into PDF documents

Table of Contents

Methods

__construct()  : mixed
cleanupJob()  : bool
Cleanup job files
createJob()  : int
Create a new merge job
getOutputPath()  : string|null
Download output PDF
processJob()  : array<string|int, mixed>
Process a merge job
uploadFile()  : array<string|int, mixed>
Handle file upload for a merge job

Methods

cleanupJob()

Cleanup job files

public cleanupJob(int $jobId) : bool
Parameters
$jobId : int
Return values
bool

createJob()

Create a new merge job

public createJob(int $userId, string $jobName[, int|null $informationObjectId = null ][, array<string|int, mixed> $options = [] ]) : int
Parameters
$userId : int
$jobName : string
$informationObjectId : int|null = null
$options : array<string|int, mixed> = []
Return values
int

getOutputPath()

Download output PDF

public getOutputPath(int $jobId) : string|null
Parameters
$jobId : int
Return values
string|null

processJob()

Process a merge job

public processJob(int $jobId) : array<string|int, mixed>
Parameters
$jobId : int
Return values
array<string|int, mixed>

uploadFile()

Handle file upload for a merge job

public uploadFile(int $jobId, array<string|int, mixed> $uploadedFile) : array<string|int, mixed>
Parameters
$jobId : int
$uploadedFile : array<string|int, mixed>
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results