IApacheBackend.php 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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. // use OCP namespace for all classes that are considered public.
  26. // This means that they should be used by apps instead of the internal ownCloud classes
  27. namespace OCP\Authentication;
  28. /**
  29. * Interface IApacheBackend
  30. *
  31. * @since 6.0.0
  32. */
  33. interface IApacheBackend {
  34. /**
  35. * In case the user has been authenticated by a module true is returned.
  36. *
  37. * @return boolean whether the module reports a user as currently logged in.
  38. * @since 6.0.0
  39. */
  40. public function isSessionActive();
  41. /**
  42. * Gets the current logout URL
  43. *
  44. * @return string
  45. * @since 12.0.3
  46. */
  47. public function getLogoutUrl();
  48. /**
  49. * Return the id of the current user
  50. * @return string
  51. * @since 6.0.0
  52. */
  53. public function getCurrentUserId();
  54. }