IAlternativeLogin.php 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2020 Joas Schilling <coding@schilljs.com>
  5. *
  6. * @author Joas Schilling <coding@schilljs.com>
  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;
  25. /**
  26. * @since 20.0.0
  27. */
  28. interface IAlternativeLogin {
  29. /**
  30. * Label shown on the login option
  31. * @return string
  32. * @since 20.0.0
  33. */
  34. public function getLabel(): string;
  35. /**
  36. * Relative link to the login option
  37. * @return string
  38. * @since 20.0.0
  39. */
  40. public function getLink(): string;
  41. /**
  42. * CSS classes added to the alternative login option on the login screen
  43. * @return string
  44. * @since 20.0.0
  45. */
  46. public function getClass(): string;
  47. /**
  48. * Load necessary resources to present the login option, e.g. style-file to style the getClass()
  49. * @since 20.0.0
  50. */
  51. public function load(): void;
  52. }