Heratio Framework API Reference

SectorProviderInterface
in

Interface for plugins that provide GLAM sector support.

Plugins implementing this interface can register their sector support dynamically instead of being hardcoded in the framework.

Example implementation in plugin configuration:

class ahgMuseumPluginConfiguration extends sfPluginConfiguration implements \AtomExtensions\Contracts\SectorProviderInterface { public function getSectorCode(): string { return 'museum'; }

public function getSectorLabel(): string
{
    return 'Museum';
}

public function getDefaultLevels(): array
{
    return ['Artifact', 'Object', 'Specimen'];
}

}

Table of Contents

Methods

getDefaultLevels()  : array<string|int, string>
Get default levels of description for this sector.
getSectorCode()  : string
Get the sector code (e.g., 'museum', 'library', 'gallery', 'dam').
getSectorLabel()  : string
Get the human-readable sector label.

Methods

getDefaultLevels()

Get default levels of description for this sector.

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

Array of level names

getSectorCode()

Get the sector code (e.g., 'museum', 'library', 'gallery', 'dam').

public getSectorCode() : string
Return values
string

getSectorLabel()

Get the human-readable sector label.

public getSectorLabel() : string
Return values
string

        
On this page

Search results