Heratio Framework API Reference

TiffPdfMergeRepository
in package

Repository for TIFF to PDF merge operations Uses Laravel Query Builder

Table of Contents

Methods

addFile()  : int
Add a file to a merge job
createJob()  : int
Create a new merge job
deleteFile()  : int|null
Delete a file
deleteJob()  : bool
Delete a job and all files
getJob()  : object|null
Get a job by ID
getJobFiles()  : Collection
Get files for a job
getJobs()  : Collection
Get jobs with filters
getMaxPageOrder()  : int
Get max page order for a job
getPendingJobs()  : Collection
Get pending jobs for a user
getSetting()  : mixed
Get a single setting
getSettings()  : array<string|int, mixed>
Get all settings as key-value array
getStatistics()  : array<string|int, mixed>
Get statistics
updateFileCount()  : void
Update file count
updateFileOrder()  : bool
Update file order
updateJobOutput()  : bool
Update job output
updateJobStatus()  : bool
Update job status

Methods

addFile()

Add a file to a merge job

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

createJob()

Create a new merge job

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

deleteFile()

Delete a file

public deleteFile(int $fileId) : int|null
Parameters
$fileId : int
Return values
int|null

deleteJob()

Delete a job and all files

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

getJob()

Get a job by ID

public getJob(int $jobId) : object|null
Parameters
$jobId : int
Return values
object|null

getJobFiles()

Get files for a job

public getJobFiles(int $jobId) : Collection
Parameters
$jobId : int
Return values
Collection

getJobs()

Get jobs with filters

public getJobs([array<string|int, mixed> $filters = [] ][, int $limit = 50 ][, int $offset = 0 ]) : Collection
Parameters
$filters : array<string|int, mixed> = []
$limit : int = 50
$offset : int = 0
Return values
Collection

getMaxPageOrder()

Get max page order for a job

public getMaxPageOrder(int $jobId) : int
Parameters
$jobId : int
Return values
int

getPendingJobs()

Get pending jobs for a user

public getPendingJobs(int $userId[, int $limit = 10 ]) : Collection
Parameters
$userId : int
$limit : int = 10
Return values
Collection

getSetting()

Get a single setting

public getSetting(string $key[, mixed $default = null ]) : mixed
Parameters
$key : string
$default : mixed = null

getSettings()

Get all settings as key-value array

public getSettings() : array<string|int, mixed>
Return values
array<string|int, mixed>

getStatistics()

Get statistics

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

updateFileCount()

Update file count

public updateFileCount(int $jobId) : void
Parameters
$jobId : int

updateFileOrder()

Update file order

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

updateJobOutput()

Update job output

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

updateJobStatus()

Update job status

public updateJobStatus(int $jobId, string $status[, string|null $error = null ]) : bool
Parameters
$jobId : int
$status : string
$error : string|null = null
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results