You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

65 lines
1.7 KiB

3 years ago
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Lukas Reschke <lukas@statuscode.ch>
  6. * @author Morris Jobke <hey@morrisjobke.de>
  7. * @author Roeland Jago Douma <roeland@famdouma.nl>
  8. * @author Thomas Müller <thomas.mueller@tmit.eu>
  9. *
  10. * @license AGPL-3.0
  11. *
  12. * This code is free software: you can redistribute it and/or modify
  13. * it under the terms of the GNU Affero General Public License, version 3,
  14. * as published by the Free Software Foundation.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU Affero General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU Affero General Public License, version 3,
  22. * along with this program. If not, see <http://www.gnu.org/licenses/>
  23. *
  24. */
  25. /**
  26. * Public interface of ownCloud for apps to use.
  27. * Authentication/IApacheBackend interface
  28. */
  29. // use OCP namespace for all classes that are considered public.
  30. // This means that they should be used by apps instead of the internal ownCloud classes
  31. namespace OCP\Authentication;
  32. /**
  33. * Interface IApacheBackend
  34. *
  35. * @since 6.0.0
  36. */
  37. interface IApacheBackend {
  38. /**
  39. * In case the user has been authenticated by a module true is returned.
  40. *
  41. * @return boolean whether the module reports a user as currently logged in.
  42. * @since 6.0.0
  43. */
  44. public function isSessionActive();
  45. /**
  46. * Gets the current logout URL
  47. *
  48. * @return string
  49. * @since 12.0.3
  50. */
  51. public function getLogoutUrl();
  52. /**
  53. * Return the id of the current user
  54. * @return string
  55. * @since 6.0.0
  56. */
  57. public function getCurrentUserId();
  58. }