summaryrefslogtreecommitdiffstats
path: root/lib/public
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public')
-rw-r--r--lib/public/Settings/IAdmin.php48
-rw-r--r--lib/public/Settings/IManager.php65
-rw-r--r--lib/public/Settings/ISection.php51
3 files changed, 164 insertions, 0 deletions
diff --git a/lib/public/Settings/IAdmin.php b/lib/public/Settings/IAdmin.php
new file mode 100644
index 00000000000..ce52e3da725
--- /dev/null
+++ b/lib/public/Settings/IAdmin.php
@@ -0,0 +1,48 @@
+<?php
+/**
+ * @copyright Copyright (c) 2016 Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Settings;
+
+use OCP\Template;
+
+interface IAdmin {
+
+ /**
+ * @return Template all parameters are supposed to be assigned
+ */
+ public function render();
+
+ /**
+ * @return string the section ID, e.g. 'sharing'
+ */
+ public function getSection();
+
+ /**
+ * @return int whether the form should be rather on the top or bottom of
+ * the admin section. The forms are arranged in ascending order of the
+ * priority values. It is required to return a value between 0 and 100.
+ *
+ * E.g.: 70
+ */
+ public function getPriority();
+}
diff --git a/lib/public/Settings/IManager.php b/lib/public/Settings/IManager.php
new file mode 100644
index 00000000000..ba0d9da59a3
--- /dev/null
+++ b/lib/public/Settings/IManager.php
@@ -0,0 +1,65 @@
+<?php
+/**
+ * @copyright Copyright (c) 2016 Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Settings;
+
+
+interface IManager {
+ /**
+ * @since 9.1.0
+ */
+ const KEY_ADMIN_SETTINGS = 'admin';
+
+ /**
+ * @since 9.1.0
+ */
+ const KEY_ADMIN_SECTION = 'admin-section';
+
+ /**
+ * sets up settings according to data specified by an apps info.xml, within
+ * the <settings> element.
+ *
+ * @param array $settings an associative array, allowed keys are as specified
+ * by the KEY_ constant of this interface. The value
+ * must always be a class name, implement either
+ * IAdmin or ISection. I.e. only one section and admin
+ * setting can be configured per app.
+ * @since 9.1.0
+ */
+ public function setupSettings(array $settings);
+
+ /**
+ * returns a list of the admin sections
+ *
+ * @return array array of ISection[] where key is the priority
+ */
+ public function getAdminSections();
+
+ /**
+ * returns a list of the admin settings
+ *
+ * @param string $section the section id for which to load the settings
+ * @return array array of IAdmin[] where key is the priority
+ */
+ public function getAdminSettings($section);
+}
diff --git a/lib/public/Settings/ISection.php b/lib/public/Settings/ISection.php
new file mode 100644
index 00000000000..7802c9b5d6c
--- /dev/null
+++ b/lib/public/Settings/ISection.php
@@ -0,0 +1,51 @@
+<?php
+/**
+ * @copyright Copyright (c) 2016 Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Settings;
+
+interface ISection {
+ /**
+ * returns the ID of the section. It is supposed to be a lower case string,
+ * e.g. 'ldap'
+ *
+ * @returns string
+ */
+ public function getID();
+
+ /**
+ * returns the translated name as it should be displayed, e.g. 'LDAP / AD
+ * integration'. Use the L10N service to translate it.
+ *
+ * @return string
+ */
+ public function getName();
+
+ /**
+ * @return int whether the form should be rather on the top or bottom of
+ * the settings navigation. The sections are arranged in ascending order of
+ * the priority values. It is required to return a value between 0 and 99.
+ *
+ * E.g.: 70
+ */
+ public function getPriority();
+}