Heratio Framework API Reference

InformationObjectRepository
in package

Information Object Repository.

Provides access to archival descriptions (information objects). Uses Laravel Query Builder for database operations.

Tags
author

Johan Pieterse johan@theahg.co.za

Table of Contents

Methods

count()  : int
Count total information objects.
findById()  : object|null
Find information object by ID.
getPublicationStatus()  : object|null
Get publication status for information object.
getRepository()  : object|null
Get repository for information object (with inheritance).
search()  : Collection
Search information objects with filters.

Methods

count()

Count total information objects.

public count([array<string|int, mixed> $filters = [] ]) : int
Parameters
$filters : array<string|int, mixed> = []
Return values
int

findById()

Find information object by ID.

public findById(int $id[, string $culture = 'en' ]) : object|null
Parameters
$id : int
$culture : string = 'en'
Return values
object|null

getPublicationStatus()

Get publication status for information object.

public getPublicationStatus(int $informationObjectId) : object|null
Parameters
$informationObjectId : int
Return values
object|null

getRepository()

Get repository for information object (with inheritance).

public getRepository(int $informationObjectId) : object|null
Parameters
$informationObjectId : int
Return values
object|null

search()

Search information objects with filters.

public search([array<string|int, mixed> $filters = [] ][, string $culture = 'en' ]) : Collection
Parameters
$filters : array<string|int, mixed> = []
$culture : string = 'en'
Return values
Collection 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results