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.

46 lines
1.4 KiB

3 years ago
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2019, Roeland Jago Douma <roeland@famdouma.nl>
  5. *
  6. * @author Roeland Jago Douma <roeland@famdouma.nl>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCP\User\Backend;
  25. /**
  26. * @since 17.0.0
  27. */
  28. interface IGetRealUIDBackend {
  29. /**
  30. * Some backends accept different UIDs than what is the internal UID to be used.
  31. * For example the database backend accepts differnt cased UIDs in all the functions
  32. * but the internal UID that is to be used should be correctly cased.
  33. *
  34. * This little function makes sure that the used UID will be correct hen using the user object
  35. *
  36. * @since 17.0.0
  37. * @param string $uid
  38. * @return string
  39. */
  40. public function getRealUID(string $uid): string;
  41. }