IDataCollector.php 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2022 Carl Schwan <carl@carlschwan.eu>
  5. *
  6. * @author Carl Schwan <carl@carlschwan.eu>
  7. * @author Fabien Potencier <fabien@symfony.com>
  8. *
  9. * @license AGPL-3.0-or-later AND MIT
  10. *
  11. * This program is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License as
  13. * published by the Free Software Foundation, either version 3 of the
  14. * License, or (at your option) any later version.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU Affero General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU Affero General Public License
  22. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23. *
  24. */
  25. namespace OCP\DataCollector;
  26. use OC\AppFramework\Http\Request;
  27. use OCP\AppFramework\Http\Response;
  28. /**
  29. * DataCollectorInterface.
  30. *
  31. * @since 24.0.0
  32. */
  33. interface IDataCollector {
  34. /**
  35. * Collects data for the given Request and Response.
  36. * @since 24.0.0
  37. */
  38. public function collect(Request $request, Response $response, ?\Throwable $exception = null): void;
  39. /**
  40. * Reset the state of the profiler.
  41. * @since 24.0.0
  42. */
  43. public function reset(): void;
  44. /**
  45. * Returns the name of the collector.
  46. * @since 24.0.0
  47. */
  48. public function getName(): string;
  49. }