Heratio Framework API Reference

ItemPhysicalLocationRepository
in package

Repository for Item-level Physical Location data

Table of Contents

Methods

deleteLocationData()  : bool
Delete location data
findByBarcode()  : array<string|int, mixed>|null
Find item by barcode
getFullLocationString()  : string
Get full location string for an item
getItemsByAccessStatus()  : array<string|int, mixed>
Get items by access status
getItemsByCondition()  : array<string|int, mixed>
Get items by condition
getItemsByContainer()  : array<string|int, mixed>
Get items by physical object (container)
getLocationData()  : array<string|int, mixed>|null
Get physical location data for an information object
getLocationWithContainer()  : array<string|int, mixed>|null
Get location with container details
saveLocationData()  : int
Save physical location data for an information object
updateAccessStatus()  : bool
Update access status

Methods

deleteLocationData()

Delete location data

public deleteLocationData(int $informationObjectId) : bool
Parameters
$informationObjectId : int
Return values
bool

findByBarcode()

Find item by barcode

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

getFullLocationString()

Get full location string for an item

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

getItemsByAccessStatus()

Get items by access status

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

getItemsByCondition()

Get items by condition

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

getItemsByContainer()

Get items by physical object (container)

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

getLocationData()

Get physical location data for an information object

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

getLocationWithContainer()

Get location with container details

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

saveLocationData()

Save physical location data for an information object

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

updateAccessStatus()

Update access status

public updateAccessStatus(int $informationObjectId, string $status[, string $accessedBy = null ]) : bool
Parameters
$informationObjectId : int
$status : string
$accessedBy : string = null
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results