src/Core/Session/Capability/IHandleUserSessions.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  *
  20  */
  21
  22 namespace Friendica\Core\Session\Capability;
  23
  24 /**
  25  * Handles user infos based on session infos
  26  */
  27 interface IHandleUserSessions
  28 {
  29         /**
  30          * Returns the user id of locally logged-in user or false.
  31          *
  32          * @return int|bool user id or false
  33          */
  34         public function getLocalUserId();
  35
  36         /**
  37          * Returns the public contact id of logged-in user or false.
  38          *
  39          * @return int|bool public contact id or false
  40          */
  41         public function getPublicContactId();
  42
  43         /**
  44          * Returns public contact id of authenticated site visitor or false
  45          *
  46          * @return int|bool visitor_id or false
  47          */
  48         public function getRemoteUserId();
  49
  50         /**
  51          * Return the user contact ID of a visitor for the given user ID they are visiting
  52          *
  53          * @param int $uid User ID
  54          *
  55          * @return int
  56          */
  57         public function getRemoteContactID(int $uid): int;
  58
  59         /**
  60          * Returns User ID for given contact ID of the visitor
  61          *
  62          * @param int $cid Contact ID
  63          *
  64          * @return int User ID for given contact ID of the visitor
  65          */
  66         public function getUserIDForVisitorContactID(int $cid): int;
  67
  68         /**
  69          * Returns if the current visitor is authenticated
  70          *
  71          * @return bool "true" when visitor is either a local or remote user
  72          */
  73         public function isAuthenticated(): bool;
  74
  75         /**
  76          * Set the session variable that contains the contact IDs for the visitor's contact URL
  77          *
  78          * @param string $url Contact URL
  79          */
  80         public function setVisitorsContacts();
  81 }