Copied!

SettingService

SettingService.php : 15
Interface

Methods

publiccreateSetting()

SettingService.php : 33 
public createSetting(SettingCreateStruct $settingCreateStruct) : Setting

Parameters

Name Type Default value Description
$settingCreateStruct SettingCreateStruct - -

Return values

Setting

Tags
Throws
InvalidArgumentException

If a setting with the given group and identifier already exists

Throws
UnauthorizedException

If the current user is not allowed to create a setting

publicdeleteSetting()

SettingService.php : 39 
public deleteSetting(Setting $setting) : void

Parameters

Name Type Default value Description
$setting Setting - -
Tags
Throws
NotFoundException

If the setting has already been removed

Throws
UnauthorizedException

If the current user is not allowed to remove a setting

publicloadSetting()

SettingService.php : 20 
public loadSetting(string $group, string $identifier) : Setting

Parameters

Name Type Default value Description
$group string - -
$identifier string - -

Return values

Setting

Tags
Throws
NotFoundException

If a setting with the given group and identifier could not be found

publicnewSettingCreateStruct()

SettingService.php : 41 
public newSettingCreateStruct([array<string|int, mixed> $properties = [] ]) : SettingCreateStruct

Parameters

Name Type Default value Description
$properties array<string|int, mixed> [] -

Return values

SettingCreateStruct

publicnewSettingUpdateStruct()

SettingService.php : 43 
public newSettingUpdateStruct([array<string|int, mixed> $properties = [] ]) : SettingUpdateStruct

Parameters

Name Type Default value Description
$properties array<string|int, mixed> [] -

Return values

SettingUpdateStruct

publicupdateSetting()

SettingService.php : 27 
public updateSetting(Setting $setting, SettingUpdateStruct $settingUpdateStruct) : Setting

Parameters

Name Type Default value Description
$setting Setting - -
$settingUpdateStruct SettingUpdateStruct - -

Return values

Setting

Tags
Throws
NotFoundException
Throws
InvalidArgumentException
Throws
UnauthorizedException

If the current user is not allowed to update a setting