BadRequestException.php 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
  4. *
  5. * @author Bjoern Schiessle <bjoern@schiessle.org>
  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\Federation\Exceptions;
  25. use OCP\HintException;
  26. /**
  27. * Class BadRequestException
  28. *
  29. *
  30. * @since 14.0.0
  31. */
  32. class BadRequestException extends HintException {
  33. private $parameterList;
  34. /**
  35. * BadRequestException constructor.
  36. *
  37. * @since 14.0.0
  38. *
  39. * @param array $missingParameters
  40. */
  41. public function __construct(array $missingParameters) {
  42. $l = \OC::$server->getL10N('federation');
  43. $this->parameterList = $missingParameters;
  44. $parameterList = implode(',', $missingParameters);
  45. $message = 'Parameters missing in order to complete the request. Missing Parameters: ' . $parameterList;
  46. $hint = $l->t('Parameters missing in order to complete the request. Missing Parameters: "%s"', [$parameterList]);
  47. parent::__construct($message, $hint);
  48. }
  49. /**
  50. * get array with the return message as defined in the OCM API
  51. *
  52. * @since 14.0.0
  53. *
  54. * @return array
  55. */
  56. public function getReturnMessage() {
  57. $result = [
  58. 'message' => 'RESOURCE_NOT_FOUND',
  59. 'validationErrors' => [
  60. ]
  61. ];
  62. foreach ($this->parameterList as $missingParameter) {
  63. $result['validationErrors'] = [
  64. 'name' => $missingParameter,
  65. 'message' => 'NOT_FOUND'
  66. ];
  67. }
  68. return $result;
  69. }
  70. }