You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

43 lines
1.6 KiB

3 years ago
  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 IProvider
  26. *
  27. * @since 11.0.0
  28. */
  29. interface IProvider {
  30. /**
  31. * @param string $language The language which should be used for translating, e.g. "en"
  32. * @param IEvent $event The current event which should be parsed
  33. * @param IEvent|null $previousEvent A potential previous event which you can combine with the current one.
  34. * To do so, simply use setChildEvent($previousEvent) after setting the
  35. * combined subject on the current event.
  36. * @return IEvent
  37. * @throws \InvalidArgumentException Should be thrown if your provider does not know this event
  38. * @since 11.0.0
  39. */
  40. public function parse($language, IEvent $event, IEvent $previousEvent = null);
  41. }