Heratio Framework API Reference

ThreeDAutoConfigService
in package

Table of Contents

Methods

createConfig()  : bool
Create config from digital object record
createConfigForDigitalObject()  : bool
Create config for a single digital object
createConfigForObject()  : bool
Create config for a digital object by object_id (information_object)
is3DFile()  : bool
Check if a filename is a 3D file
processAllUnconfigured()  : int
Process all unconfigured 3D files
processRecentUploads()  : int
Check recent uploads and create configs (for cron job)

Methods

createConfig()

Create config from digital object record

public static createConfig(object $digitalObject) : bool
Parameters
$digitalObject : object
Return values
bool

createConfigForDigitalObject()

Create config for a single digital object

public static createConfigForDigitalObject(int $digitalObjectId) : bool
Parameters
$digitalObjectId : int
Return values
bool

True if config was created, false if already exists or not 3D

createConfigForObject()

Create config for a digital object by object_id (information_object)

public static createConfigForObject(int $objectId) : bool
Parameters
$objectId : int
Return values
bool

is3DFile()

Check if a filename is a 3D file

public static is3DFile(string $filename) : bool
Parameters
$filename : string
Return values
bool

processAllUnconfigured()

Process all unconfigured 3D files

public static processAllUnconfigured() : int
Return values
int

Number of configs created

processRecentUploads()

Check recent uploads and create configs (for cron job)

public static processRecentUploads([int $minutes = 60 ]) : int
Parameters
$minutes : int = 60

Check uploads from last N minutes

Return values
int

Number of configs created


        
On this page

Search results