src/Core/Session/Capability/IHandleUserSessions.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, 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  * This interface handles UserSessions, which is directly extended from the global Session interface
  26  */
  27 interface IHandleUserSessions extends IHandleSessions
  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 user nickname of locally logged-in user.
  38          *
  39          * @return string|false User's nickname or false
  40          */
  41         public function getLocalUserNickname();
  42
  43         /**
  44          * Returns the public contact id of logged-in user or false.
  45          *
  46          * @return int|bool public contact id or false
  47          */
  48         public function getPublicContactId();
  49
  50         /**
  51          * Returns public contact id of authenticated site visitor or false
  52          *
  53          * @return int|bool visitor_id or false
  54          */
  55         public function getRemoteUserId();
  56
  57         /**
  58          * Return the user contact ID of a visitor for the given user ID they are visiting
  59          *
  60          * @param int $uid User ID
  61          *
  62          * @return int
  63          */
  64         public function getRemoteContactID(int $uid): int;
  65
  66         /**
  67          * Returns User ID for given contact ID of the visitor
  68          *
  69          * @param int $cid Contact ID
  70          *
  71          * @return int User ID for given contact ID of the visitor
  72          */
  73         public function getUserIDForVisitorContactID(int $cid): int;
  74
  75         /**
  76          * Returns the account URL of the currently logged in user
  77          *
  78          * @return string
  79          */
  80         public function getMyUrl(): string;
  81
  82         /**
  83          * Returns if the current visitor is authenticated
  84          *
  85          * @return bool "true" when visitor is either a local or remote user
  86          */
  87         public function isAuthenticated(): bool;
  88
  89         /**
  90          * Check if current user has admin role.
  91          *
  92          * @return bool true if user is an admin
  93          */
  94         public function isSiteAdmin(): bool;
  95
  96         /**
  97          * Check if current user is a moderator.
  98          *
  99          * @return bool true if user is a moderator
 100          */
 101         public function isModerator(): bool;
 102
 103         /**
 104          * Returns User ID of the managed user in case it's a different identity
 105          *
 106          * @return int|bool uid of the manager or false
 107          */
 108         public function getSubManagedUserId();
 109
 110         /**
 111          * Sets the User ID of the managed user in case it's a different identity
 112          *
 113          * @param int $managed_uid The user id of the managing user
 114          */
 115         public function setSubManagedUserId(int $managed_uid): void;
 116
 117         /**
 118          * Set the session variable that contains the contact IDs for the visitor's contact URL
 119          *
 120          * @param string $my_url
 121          */
 122         public function setVisitorsContacts(string $my_url);
 123 }