ProviderSet.php 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2018 Christoph Wurst <christoph@winzerhof-wurst.at>
  5. *
  6. * @author 2018 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 OC\Authentication\TwoFactorAuth;
  25. use function array_filter;
  26. use OCA\TwoFactorBackupCodes\Provider\BackupCodesProvider;
  27. use OCP\Authentication\TwoFactorAuth\IProvider;
  28. /**
  29. * Contains all two-factor provider information for the two-factor login challenge
  30. */
  31. class ProviderSet {
  32. /** @var IProvider */
  33. private $providers;
  34. /** @var bool */
  35. private $providerMissing;
  36. /**
  37. * @param IProvider[] $providers
  38. * @param bool $providerMissing
  39. */
  40. public function __construct(array $providers, bool $providerMissing) {
  41. $this->providers = [];
  42. foreach ($providers as $provider) {
  43. $this->providers[$provider->getId()] = $provider;
  44. }
  45. $this->providerMissing = $providerMissing;
  46. }
  47. /**
  48. * @param string $providerId
  49. * @return IProvider|null
  50. */
  51. public function getProvider(string $providerId) {
  52. return $this->providers[$providerId] ?? null;
  53. }
  54. /**
  55. * @return IProvider[]
  56. */
  57. public function getProviders(): array {
  58. return $this->providers;
  59. }
  60. /**
  61. * @return IProvider[]
  62. */
  63. public function getPrimaryProviders(): array {
  64. return array_filter($this->providers, function(IProvider $provider) {
  65. return !($provider instanceof BackupCodesProvider);
  66. });
  67. }
  68. public function isProviderMissing(): bool {
  69. return $this->providerMissing;
  70. }
  71. }