Heratio Framework API Reference

DigitalObjectService
in package

Digital Object Service

Comprehensive service for handling digital object uploads, derivatives, and metadata extraction. Uses Laravel Query Builder for all database operations.

Tags
author

Johan Pieterse johan@theahg.co.za

Table of Contents

Methods

__construct()  : mixed
checkUploadLimits()  : array<string|int, mixed>
Check upload limits
deleteDigitalObject()  : bool
Delete a digital object and all its derivatives.
formatBytes()  : string
Format bytes to human readable
getDigitalObjectById()  : object|null
Get digital object by ID
getDigitalObjectByObjectId()  : object|null
Get digital object by object ID (information object)
getInformationObjectById()  : object|null
Get information object by ID
getMaxPostSize()  : int
Get maximum post size in bytes
getMaxUploadSize()  : int
Get maximum upload size in bytes
importFromUrl()  : array<string|int, mixed>
Import digital object from URL
regenerateDerivatives()  : array<string|int, mixed>
Regenerate derivatives for an existing digital object.
replaceDigitalObject()  : array<string|int, mixed>
Replace an existing digital object with a new file.
updateDigitalObject()  : array<string|int, mixed>
Update digital object metadata.
uploadFromFile()  : array<string|int, mixed>
Upload a digital object from a file

Methods

checkUploadLimits()

Check upload limits

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

deleteDigitalObject()

Delete a digital object and all its derivatives.

public deleteDigitalObject(int $id) : bool
Parameters
$id : int
Return values
bool

formatBytes()

Format bytes to human readable

public formatBytes(int $bytes[, int $precision = 2 ]) : string
Parameters
$bytes : int
$precision : int = 2
Return values
string

getDigitalObjectById()

Get digital object by ID

public getDigitalObjectById(int $id) : object|null
Parameters
$id : int
Return values
object|null

getDigitalObjectByObjectId()

Get digital object by object ID (information object)

public getDigitalObjectByObjectId(int $objectId) : object|null
Parameters
$objectId : int
Return values
object|null

getInformationObjectById()

Get information object by ID

public getInformationObjectById(int $id) : object|null
Parameters
$id : int
Return values
object|null

getMaxPostSize()

Get maximum post size in bytes

public getMaxPostSize() : int
Return values
int

getMaxUploadSize()

Get maximum upload size in bytes

public getMaxUploadSize() : int
Return values
int

importFromUrl()

Import digital object from URL

public importFromUrl(int $objectId, string $url[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$objectId : int
$url : string
$options : array<string|int, mixed> = []
Return values
array<string|int, mixed>

regenerateDerivatives()

Regenerate derivatives for an existing digital object.

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

replaceDigitalObject()

Replace an existing digital object with a new file.

public replaceDigitalObject(int $objectId, mixed $file[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$objectId : int
$file : mixed
$options : array<string|int, mixed> = []
Return values
array<string|int, mixed>

updateDigitalObject()

Update digital object metadata.

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

uploadFromFile()

Upload a digital object from a file

public uploadFromFile(int $objectId, mixed $file[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$objectId : int
$file : mixed
$options : array<string|int, mixed> = []
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results