From b3b86a55fbdc49f98e585decea9fef066b8b546c Mon Sep 17 00:00:00 2001 From: jld3103 Date: Wed, 22 Nov 2023 14:00:34 +0100 Subject: [PATCH] chore(settings): Cleanup IManager and Manager type annotations Signed-off-by: jld3103 --- lib/private/Settings/Manager.php | 39 +++++++++++++++++--------------- lib/public/Settings/IManager.php | 24 +++++++++++--------- 2 files changed, 34 insertions(+), 29 deletions(-) diff --git a/lib/private/Settings/Manager.php b/lib/private/Settings/Manager.php index 2d44ac7d3df4c..e425db65c1b4c 100644 --- a/lib/private/Settings/Manager.php +++ b/lib/private/Settings/Manager.php @@ -12,6 +12,7 @@ * @author Roeland Jago Douma * @author sualko * @author Carl Schwan + * @author Kate Döen * * @license GNU AGPL version 3 or any later version * @@ -90,17 +91,14 @@ public function __construct( $this->subAdmin = $subAdmin; } - /** @var array */ + /** @var array<'admin'|'personal', list>> */ protected $sectionClasses = []; - /** @var array */ + /** @var array<'admin'|'personal', array> */ protected $sections = []; /** - * @param string $type 'admin' or 'personal' - * @param string $section Class must implement OCP\Settings\IIconSection - * - * @return void + * @inheritdoc */ public function registerSection(string $type, string $section) { if (!isset($this->sectionClasses[$type])) { @@ -111,7 +109,7 @@ public function registerSection(string $type, string $section) { } /** - * @param string $type 'admin' or 'personal' + * @psalm-param 'admin'|'personal' $type * * @return IIconSection[] */ @@ -149,6 +147,9 @@ protected function getSections(string $type): array { return $this->sections[$type]; } + /** + * @inheritdoc + */ public function getSection(string $type, string $sectionId): ?IIconSection { if (isset($this->sections[$type]) && isset($this->sections[$type][$sectionId])) { return $this->sections[$type][$sectionId]; @@ -163,27 +164,23 @@ protected function isKnownDuplicateSectionId(string $sectionID): bool { ], true); } - /** @var array */ + /** @var array, 'admin'|'personal'> */ protected $settingClasses = []; - /** @var array */ + /** @var array<'admin'|'personal', array>> */ protected $settings = []; /** - * @psam-param 'admin'|'personal' $type The type of the setting. - * @param string $setting Class must implement OCP\Settings\ISettings - * @param bool $allowedDelegation - * - * @return void + * @inheritdoc */ public function registerSetting(string $type, string $setting) { $this->settingClasses[$setting] = $type; } /** - * @param string $type 'admin' or 'personal' + * @psalm-param 'admin'|'personal' $type The type of the setting. * @param string $section - * @param Closure $filter optional filter to apply on all loaded ISettings + * @param ?Closure $filter optional filter to apply on all loaded ISettings * * @return ISettings[] */ @@ -258,7 +255,7 @@ public function getAdminSections(): array { /** * @inheritdoc */ - public function getAdminSettings($section, bool $subAdminOnly = false): array { + public function getAdminSettings(string $section, bool $subAdminOnly = false): array { if ($subAdminOnly) { $subAdminSettingsFilter = function (ISettings $settings) { return $settings instanceof ISubAdminSettings; @@ -329,7 +326,7 @@ private function hasLegacyPersonalSettingsToRender(array $forms): bool { /** * @inheritdoc */ - public function getPersonalSettings($section): array { + public function getPersonalSettings(string $section): array { $settings = []; $appSettings = $this->getSettings('personal', $section); @@ -344,6 +341,9 @@ public function getPersonalSettings($section): array { return $settings; } + /** + * @inheritdoc + */ public function getAllowedAdminSettings(string $section, IUser $user): array { $isAdmin = $this->groupManager->isAdmin($user->getUID()); if ($isAdmin) { @@ -375,6 +375,9 @@ public function getAllowedAdminSettings(string $section, IUser $user): array { return $settings; } + /** + * @inheritdoc + */ public function getAllAllowedAdminSettings(IUser $user): array { $this->getSettings('admin', ''); // Make sure all the settings are loaded $settings = []; diff --git a/lib/public/Settings/IManager.php b/lib/public/Settings/IManager.php index 10de596dbead4..a1fa6bc26bcdf 100644 --- a/lib/public/Settings/IManager.php +++ b/lib/public/Settings/IManager.php @@ -6,6 +6,7 @@ * @author Christoph Wurst * @author Joas Schilling * @author Lukas Reschke + * @author Kate Döen * * @license GNU AGPL version 3 or any later version * @@ -53,15 +54,15 @@ interface IManager { public const KEY_PERSONAL_SECTION = 'personal-section'; /** - * @param string $type 'admin-section' or 'personal-section' - * @param string $section Class must implement OCP\Settings\ISection + * @psalm-param 'admin'|'personal' $type + * @param class-string $section * @since 14.0.0 */ public function registerSection(string $type, string $section); /** - * @param string $type 'admin' or 'personal' - * @param string $setting Class must implement OCP\Settings\ISettings + * @psalm-param 'admin'|'personal' $type + * @param class-string $setting * @since 14.0.0 */ public function registerSetting(string $type, string $setting); @@ -69,7 +70,7 @@ public function registerSetting(string $type, string $setting); /** * returns a list of the admin sections * - * @return array> array from IConSection[] where key is the priority + * @return array> list of sections with priority as key * @since 9.1.0 */ public function getAdminSections(): array; @@ -77,7 +78,7 @@ public function getAdminSections(): array; /** * returns a list of the personal sections * - * @return array array of ISection[] where key is the priority + * @return array> list of sections with priority as key * @since 13.0.0 */ public function getPersonalSections(): array; @@ -87,10 +88,10 @@ public function getPersonalSections(): array; * * @param string $section the section id for which to load the settings * @param bool $subAdminOnly only return settings sub admins are supposed to see (since 17.0.0) - * @return array> array of ISettings[] where key is the priority + * @return array> list of settings with priority as key * @since 9.1.0 */ - public function getAdminSettings($section, bool $subAdminOnly = false): array; + public function getAdminSettings(string $section, bool $subAdminOnly = false): array; /** * Returns a list of admin settings that the given user can use for the give section @@ -103,7 +104,7 @@ public function getAllowedAdminSettings(string $section, IUser $user): array; /** * Returns a list of admin settings that the given user can use. * - * @return array> The array of admin settings there admin delegation is allowed. + * @return list The array of admin settings there admin delegation is allowed. * @since 23.0.0 */ public function getAllAllowedAdminSettings(IUser $user): array; @@ -112,13 +113,14 @@ public function getAllAllowedAdminSettings(IUser $user): array; * returns a list of the personal settings * * @param string $section the section id for which to load the settings - * @return array array of ISettings[] where key is the priority + * @return array> list of settings with priority as key * @since 13.0.0 */ - public function getPersonalSettings($section): array; + public function getPersonalSettings(string $section): array; /** * Get a specific section by type and id + * @psalm-param 'admin'|'personal' $type * @since 25.0.0 */ public function getSection(string $type, string $sectionId): ?IIconSection;