From 14ddf9d923ba78a9b938d6eb6050d71aaef22ed6 Mon Sep 17 00:00:00 2001
From: Arthur Schiwon <blizzz@arthur-schiwon.de>
Date: Thu, 11 Aug 2016 14:48:21 +0200
Subject: [PATCH] rename IAdmin to ISettings, the interface is not bound to a
specific settings scope
---
apps/encryption/lib/Settings/Admin.php | 4 ++--
.../lib/Controller/AdminController.php | 4 ++--
apps/user_ldap/lib/Settings/Admin.php | 4 ++--
lib/private/Settings/Admin/Encryption.php | 4 ++--
lib/private/Settings/Admin/Logging.php | 4 ++--
lib/private/Settings/Admin/Server.php | 4 ++--
lib/private/Settings/Admin/Sharing.php | 4 ++--
lib/private/Settings/Admin/TipsTricks.php | 4 ++--
lib/private/Settings/Manager.php | 20 +++++++++----------
.../Settings/{IAdmin.php => ISettings.php} | 5 ++++-
.../Controller/AdminSettingsController.php | 2 +-
11 files changed, 31 insertions(+), 28 deletions(-)
rename lib/public/Settings/{IAdmin.php => ISettings.php} (95%)
diff --git a/apps/encryption/lib/Settings/Admin.php b/apps/encryption/lib/Settings/Admin.php
index 71a365caee1..2faa118e2a2 100644
--- a/apps/encryption/lib/Settings/Admin.php
+++ b/apps/encryption/lib/Settings/Admin.php
@@ -33,10 +33,10 @@ use OCP\ILogger;
use OCP\ISession;
use OCP\IUserManager;
use OCP\IUserSession;
-use OCP\Settings\IAdmin;
+use OCP\Settings\ISettings;
use OCP\IConfig;
-class Admin implements IAdmin {
+class Admin implements ISettings {
/** @var IL10N */
private $l;
diff --git a/apps/updatenotification/lib/Controller/AdminController.php b/apps/updatenotification/lib/Controller/AdminController.php
index 5f137120435..3c6ab463059 100644
--- a/apps/updatenotification/lib/Controller/AdminController.php
+++ b/apps/updatenotification/lib/Controller/AdminController.php
@@ -34,9 +34,9 @@ use OCP\IDateTimeFormatter;
use OCP\IL10N;
use OCP\IRequest;
use OCP\Security\ISecureRandom;
-use OCP\Settings\IAdmin;
+use OCP\Settings\ISettings;
-class AdminController extends Controller implements IAdmin {
+class AdminController extends Controller implements ISettings {
/** @var IJobList */
private $jobList;
/** @var ISecureRandom */
diff --git a/apps/user_ldap/lib/Settings/Admin.php b/apps/user_ldap/lib/Settings/Admin.php
index f155f1cec8d..606cfe6cf01 100644
--- a/apps/user_ldap/lib/Settings/Admin.php
+++ b/apps/user_ldap/lib/Settings/Admin.php
@@ -27,10 +27,10 @@ use OCA\User_LDAP\Configuration;
use OCA\User_LDAP\Helper;
use OCP\AppFramework\Http\TemplateResponse;
use OCP\IL10N;
-use OCP\Settings\IAdmin;
+use OCP\Settings\ISettings;
use OCP\Template;
-class Admin implements IAdmin {
+class Admin implements ISettings {
/** @var IL10N */
private $l;
diff --git a/lib/private/Settings/Admin/Encryption.php b/lib/private/Settings/Admin/Encryption.php
index 331ddf54520..ceae5aa6d3f 100644
--- a/lib/private/Settings/Admin/Encryption.php
+++ b/lib/private/Settings/Admin/Encryption.php
@@ -26,9 +26,9 @@ namespace OC\Settings\Admin;
use OC\Encryption\Manager;
use OCP\AppFramework\Http\TemplateResponse;
use OCP\IUserManager;
-use OCP\Settings\IAdmin;
+use OCP\Settings\ISettings;
-class Encryption implements IAdmin {
+class Encryption implements ISettings {
/** @var Manager */
private $manager;
diff --git a/lib/private/Settings/Admin/Logging.php b/lib/private/Settings/Admin/Logging.php
index b05ea93388d..3097070577d 100644
--- a/lib/private/Settings/Admin/Logging.php
+++ b/lib/private/Settings/Admin/Logging.php
@@ -26,9 +26,9 @@ namespace OC\Settings\Admin;
use OC\Log\File as LogFile;
use OCP\AppFramework\Http\TemplateResponse;
use OCP\IConfig;
-use OCP\Settings\IAdmin;
+use OCP\Settings\ISettings;
-class Logging implements IAdmin {
+class Logging implements ISettings {
/** @var IConfig */
private $config;
diff --git a/lib/private/Settings/Admin/Server.php b/lib/private/Settings/Admin/Server.php
index ee2da154da2..4f1edcf4691 100644
--- a/lib/private/Settings/Admin/Server.php
+++ b/lib/private/Settings/Admin/Server.php
@@ -29,9 +29,9 @@ use Doctrine\DBAL\Platforms\SqlitePlatform;
use OCP\AppFramework\Http\TemplateResponse;
use OCP\IConfig;
use OCP\IDBConnection;
-use OCP\Settings\IAdmin;
+use OCP\Settings\ISettings;
-class Server implements IAdmin {
+class Server implements ISettings {
/** @var IDBConnection|Connection */
private $db;
diff --git a/lib/private/Settings/Admin/Sharing.php b/lib/private/Settings/Admin/Sharing.php
index 088021f9057..d186dbed981 100644
--- a/lib/private/Settings/Admin/Sharing.php
+++ b/lib/private/Settings/Admin/Sharing.php
@@ -25,9 +25,9 @@ namespace OC\Settings\Admin;
use OCP\AppFramework\Http\TemplateResponse;
use OCP\IConfig;
-use OCP\Settings\IAdmin;
+use OCP\Settings\ISettings;
-class Sharing implements IAdmin {
+class Sharing implements ISettings {
/** @var IConfig */
private $config;
diff --git a/lib/private/Settings/Admin/TipsTricks.php b/lib/private/Settings/Admin/TipsTricks.php
index 331c33db1c1..217ddacd443 100644
--- a/lib/private/Settings/Admin/TipsTricks.php
+++ b/lib/private/Settings/Admin/TipsTricks.php
@@ -25,9 +25,9 @@ namespace OC\Settings\Admin;
use OCP\AppFramework\Http\TemplateResponse;
use OCP\IConfig;
-use OCP\Settings\IAdmin;
+use OCP\Settings\ISettings;
-class TipsTricks implements IAdmin {
+class TipsTricks implements ISettings {
/** @var IConfig */
private $config;
diff --git a/lib/private/Settings/Manager.php b/lib/private/Settings/Manager.php
index fa762003c1d..4c96dd07fde 100644
--- a/lib/private/Settings/Manager.php
+++ b/lib/private/Settings/Manager.php
@@ -30,7 +30,7 @@ use OCP\IDBConnection;
use OCP\IL10N;
use OCP\ILogger;
use OCP\IUserManager;
-use OCP\Settings\IAdmin;
+use OCP\Settings\ISettings;
use OCP\Settings\IManager;
use OCP\Settings\ISection;
@@ -119,7 +119,7 @@ class Manager implements IManager {
]);
}
- private function addAdminSettings(IAdmin $settings) {
+ private function addAdminSettings(ISettings $settings) {
$this->add(self::TABLE_ADMIN_SETTINGS, [
'class' => get_class($settings),
'section' => $settings->getSection(),
@@ -136,7 +136,7 @@ class Manager implements IManager {
$query->execute();
}
- private function updateAdminSettings(IAdmin $settings) {
+ private function updateAdminSettings(ISettings $settings) {
$this->update(
self::TABLE_ADMIN_SETTINGS,
'class',
@@ -210,14 +210,14 @@ class Manager implements IManager {
}
try {
- /** @var IAdmin $settings */
+ /** @var ISettings $settings */
$settings = $this->query($settingsClassName);
} catch (QueryException $e) {
// cancel
return;
}
- if(!$settings instanceof IAdmin) {
+ if(!$settings instanceof ISettings) {
$this->log->error(
'Admin section instance must implement \OCP\ISection. Invalid class: {class}',
['class' => $settingsClassName]
@@ -283,27 +283,27 @@ class Manager implements IManager {
$forms = [];
try {
if($section === 'server') {
- /** @var IAdmin $form */
+ /** @var ISettings $form */
$form = new Admin\Server($this->dbc, $this->config);
$forms[$form->getPriority()] = [$form];
}
if($section === 'encryption') {
- /** @var IAdmin $form */
+ /** @var ISettings $form */
$form = new Admin\Encryption($this->encryptionManager, $this->userManager);
$forms[$form->getPriority()] = [$form];
}
if($section === 'sharing') {
- /** @var IAdmin $form */
+ /** @var ISettings $form */
$form = new Admin\Sharing($this->config);
$forms[$form->getPriority()] = [$form];
}
if($section === 'logging') {
- /** @var IAdmin $form */
+ /** @var ISettings $form */
$form = new Admin\Logging($this->config);
$forms[$form->getPriority()] = [$form];
}
if($section === 'tips-tricks') {
- /** @var IAdmin $form */
+ /** @var ISettings $form */
$form = new Admin\TipsTricks($this->config);
$forms[$form->getPriority()] = [$form];
}
diff --git a/lib/public/Settings/IAdmin.php b/lib/public/Settings/ISettings.php
similarity index 95%
rename from lib/public/Settings/IAdmin.php
rename to lib/public/Settings/ISettings.php
index 74977256a18..07d265a533e 100644
--- a/lib/public/Settings/IAdmin.php
+++ b/lib/public/Settings/ISettings.php
@@ -25,15 +25,17 @@ namespace OCP\Settings;
use OCP\AppFramework\Http\TemplateResponse;
-interface IAdmin {
+interface ISettings {
/**
* @return TemplateResponse returns the instance with all parameters set, ready to be rendered
+ * @since 9.1
*/
public function getForm();
/**
* @return string the section ID, e.g. 'sharing'
+ * @since 9.1
*/
public function getSection();
@@ -43,6 +45,7 @@ interface IAdmin {
* priority values. It is required to return a value between 0 and 100.
*
* E.g.: 70
+ * @since 9.1
*/
public function getPriority();
}
diff --git a/settings/Controller/AdminSettingsController.php b/settings/Controller/AdminSettingsController.php
index f27bdd3ec33..271aa05265b 100644
--- a/settings/Controller/AdminSettingsController.php
+++ b/settings/Controller/AdminSettingsController.php
@@ -91,7 +91,7 @@ class AdminSettingsController extends Controller {
$html = '';
foreach ($settings as $prioritizedSettings) {
foreach ($prioritizedSettings as $setting) {
- /** @var \OCP\Settings\IAdmin $setting */
+ /** @var \OCP\Settings\ISettings $setting */
$form = $setting->getForm();
$html .= $form->renderAs('')->render();
}
--
GitLab