Nextcloud PHP API (stable19)

IManager

Tags
since
9.1

Table of Contents

KEY_ADMIN_SECTION  = 'admin-section'
KEY_ADMIN_SETTINGS  = 'admin'
KEY_PERSONAL_SECTION  = 'personal-section'
KEY_PERSONAL_SETTINGS  = 'personal'
getAdminSections()  : array
returns a list of the admin sections
getAdminSettings()  : array
returns a list of the admin settings
getPersonalSections()  : array
returns a list of the personal sections
getPersonalSettings()  : array
returns a list of the personal settings
registerSection()  : mixed
registerSetting()  : mixed

Constants

KEY_ADMIN_SECTION

public mixed KEY_ADMIN_SECTION = 'admin-section'
Tags
since
9.1.0

KEY_ADMIN_SETTINGS

public mixed KEY_ADMIN_SETTINGS = 'admin'
Tags
since
9.1.0

KEY_PERSONAL_SECTION

public mixed KEY_PERSONAL_SECTION = 'personal-section'
Tags
since
13.0.0

KEY_PERSONAL_SETTINGS

public mixed KEY_PERSONAL_SETTINGS = 'personal'
Tags
since
13.0.0

Methods

getAdminSections()

returns a list of the admin sections

public getAdminSections() : array
Tags
since
9.1.0
Return values
array —

array of ISection[] where key is the priority

getAdminSettings()

returns a list of the admin settings

public getAdminSettings(string $section[, bool $subAdminOnly = false ]) : array
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
since
9.1.0
Return values
array —

array of IAdmin[] where key is the priority

getPersonalSections()

returns a list of the personal sections

public getPersonalSections() : array
Tags
since
13.0.0
Return values
array —

array of ISection[] where key is the priority

getPersonalSettings()

returns a list of the personal settings

public getPersonalSettings(string $section) : array
Parameters
$section : string

the section id for which to load the settings

Tags
since
13.0.0
Return values
array —

array of IPersonal[] where key is the priority

registerSection()

public registerSection(string $type, string $section) : mixed
Parameters
$type : string

'admin' or 'personal'

$section : string

Class must implement OCP\Settings\ISection

Tags
since
14.0.0
Return values
mixed —

registerSetting()

public registerSetting(string $type, string $setting) : mixed
Parameters
$type : string

'admin' or 'personal'

$setting : string

Class must implement OCP\Settings\ISetting

Tags
since
14.0.0
Return values
mixed —

Search results