Heratio Framework API Reference

LandingConfigService
in package

Landing Config Service.

Business logic for heritage landing page configuration. Aggregates data from multiple sources for the landing page API.

Table of Contents

Methods

__construct()  : mixed
getCulture()  : string
Get current culture.
getFiltersWithValues()  : array<string|int, mixed>
Get filters with resolved values for landing page.
getLandingPageData()  : array<string|int, mixed>
Get complete landing page data for public API.
saveConfig()  : int
Save landing config.
setCulture()  : self
Set the culture for queries.
updateConfig()  : bool
Update landing config.

Methods

__construct()

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

getFiltersWithValues()

Get filters with resolved values for landing page.

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

getLandingPageData()

Get complete landing page data for public API.

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

saveConfig()

Save landing config.

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

setCulture()

Set the culture for queries.

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

updateConfig()

Update landing config.

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

        
On this page

Search results