Heratio Framework API Reference

LandingController
in package

Landing Controller.

Handles API requests for the landing page. Called by Symfony actions in the plugin.

Table of Contents

Methods

__construct()  : mixed
getConfig()  : array<string|int, mixed>
GET /heritage/api/landing/config
getFilters()  : array<string|int, mixed>
GET /heritage/api/landing/filters
index()  : array<string|int, mixed>
GET /heritage/api/landing
setCulture()  : self
Set the culture for queries.

Methods

__construct()

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

getConfig()

GET /heritage/api/landing/config

public getConfig([int|null $institutionId = null ]) : array<string|int, mixed>

Returns only the configuration (for admin).

Parameters
$institutionId : int|null = null
Return values
array<string|int, mixed>

getFilters()

GET /heritage/api/landing/filters

public getFilters([int|null $institutionId = null ]) : array<string|int, mixed>

Returns filters with values for landing page.

Parameters
$institutionId : int|null = null
Return values
array<string|int, mixed>

index()

GET /heritage/api/landing

public index([int|null $institutionId = null ][, string|null $culture = null ]) : array<string|int, mixed>

Returns all landing page configuration and data.

Parameters
$institutionId : int|null = null
$culture : string|null = null
Return values
array<string|int, mixed>

setCulture()

Set the culture for queries.

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

        
On this page

Search results