Let 2FA providers provide their custom icons (dark/light)

Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>

1 files changed, 55 insertions, 0 deletions

diff --git a/lib/public/Authentication/TwoFactorAuth/IProvidesIcons.php b/lib/public/Authentication/TwoFactorAuth/IProvidesIcons.php
new file mode 100644
index 00000000000..4c9c809ae42
--- /dev/null
+++ b/lib/public/Authentication/TwoFactorAuth/IProvidesIcons.php
@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright 2018 Christoph Wurst <christoph@winzerhof-wurst.at>
+ *
+ * @author 2018 Christoph Wurst <christoph@winzerhof-wurst.at>
+ *
+ * @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\Authentication\TwoFactorAuth;
+
+/**
+ * Interface for two-factor providers that provide dark and light provider
+ * icons
+ *
+ * @since 15.0.0
+ */
+interface IProvidesIcons extends IProvider {
+
+	/**
+	 * Get the path to the light (white) icon of this provider
+	 *
+	 * @return String
+	 *
+	 * @since 15.0.0
+	 */
+	public function getLightIcon(): String;
+
+	/**
+	 * Get the path to the dark (black) icon of this provider
+	 *
+	 * @return String
+	 *
+	 * @since 15.0.0
+	 */
+	public function getDarkIcon(): String;
+
+}