Heratio Framework API Reference

ConfigController
in package

Admin Config Controller.

Handles admin API requests for heritage configuration. Called by Symfony actions in the plugin.

Table of Contents

Methods

__construct()  : mixed
assignUserTrustLevel()  : array<string|int, mixed>
POST /heritage/admin/api/users/:id/trust-level
createHeroImage()  : array<string|int, mixed>
POST /heritage/admin/api/hero-images
createStory()  : array<string|int, mixed>
POST /heritage/admin/api/stories
deleteHeroImage()  : array<string|int, mixed>
DELETE /heritage/admin/api/hero-images/:id
deleteStory()  : array<string|int, mixed>
DELETE /heritage/admin/api/stories/:id
getBrandingConfig()  : array<string|int, mixed>
GET /heritage/admin/api/branding
getCulture()  : string
Get current culture.
getFeatureToggles()  : array<string|int, mixed>
GET /heritage/admin/api/feature-toggles
getFilter()  : array<string|int, mixed>
GET /heritage/admin/api/filters/:id
getFilters()  : array<string|int, mixed>
GET /heritage/admin/api/filters
getHeroImages()  : array<string|int, mixed>
GET /heritage/admin/api/hero-images
getLandingConfig()  : array<string|int, mixed>
GET /heritage/admin/api/landing-config
getStories()  : array<string|int, mixed>
GET /heritage/admin/api/stories
getStory()  : array<string|int, mixed>
GET /heritage/admin/api/stories/:id
getTrustLevels()  : array<string|int, mixed>
GET /heritage/admin/api/trust-levels
getUser()  : array<string|int, mixed>
GET /heritage/admin/api/users/:id
getUsers()  : array<string|int, mixed>
GET /heritage/admin/api/users
getUserStats()  : array<string|int, mixed>
GET /heritage/admin/api/user-stats
reorderFilters()  : array<string|int, mixed>
POST /heritage/admin/api/filters/reorder
reorderHeroImages()  : array<string|int, mixed>
POST /heritage/admin/api/hero-images/reorder
setCulture()  : self
Set the culture for queries.
toggleFeature()  : array<string|int, mixed>
POST /heritage/admin/api/feature-toggles/:code/toggle
updateBrandingConfig()  : array<string|int, mixed>
PUT /heritage/admin/api/branding
updateFeatureToggle()  : array<string|int, mixed>
PUT /heritage/admin/api/feature-toggles/:code
updateFilter()  : array<string|int, mixed>
PUT /heritage/admin/api/filters/:id
updateHeroImage()  : array<string|int, mixed>
PUT /heritage/admin/api/hero-images/:id
updateLandingConfig()  : array<string|int, mixed>
PUT /heritage/admin/api/landing-config
updateStory()  : array<string|int, mixed>
PUT /heritage/admin/api/stories/:id

Methods

__construct()

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

assignUserTrustLevel()

POST /heritage/admin/api/users/:id/trust-level

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

createHeroImage()

POST /heritage/admin/api/hero-images

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

createStory()

POST /heritage/admin/api/stories

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

deleteHeroImage()

DELETE /heritage/admin/api/hero-images/:id

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

deleteStory()

DELETE /heritage/admin/api/stories/:id

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

getBrandingConfig()

GET /heritage/admin/api/branding

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

getCulture()

Get current culture.

public getCulture() : string
Return values
string

getFeatureToggles()

GET /heritage/admin/api/feature-toggles

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

getFilter()

GET /heritage/admin/api/filters/:id

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

getFilters()

GET /heritage/admin/api/filters

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

getHeroImages()

GET /heritage/admin/api/hero-images

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

getLandingConfig()

GET /heritage/admin/api/landing-config

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

getStories()

GET /heritage/admin/api/stories

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

getStory()

GET /heritage/admin/api/stories/:id

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

getTrustLevels()

GET /heritage/admin/api/trust-levels

public getTrustLevels() : array<string|int, mixed>
Return values
array<string|int, mixed>

getUser()

GET /heritage/admin/api/users/:id

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

getUsers()

GET /heritage/admin/api/users

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

getUserStats()

GET /heritage/admin/api/user-stats

public getUserStats() : array<string|int, mixed>
Return values
array<string|int, mixed>

reorderFilters()

POST /heritage/admin/api/filters/reorder

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

reorderHeroImages()

POST /heritage/admin/api/hero-images/reorder

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

setCulture()

Set the culture for queries.

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

toggleFeature()

POST /heritage/admin/api/feature-toggles/:code/toggle

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

updateBrandingConfig()

PUT /heritage/admin/api/branding

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

updateFeatureToggle()

PUT /heritage/admin/api/feature-toggles/:code

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

updateFilter()

PUT /heritage/admin/api/filters/:id

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

updateHeroImage()

PUT /heritage/admin/api/hero-images/:id

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

updateLandingConfig()

PUT /heritage/admin/api/landing-config

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

updateStory()

PUT /heritage/admin/api/stories/:id

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results