Heratio Framework API Reference

DiscoveryService
in package

Discovery Service.

Provides data for the enhanced heritage landing page including explore categories, timeline navigation, hero carousel, and featured collections.

Table of Contents

Methods

__construct()  : mixed
deleteFeaturedCollection()  : bool
Delete a featured collection.
deleteHeroSlide()  : bool
Delete a hero slide.
getExploreCategories()  : array<string|int, mixed>
Get explore categories for landing page.
getExploreCategory()  : array<string|int, mixed>|null
Get a single explore category by code.
getExploreCategoryItems()  : array<string|int, mixed>
Get items for an explore category.
getFeaturedCollection()  : array<string|int, mixed>|null
Get a single featured collection by ID.
getFeaturedCollections()  : array<string|int, mixed>
Get featured collections for landing page.
getHeroSlides()  : array<string|int, mixed>
Get active hero slides for carousel.
getTimelinePeriodItems()  : array<string|int, mixed>
Get items for a timeline period.
getTimelinePeriods()  : array<string|int, mixed>
Get timeline periods for navigation.
saveFeaturedCollection()  : int
Save a featured collection.
saveHeroSlide()  : int
Save a hero slide.
setCulture()  : self
Set the culture for queries.
updateCollectionCounts()  : bool
Update item counts for a featured collection.
updateFeaturedCollection()  : bool
Update a featured collection.
updateHeroSlide()  : bool
Update a hero slide.

Methods

__construct()

public __construct([string $culture = 'en' ]) : mixed
Parameters
$culture : string = 'en'

deleteFeaturedCollection()

Delete a featured collection.

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

deleteHeroSlide()

Delete a hero slide.

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

getExploreCategories()

Get explore categories for landing page.

public getExploreCategories([int|null $institutionId = null ]) : array<string|int, mixed>
Parameters
$institutionId : int|null = null
Return values
array<string|int, mixed>

getExploreCategory()

Get a single explore category by code.

public getExploreCategory(string $code[, int|null $institutionId = null ]) : array<string|int, mixed>|null
Parameters
$code : string
$institutionId : int|null = null
Return values
array<string|int, mixed>|null

getExploreCategoryItems()

Get items for an explore category.

public getExploreCategoryItems(string $code[, int|null $institutionId = null ][, int $limit = 24 ][, int $offset = 0 ]) : array<string|int, mixed>
Parameters
$code : string
$institutionId : int|null = null
$limit : int = 24
$offset : int = 0
Return values
array<string|int, mixed>

getFeaturedCollection()

Get a single featured collection by ID.

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

getFeaturedCollections()

Get featured collections for landing page.

public getFeaturedCollections([int|null $institutionId = null ][, int $limit = 6 ]) : array<string|int, mixed>
Parameters
$institutionId : int|null = null
$limit : int = 6
Return values
array<string|int, mixed>

getHeroSlides()

Get active hero slides for carousel.

public getHeroSlides([int|null $institutionId = null ]) : array<string|int, mixed>
Parameters
$institutionId : int|null = null
Return values
array<string|int, mixed>

getTimelinePeriodItems()

Get items for a timeline period.

public getTimelinePeriodItems(int $periodId[, int|null $institutionId = null ][, int $limit = 24 ][, int $offset = 0 ]) : array<string|int, mixed>
Parameters
$periodId : int
$institutionId : int|null = null
$limit : int = 24
$offset : int = 0
Return values
array<string|int, mixed>

getTimelinePeriods()

Get timeline periods for navigation.

public getTimelinePeriods([int|null $institutionId = null ]) : array<string|int, mixed>
Parameters
$institutionId : int|null = null
Return values
array<string|int, mixed>

saveFeaturedCollection()

Save a featured collection.

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

saveHeroSlide()

Save a hero slide.

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

setCulture()

Set the culture for queries.

public setCulture(string $culture) : self
Parameters
$culture : string
Return values
self

updateCollectionCounts()

Update item counts for a featured collection.

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

updateFeaturedCollection()

Update a featured collection.

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

updateHeroSlide()

Update a hero slide.

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results