BadRequestException.php 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
  4. *
  5. * @license GNU AGPL version 3 or any later version
  6. *
  7. * This program is free software: you can redistribute it and/or modify
  8. * it under the terms of the GNU Affero General Public License as
  9. * published by the Free Software Foundation, either version 3 of the
  10. * License, or (at your option) any later version.
  11. *
  12. * This program is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. * GNU Affero General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU Affero General Public License
  18. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  19. *
  20. */
  21. namespace OCP\Federation\Exceptions;
  22. use OC\HintException;
  23. /**
  24. * Class BadRequestException
  25. *
  26. * @package OCP\Federation\Exceptions
  27. *
  28. * @since 14.0.0
  29. */
  30. class BadRequestException extends HintException {
  31. private $parameterList;
  32. /**
  33. * BadRequestException constructor.
  34. *
  35. * @since 14.0.0
  36. *
  37. * @param array $missingParameters
  38. */
  39. public function __construct(array $missingParameters) {
  40. $l = \OC::$server->getL10N('federation');
  41. $this->parameterList = $missingParameters;
  42. $parameterList = implode(',', $missingParameters);
  43. $message = 'Parameters missing in order to complete the request. Missing Parameters: ' . $parameterList;
  44. $hint = $l->t('Parameters missing in order to complete the request. Missing Parameters: "%s"', [$parameterList]);
  45. parent::__construct($message, $hint);
  46. }
  47. /**
  48. * get array with the return message as defined in the OCM API
  49. *
  50. * @since 14.0.0
  51. *
  52. * @return array
  53. */
  54. public function getReturnMessage() {
  55. $result = [
  56. 'message' => 'RESOURCE_NOT_FOUND',
  57. 'validationErrors' =>[
  58. ]
  59. ];
  60. foreach ($this->parameterList as $missingParameter) {
  61. $result['validationErrors'] = [
  62. 'name' => $missingParameter,
  63. 'message' => 'NOT_FOUND'
  64. ];
  65. }
  66. return $result;
  67. }
  68. }