IEventMerger.php 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016 Joas Schilling <coding@schilljs.com>
  4. *
  5. * @author Joas Schilling <coding@schilljs.com>
  6. *
  7. * @license GNU AGPL version 3 or any later version
  8. *
  9. * This program is free software: you can redistribute it and/or modify
  10. * it under the terms of the GNU Affero General Public License as
  11. * published by the Free Software Foundation, either version 3 of the
  12. * License, or (at your option) any later version.
  13. *
  14. * This program is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. * GNU Affero General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU Affero General Public License
  20. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  21. *
  22. */
  23. namespace OCP\Activity;
  24. /**
  25. * Interface EventMerger
  26. *
  27. * @since 11.0
  28. */
  29. interface IEventMerger {
  30. /**
  31. * Combines two events when possible to have grouping:
  32. *
  33. * Example1: Two events with subject '{user} created {file}' and
  34. * $mergeParameter file with different file and same user will be merged
  35. * to '{user} created {file1} and {file2}' and the childEvent on the return
  36. * will be set, if the events have been merged.
  37. *
  38. * Example2: Two events with subject '{user} created {file}' and
  39. * $mergeParameter file with same file and same user will be merged to
  40. * '{user} created {file1}' and the childEvent on the return will be set, if
  41. * the events have been merged.
  42. *
  43. * The following requirements have to be met, in order to be merged:
  44. * - Both events need to have the same `getApp()`
  45. * - Both events must not have a message `getMessage()`
  46. * - Both events need to have the same subject `getSubject()`
  47. * - Both events need to have the same object type `getObjectType()`
  48. * - The time difference between both events must not be bigger then 3 hours
  49. * - Only up to 5 events can be merged.
  50. * - All parameters apart from such starting with $mergeParameter must be
  51. * the same for both events.
  52. *
  53. * @param string $mergeParameter
  54. * @param IEvent $event
  55. * @param IEvent|null $previousEvent
  56. * @return IEvent
  57. * @since 11.0
  58. */
  59. public function mergeEvents($mergeParameter, IEvent $event, ?IEvent $previousEvent = null);
  60. }