Heratio Framework API Reference

AclWriteServiceInterface
in

Contract for ACL / permission-related persistence.

The permissions handler in ahgSettingsPlugin stores permission settings (PREMIS rights, copyright statements, access statements) as QubitSetting objects. This interface wraps those writes.

Future expansion: when true ACL management (QubitAclPermission, QubitAclGroup) moves to Heratio, additional methods can be added.

Table of Contents

Methods

saveAccessStatements()  : void
Save or delete access statement settings.
saveCopyrightStatement()  : void
Save copyright statement configuration.
savePremisRights()  : void
Save PREMIS access-right and access-right-values settings.
savePreservationStatement()  : void
Save preservation system access statement.

Methods

saveAccessStatements()

Save or delete access statement settings.

public saveAccessStatements(array<string|int, mixed> $statements) : void
Parameters
$statements : array<string|int, mixed>

Array of ['name' => string, 'value' => string|null] If value is null/empty, the setting is deleted.

saveCopyrightStatement()

Save copyright statement configuration.

public saveCopyrightStatement(bool $enabled, string|null $text, bool $applyGlobally[, string $culture = 'en' ]) : void
Parameters
$enabled : bool

Whether copyright statement is enabled

$text : string|null

Copyright statement text (localized)

$applyGlobally : bool

Whether to apply globally

$culture : string = 'en'

Culture for localized text

savePremisRights()

Save PREMIS access-right and access-right-values settings.

public savePremisRights(array<string|int, mixed> $rights, array<string|int, mixed> $rightValues) : void
Parameters
$rights : array<string|int, mixed>

Serialized rights array

$rightValues : array<string|int, mixed>

Serialized right-values array

savePreservationStatement()

Save preservation system access statement.

public savePreservationStatement(bool $enabled, string|null $text[, string $culture = 'en' ]) : void
Parameters
$enabled : bool

Whether preservation access statement is enabled

$text : string|null

Statement text (localized)

$culture : string = 'en'

Culture for localized text


        
On this page

Search results