Move \OCP\Authentication to PSR-4 (#24632)

1 files changed, 64 insertions, 0 deletions

diff --git a/lib/public/Authentication/IApacheBackend.php b/lib/public/Authentication/IApacheBackend.php
new file mode 100644
index 00000000000..f1f408cfa6d
--- /dev/null
+++ b/lib/public/Authentication/IApacheBackend.php
@@ -0,0 +1,64 @@
+<?php
+/**
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Thomas Müller <thomas.mueller@tmit.eu>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+/**
+ * Public interface of ownCloud for apps to use.
+ * Authentication/IApacheBackend interface
+ */
+
+// use OCP namespace for all classes that are considered public.
+// This means that they should be used by apps instead of the internal ownCloud classes
+namespace OCP\Authentication;
+
+/**
+ * Interface IApacheBackend
+ *
+ * @package OCP\Authentication
+ * @since 6.0.0
+ */
+interface IApacheBackend {
+
+	/**
+	 * In case the user has been authenticated by Apache true is returned.
+	 *
+	 * @return boolean whether Apache reports a user as currently logged in.
+	 * @since 6.0.0
+	 */
+	public function isSessionActive();
+
+	/**
+	 * Creates an attribute which is added to the logout hyperlink. It can
+	 * supply any attribute(s) which are valid for <a>.
+	 *
+	 * @return string with one or more HTML attributes.
+	 * @since 6.0.0
+	 */
+	public function getLogoutAttribute();
+
+	/**
+	 * Return the id of the current user
+	 * @return string
+	 * @since 6.0.0
+	 */
+	public function getCurrentUserId();
+
+}