Heratio Framework API Reference

BrandingService
in package

Branding Service.

Manages institution branding configuration.

Table of Contents

Methods

getConfig()  : object|null
Get branding configuration for institution.
getMergedConfig()  : array<string|int, mixed>
Get merged branding config (institution + global defaults).
updateConfig()  : bool
Update branding configuration.
validateColor()  : bool
Validate color format.

Methods

getConfig()

Get branding configuration for institution.

public getConfig([int|null $institutionId = null ]) : object|null
Parameters
$institutionId : int|null = null
Return values
object|null

getMergedConfig()

Get merged branding config (institution + global defaults).

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

updateConfig()

Update branding configuration.

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

validateColor()

Validate color format.

public validateColor(string|null $color) : bool
Parameters
$color : string|null
Return values
bool

        
On this page

Search results