IProvider.php 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016 Joas Schilling <coding@schilljs.com>
  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\Activity;
  22. /**
  23. * Interface IProvider
  24. *
  25. * @package OCP\Activity
  26. * @since 11.0.0
  27. */
  28. interface IProvider {
  29. /**
  30. * @param string $language The language which should be used for translating, e.g. "en"
  31. * @param IEvent $event The current event which should be parsed
  32. * @param IEvent|null $previousEvent A potential previous event which you can combine with the current one.
  33. * To do so, simply use setChildEvent($previousEvent) after setting the
  34. * combined subject on the current event.
  35. * @return IEvent
  36. * @throws \InvalidArgumentException Should be thrown if your provider does not know this event
  37. * @since 11.0.0
  38. */
  39. public function parse($language, IEvent $event, IEvent $previousEvent = null);
  40. }