3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Core\Session\Capability;
25 * Handles user infos based on session infos
27 interface IHandleUserSessions
30 * Returns the user id of locally logged-in user or false.
32 * @return int|bool user id or false
34 public function getLocalUserId();
37 * Returns the public contact id of logged-in user or false.
39 * @return int|bool public contact id or false
41 public function getPublicContactId();
44 * Returns public contact id of authenticated site visitor or false
46 * @return int|bool visitor_id or false
48 public function getRemoteUserId();
51 * Return the user contact ID of a visitor for the given user ID they are visiting
53 * @param int $uid User ID
57 public function getRemoteContactID(int $uid): int;
60 * Returns User ID for given contact ID of the visitor
62 * @param int $cid Contact ID
64 * @return int User ID for given contact ID of the visitor
66 public function getUserIDForVisitorContactID(int $cid): int;
69 * Returns if the current visitor is authenticated
71 * @return bool "true" when visitor is either a local or remote user
73 public function isAuthenticated(): bool;
76 * Set the session variable that contains the contact IDs for the visitor's contact URL
78 * @param string $url Contact URL
80 public function setVisitorsContacts();