IGetRealUIDBackend.php 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2019, Roeland Jago Douma <roeland@famdouma.nl>
  5. *
  6. * @author Joas Schilling <coding@schilljs.com>
  7. * @author Roeland Jago Douma <roeland@famdouma.nl>
  8. *
  9. * @license GNU AGPL version 3 or any later version
  10. *
  11. * This program is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License as
  13. * published by the Free Software Foundation, either version 3 of the
  14. * License, or (at your option) any later version.
  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
  22. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23. *
  24. */
  25. namespace OCP\User\Backend;
  26. /**
  27. * @since 17.0.0
  28. */
  29. interface IGetRealUIDBackend {
  30. /**
  31. * Some backends accept different UIDs than what is the internal UID to be used.
  32. * For example the database backend accepts different cased UIDs in all the functions
  33. * but the internal UID that is to be used should be correctly cased.
  34. *
  35. * This little function makes sure that the used UID will be correct hen using the user object
  36. *
  37. * @since 17.0.0
  38. * @param string $uid
  39. * @return string
  40. */
  41. public function getRealUID(string $uid): string;
  42. }