IProvidesPersonalSettings.php 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2016 Christoph Wurst <christoph@winzerhof-wurst.at>
  5. *
  6. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  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\Authentication\TwoFactorAuth;
  25. use OCP\IUser;
  26. /**
  27. * Interface for admins that have personal settings. These settings will be shown in the
  28. * security sections. Some information like the display name of the provider is read
  29. * from the provider directly.
  30. *
  31. * @since 15.0.0
  32. */
  33. interface IProvidesPersonalSettings extends IProvider {
  34. /**
  35. * @param IUser $user
  36. *
  37. * @return IPersonalProviderSettings
  38. *
  39. * @since 15.0.0
  40. */
  41. public function getPersonalSettings(IUser $user): IPersonalProviderSettings;
  42. }