IManager
in
Tags
Table of Contents
Constants
- KEY_ADMIN_SECTION = 'admin-section'
- KEY_ADMIN_SETTINGS = 'admin'
- KEY_PERSONAL_SECTION = 'personal-section'
- KEY_PERSONAL_SETTINGS = 'personal'
- SETTINGS_ADMIN = 'admin'
- SETTINGS_PERSONAL = 'personal'
Methods
- getAdminSections() : array<int, array<int, IIconSection>>
- returns a list of the admin sections
- getAdminSettings() : array<int, array<int, ISettings>>
- returns a list of the admin settings
- getAllAllowedAdminSettings() : array<int, ISettings>
- Returns a list of admin settings that the given user can use.
- getAllowedAdminSettings() : array<int, array<int, ISettings>>
- Returns a list of admin settings that the given user can use for the give section
- getPersonalSections() : array<int, array<int, IIconSection>>
- returns a list of the personal sections
- getPersonalSettings() : array<int, array<int, ISettings>>
- returns a list of the personal settings
- getSection() : IIconSection|null
- Get a specific section by type and id
- registerSection() : mixed
- registerSetting() : mixed
Constants
KEY_ADMIN_SECTION
public
mixed
KEY_ADMIN_SECTION
= 'admin-section'
Tags
KEY_ADMIN_SETTINGS
public
mixed
KEY_ADMIN_SETTINGS
= 'admin'
Tags
KEY_PERSONAL_SECTION
public
mixed
KEY_PERSONAL_SECTION
= 'personal-section'
Tags
KEY_PERSONAL_SETTINGS
public
mixed
KEY_PERSONAL_SETTINGS
= 'personal'
Tags
SETTINGS_ADMIN
public
mixed
SETTINGS_ADMIN
= 'admin'
Tags
SETTINGS_PERSONAL
public
mixed
SETTINGS_PERSONAL
= 'personal'
Tags
Methods
getAdminSections()
returns a list of the admin sections
public
getAdminSections() : array<int, array<int, IIconSection>>
Tags
Return values
array<int, array<int, IIconSection>> —list of sections with priority as key
getAdminSettings()
returns a list of the admin settings
public
getAdminSettings(string $section[, bool $subAdminOnly = false ]) : array<int, array<int, ISettings>>
Parameters
- $section : string
-
the section id for which to load the settings
- $subAdminOnly : bool = false
-
only return settings sub admins are supposed to see (since 17.0.0)
Tags
Return values
array<int, array<int, ISettings>> —list of settings with priority as key
getAllAllowedAdminSettings()
Returns a list of admin settings that the given user can use.
public
getAllAllowedAdminSettings(IUser $user) : array<int, ISettings>
Parameters
- $user : IUser
Tags
Return values
array<int, ISettings> —The array of admin settings there admin delegation is allowed.
getAllowedAdminSettings()
Returns a list of admin settings that the given user can use for the give section
public
getAllowedAdminSettings(string $section, IUser $user) : array<int, array<int, ISettings>>
Parameters
- $section : string
- $user : IUser
Tags
Return values
array<int, array<int, ISettings>> —The array of admin settings there admin delegation is allowed.
getPersonalSections()
returns a list of the personal sections
public
getPersonalSections() : array<int, array<int, IIconSection>>
Tags
Return values
array<int, array<int, IIconSection>> —list of sections with priority as key
getPersonalSettings()
returns a list of the personal settings
public
getPersonalSettings(string $section) : array<int, array<int, ISettings>>
Parameters
- $section : string
-
the section id for which to load the settings
Tags
Return values
array<int, array<int, ISettings>> —list of settings with priority as key
getSection()
Get a specific section by type and id
public
getSection(string $type, string $sectionId) : IIconSection|null
Parameters
- $type : string
- $sectionId : string
Tags
Return values
IIconSection|nullregisterSection()
public
registerSection(string $type, IIconSection> $section) : mixed
Parameters
- $type : string
- $section : IIconSection>
Tags
registerSetting()
public
registerSetting(string $type, ISettings> $setting) : mixed
Parameters
- $type : string
- $setting : ISettings>