LoginResult.php 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2019 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 OC\Authentication\Login;
  25. use OC\Core\Controller\LoginController;
  26. class LoginResult {
  27. /** @var bool */
  28. private $success;
  29. /** @var LoginData */
  30. private $loginData;
  31. /** @var string|null */
  32. private $redirectUrl;
  33. /** @var string|null */
  34. private $errorMessage;
  35. private function __construct(bool $success, LoginData $loginData) {
  36. $this->success = $success;
  37. $this->loginData = $loginData;
  38. }
  39. private function setRedirectUrl(string $url) {
  40. $this->redirectUrl = $url;
  41. }
  42. private function setErrorMessage(string $msg) {
  43. $this->errorMessage = $msg;
  44. }
  45. public static function success(LoginData $data, ?string $redirectUrl = null) {
  46. $result = new static(true, $data);
  47. if ($redirectUrl !== null) {
  48. $result->setRedirectUrl($redirectUrl);
  49. }
  50. return $result;
  51. }
  52. /**
  53. * @param LoginController::LOGIN_MSG_*|null $msg
  54. */
  55. public static function failure(LoginData $data, ?string $msg = null): LoginResult {
  56. $result = new static(false, $data);
  57. if ($msg !== null) {
  58. $result->setErrorMessage($msg);
  59. }
  60. return $result;
  61. }
  62. public function isSuccess(): bool {
  63. return $this->success;
  64. }
  65. public function getRedirectUrl(): ?string {
  66. return $this->redirectUrl;
  67. }
  68. public function getErrorMessage(): ?string {
  69. return $this->errorMessage;
  70. }
  71. }