Add SessionUsers class including tests

src/Core/Session/Capability/IHandleUserSessions.php

@@ -0,0 +1,81 @@
+<?php
+/**
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @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 <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace Friendica\Core\Session\Capability;
+
+/**
+ * Handles user infos based on session infos
+ */
+interface IHandleUserSessions
+{
+	/**
+	 * Returns the user id of locally logged-in user or false.
+	 *
+	 * @return int|bool user id or false
+	 */
+	public function getLocalUserId();
+
+	/**
+	 * Returns the public contact id of logged-in user or false.
+	 *
+	 * @return int|bool public contact id or false
+	 */
+	public function getPublicContactId();
+
+	/**
+	 * Returns public contact id of authenticated site visitor or false
+	 *
+	 * @return int|bool visitor_id or false
+	 */
+	public function getRemoteUserId();
+
+	/**
+	 * Return the user contact ID of a visitor for the given user ID they are visiting
+	 *
+	 * @param int $uid User ID
+	 *
+	 * @return int
+	 */
+	public function getRemoteContactID(int $uid): int;
+
+	/**
+	 * Returns User ID for given contact ID of the visitor
+	 *
+	 * @param int $cid Contact ID
+	 *
+	 * @return int User ID for given contact ID of the visitor
+	 */
+	public function getUserIDForVisitorContactID(int $cid): int;
+
+	/**
+	 * Returns if the current visitor is authenticated
+	 *
+	 * @return bool "true" when visitor is either a local or remote user
+	 */
+	public function isAuthenticated(): bool;
+
+	/**
+	 * Set the session variable that contains the contact IDs for the visitor's contact URL
+	 *
+	 * @param string $url Contact URL
+	 */
+	public function setVisitorsContacts();
+}