IManager

interface OCP\Settings\IManager
Implemented by:OC\Settings\Manager
Source:lib/public/Settings/IManager.php#32

Constants

KEY_ADMIN_SETTINGS = admin
Source:lib/public/Settings/IManager.php#36
Since:9.1.0
KEY_ADMIN_SECTION = admin-section
Source:lib/public/Settings/IManager.php#41
Since:9.1.0
KEY_PERSONAL_SETTINGS = personal
Source:lib/public/Settings/IManager.php#46
Since:13.0.0
KEY_PERSONAL_SECTION = personal-section
Source:lib/public/Settings/IManager.php#51
Since:13.0.0

Methods

public OCP\Settings\IManager::registerSection($type, $section)
Source:

lib/public/Settings/IManager.php#58

Parameters:
  • $type (string) ‘admin’ or ‘personal’
  • $section (string) Class must implement OCPSettingsISection
Since:

14.0.0

public OCP\Settings\IManager::registerSetting($type, $setting)
Source:

lib/public/Settings/IManager.php#65

Parameters:
  • $type (string) ‘admin’ or ‘personal’
  • $setting (string) Class must implement OCPSettingsISetting
Since:

14.0.0

public OCP\Settings\IManager::getAdminSections()
returns a list of the admin sections
Source:lib/public/Settings/IManager.php#73
Returns:array array of ISection[] where key is the priority
Since:9.1.0
public OCP\Settings\IManager::getPersonalSections()
returns a list of the personal sections
Source:lib/public/Settings/IManager.php#81
Returns:array array of ISection[] where key is the priority
Since:13.0.0
public OCP\Settings\IManager::getAdminSettings($section, $subAdminOnly=false)
returns a list of the admin settings
Source:

lib/public/Settings/IManager.php#91

Parameters:
  • $section (string) the section id for which to load the settings
  • $subAdminOnly (bool) only return settings sub admins are supposed to see (since 17.0.0)
Returns:

array array of IAdmin[] where key is the priority

Since:

9.1.0

public OCP\Settings\IManager::getPersonalSettings($section)
returns a list of the personal settings
Source:

lib/public/Settings/IManager.php#100

Parameters:
  • $section (string) the section id for which to load the settings
Returns:

array array of IPersonal[] where key is the priority

Since:

13.0.0