1
0

IRequestContext.php 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2020 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 OCP\Http\WellKnown;
  25. use OCP\IRequest;
  26. /**
  27. * The context object for \OCP\Http\IWellKnownHandler::handle
  28. *
  29. * Objects of this type will transport any optional information, e.g. the request
  30. * object through which the app well known handler can obtain URL parameters
  31. *
  32. * @since 21.0.0
  33. */
  34. interface IRequestContext {
  35. /**
  36. * @return IRequest
  37. *
  38. * @since 21.0.0
  39. */
  40. public function getHttpRequest(): IRequest;
  41. }