1
0

ICalendar.php 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. <?php
  2. /**
  3. * @copyright 2017, Georg Ehrke <oc.list@georgehrke.com>
  4. *
  5. * @author Georg Ehrke <oc.list@georgehrke.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\Calendar;
  24. /**
  25. * Interface ICalendar
  26. *
  27. * @package OCP
  28. * @since 13.0.0
  29. */
  30. interface ICalendar {
  31. /**
  32. * @return string defining the technical unique key
  33. * @since 13.0.0
  34. */
  35. public function getKey();
  36. /**
  37. * In comparison to getKey() this function returns a human readable (maybe translated) name
  38. * @return null|string
  39. * @since 13.0.0
  40. */
  41. public function getDisplayName();
  42. /**
  43. * Calendar color
  44. * @return null|string
  45. * @since 13.0.0
  46. */
  47. public function getDisplayColor();
  48. /**
  49. * @param string $pattern which should match within the $searchProperties
  50. * @param array $searchProperties defines the properties within the query pattern should match
  51. * @param array $options - optional parameters:
  52. * ['timerange' => ['start' => new DateTime(...), 'end' => new DateTime(...)]]
  53. * @param integer|null $limit - limit number of search results
  54. * @param integer|null $offset - offset for paging of search results
  55. * @return array an array of events/journals/todos which are arrays of key-value-pairs
  56. * @since 13.0.0
  57. */
  58. public function search($pattern, array $searchProperties=[], array $options=[], $limit=null, $offset=null);
  59. /**
  60. * @return integer build up using \OCP\Constants
  61. * @since 13.0.0
  62. */
  63. public function getPermissions();
  64. }