Heratio Framework API Reference

PhysicalObjectExtendedRepository
in package

Repository for Extended Physical Object data

Table of Contents

Methods

decrementUsage()  : bool
Decrement capacity usage
findAvailableLocations()  : array<string|int, mixed>
Find locations with available capacity
getCapacitySummaryByBuilding()  : array<string|int, mixed>
Get capacity summary by building
getExtendedData()  : array<string|int, mixed>|null
Get extended data for a physical object
getFullLocationString()  : string
Get full location string
getRelatedResources()  : array<string|int, mixed>
Get related information objects for a physical object
incrementUsage()  : bool
Increment capacity usage
saveExtendedData()  : int
Save extended data for a physical object
updateCapacityUsage()  : bool
Update capacity usage

Methods

decrementUsage()

Decrement capacity usage

public decrementUsage(int $physicalObjectId[, int $count = 1 ][, float $linearMetres = 0 ]) : bool
Parameters
$physicalObjectId : int
$count : int = 1
$linearMetres : float = 0
Return values
bool

findAvailableLocations()

Find locations with available capacity

public findAvailableLocations([int $minCapacity = 1 ][, string $building = null ]) : array<string|int, mixed>
Parameters
$minCapacity : int = 1
$building : string = null
Return values
array<string|int, mixed>

getCapacitySummaryByBuilding()

Get capacity summary by building

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

getExtendedData()

Get extended data for a physical object

public getExtendedData(int $physicalObjectId) : array<string|int, mixed>|null
Parameters
$physicalObjectId : int
Return values
array<string|int, mixed>|null

getFullLocationString()

Get full location string

public getFullLocationString(int $physicalObjectId) : string
Parameters
$physicalObjectId : int
Return values
string

getRelatedResources()

Get related information objects for a physical object

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

incrementUsage()

Increment capacity usage

public incrementUsage(int $physicalObjectId[, int $count = 1 ][, float $linearMetres = 0 ]) : bool
Parameters
$physicalObjectId : int
$count : int = 1
$linearMetres : float = 0
Return values
bool

saveExtendedData()

Save extended data for a physical object

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

updateCapacityUsage()

Update capacity usage

public updateCapacityUsage(int $physicalObjectId, int $usedCapacity[, float $usedLinearMetres = null ]) : bool
Parameters
$physicalObjectId : int
$usedCapacity : int
$usedLinearMetres : float = null
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results