@@ -67,7 +67,7 @@ |
||
| 67 | 67 | * @return array an array of events/journals/todos which are arrays of arrays of key-value-pairs |
| 68 | 68 | * @since 13.0.0 |
| 69 | 69 | */ |
| 70 | - public function search($pattern, array $searchProperties=[], array $options=[], $limit=null, $offset=null); |
|
| 70 | + public function search($pattern, array $searchProperties = [], array $options = [], $limit = null, $offset = null); |
|
| 71 | 71 | |
| 72 | 72 | /** |
| 73 | 73 | * Check if calendars are available |
@@ -54,67 +54,67 @@ |
||
| 54 | 54 | */ |
| 55 | 55 | interface IManager { |
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * This function is used to search and find objects within the user's calendars. |
|
| 59 | - * In case $pattern is empty all events/journals/todos will be returned. |
|
| 60 | - * |
|
| 61 | - * @param string $pattern which should match within the $searchProperties |
|
| 62 | - * @param array $searchProperties defines the properties within the query pattern should match |
|
| 63 | - * @param array $options - optional parameters: |
|
| 64 | - * ['timerange' => ['start' => new DateTime(...), 'end' => new DateTime(...)]] |
|
| 65 | - * @param integer|null $limit - limit number of search results |
|
| 66 | - * @param integer|null $offset - offset for paging of search results |
|
| 67 | - * @return array an array of events/journals/todos which are arrays of arrays of key-value-pairs |
|
| 68 | - * @since 13.0.0 |
|
| 69 | - */ |
|
| 70 | - public function search($pattern, array $searchProperties=[], array $options=[], $limit=null, $offset=null); |
|
| 57 | + /** |
|
| 58 | + * This function is used to search and find objects within the user's calendars. |
|
| 59 | + * In case $pattern is empty all events/journals/todos will be returned. |
|
| 60 | + * |
|
| 61 | + * @param string $pattern which should match within the $searchProperties |
|
| 62 | + * @param array $searchProperties defines the properties within the query pattern should match |
|
| 63 | + * @param array $options - optional parameters: |
|
| 64 | + * ['timerange' => ['start' => new DateTime(...), 'end' => new DateTime(...)]] |
|
| 65 | + * @param integer|null $limit - limit number of search results |
|
| 66 | + * @param integer|null $offset - offset for paging of search results |
|
| 67 | + * @return array an array of events/journals/todos which are arrays of arrays of key-value-pairs |
|
| 68 | + * @since 13.0.0 |
|
| 69 | + */ |
|
| 70 | + public function search($pattern, array $searchProperties=[], array $options=[], $limit=null, $offset=null); |
|
| 71 | 71 | |
| 72 | - /** |
|
| 73 | - * Check if calendars are available |
|
| 74 | - * |
|
| 75 | - * @return bool true if enabled, false if not |
|
| 76 | - * @since 13.0.0 |
|
| 77 | - */ |
|
| 78 | - public function isEnabled(); |
|
| 72 | + /** |
|
| 73 | + * Check if calendars are available |
|
| 74 | + * |
|
| 75 | + * @return bool true if enabled, false if not |
|
| 76 | + * @since 13.0.0 |
|
| 77 | + */ |
|
| 78 | + public function isEnabled(); |
|
| 79 | 79 | |
| 80 | - /** |
|
| 81 | - * Registers a calendar |
|
| 82 | - * |
|
| 83 | - * @param ICalendar $calendar |
|
| 84 | - * @return void |
|
| 85 | - * @since 13.0.0 |
|
| 86 | - */ |
|
| 87 | - public function registerCalendar(ICalendar $calendar); |
|
| 80 | + /** |
|
| 81 | + * Registers a calendar |
|
| 82 | + * |
|
| 83 | + * @param ICalendar $calendar |
|
| 84 | + * @return void |
|
| 85 | + * @since 13.0.0 |
|
| 86 | + */ |
|
| 87 | + public function registerCalendar(ICalendar $calendar); |
|
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Unregisters a calendar |
|
| 91 | - * |
|
| 92 | - * @param ICalendar $calendar |
|
| 93 | - * @return void |
|
| 94 | - * @since 13.0.0 |
|
| 95 | - */ |
|
| 96 | - public function unregisterCalendar(ICalendar $calendar); |
|
| 89 | + /** |
|
| 90 | + * Unregisters a calendar |
|
| 91 | + * |
|
| 92 | + * @param ICalendar $calendar |
|
| 93 | + * @return void |
|
| 94 | + * @since 13.0.0 |
|
| 95 | + */ |
|
| 96 | + public function unregisterCalendar(ICalendar $calendar); |
|
| 97 | 97 | |
| 98 | - /** |
|
| 99 | - * In order to improve lazy loading a closure can be registered which will be called in case |
|
| 100 | - * calendars are actually requested |
|
| 101 | - * |
|
| 102 | - * @param \Closure $callable |
|
| 103 | - * @return void |
|
| 104 | - * @since 13.0.0 |
|
| 105 | - */ |
|
| 106 | - public function register(\Closure $callable); |
|
| 98 | + /** |
|
| 99 | + * In order to improve lazy loading a closure can be registered which will be called in case |
|
| 100 | + * calendars are actually requested |
|
| 101 | + * |
|
| 102 | + * @param \Closure $callable |
|
| 103 | + * @return void |
|
| 104 | + * @since 13.0.0 |
|
| 105 | + */ |
|
| 106 | + public function register(\Closure $callable); |
|
| 107 | 107 | |
| 108 | - /** |
|
| 109 | - * @return []ICalendar |
|
| 110 | - * @since 13.0.0 |
|
| 111 | - */ |
|
| 112 | - public function getCalendars(); |
|
| 108 | + /** |
|
| 109 | + * @return []ICalendar |
|
| 110 | + * @since 13.0.0 |
|
| 111 | + */ |
|
| 112 | + public function getCalendars(); |
|
| 113 | 113 | |
| 114 | - /** |
|
| 115 | - * removes all registered calendar instances |
|
| 116 | - * @return void |
|
| 117 | - * @since 13.0.0 |
|
| 118 | - */ |
|
| 119 | - public function clear(); |
|
| 114 | + /** |
|
| 115 | + * removes all registered calendar instances |
|
| 116 | + * @return void |
|
| 117 | + * @since 13.0.0 |
|
| 118 | + */ |
|
| 119 | + public function clear(); |
|
| 120 | 120 | } |
@@ -54,7 +54,7 @@ |
||
| 54 | 54 | * @return array an array of events/journals/todos which are arrays of key-value-pairs |
| 55 | 55 | * @since 13.0.0 |
| 56 | 56 | */ |
| 57 | - public function search($pattern, array $searchProperties=[], array $options=[], $limit=null, $offset=null); |
|
| 57 | + public function search($pattern, array $searchProperties = [], array $options = [], $limit = null, $offset = null); |
|
| 58 | 58 | |
| 59 | 59 | /** |
| 60 | 60 | * @return integer build up using \OCP\Constants |
@@ -31,41 +31,41 @@ |
||
| 31 | 31 | */ |
| 32 | 32 | interface ICalendar { |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * @return string defining the technical unique key |
|
| 36 | - * @since 13.0.0 |
|
| 37 | - */ |
|
| 38 | - public function getKey(); |
|
| 34 | + /** |
|
| 35 | + * @return string defining the technical unique key |
|
| 36 | + * @since 13.0.0 |
|
| 37 | + */ |
|
| 38 | + public function getKey(); |
|
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * In comparison to getKey() this function returns a human readable (maybe translated) name |
|
| 42 | - * @return null|string |
|
| 43 | - * @since 13.0.0 |
|
| 44 | - */ |
|
| 45 | - public function getDisplayName(); |
|
| 40 | + /** |
|
| 41 | + * In comparison to getKey() this function returns a human readable (maybe translated) name |
|
| 42 | + * @return null|string |
|
| 43 | + * @since 13.0.0 |
|
| 44 | + */ |
|
| 45 | + public function getDisplayName(); |
|
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * Calendar color |
|
| 49 | - * @return null|string |
|
| 50 | - * @since 13.0.0 |
|
| 51 | - */ |
|
| 52 | - public function getDisplayColor(); |
|
| 47 | + /** |
|
| 48 | + * Calendar color |
|
| 49 | + * @return null|string |
|
| 50 | + * @since 13.0.0 |
|
| 51 | + */ |
|
| 52 | + public function getDisplayColor(); |
|
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * @param string $pattern which should match within the $searchProperties |
|
| 56 | - * @param array $searchProperties defines the properties within the query pattern should match |
|
| 57 | - * @param array $options - optional parameters: |
|
| 58 | - * ['timerange' => ['start' => new DateTime(...), 'end' => new DateTime(...)]] |
|
| 59 | - * @param integer|null $limit - limit number of search results |
|
| 60 | - * @param integer|null $offset - offset for paging of search results |
|
| 61 | - * @return array an array of events/journals/todos which are arrays of key-value-pairs |
|
| 62 | - * @since 13.0.0 |
|
| 63 | - */ |
|
| 64 | - public function search($pattern, array $searchProperties=[], array $options=[], $limit=null, $offset=null); |
|
| 54 | + /** |
|
| 55 | + * @param string $pattern which should match within the $searchProperties |
|
| 56 | + * @param array $searchProperties defines the properties within the query pattern should match |
|
| 57 | + * @param array $options - optional parameters: |
|
| 58 | + * ['timerange' => ['start' => new DateTime(...), 'end' => new DateTime(...)]] |
|
| 59 | + * @param integer|null $limit - limit number of search results |
|
| 60 | + * @param integer|null $offset - offset for paging of search results |
|
| 61 | + * @return array an array of events/journals/todos which are arrays of key-value-pairs |
|
| 62 | + * @since 13.0.0 |
|
| 63 | + */ |
|
| 64 | + public function search($pattern, array $searchProperties=[], array $options=[], $limit=null, $offset=null); |
|
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * @return integer build up using \OCP\Constants |
|
| 68 | - * @since 13.0.0 |
|
| 69 | - */ |
|
| 70 | - public function getPermissions(); |
|
| 66 | + /** |
|
| 67 | + * @return integer build up using \OCP\Constants |
|
| 68 | + * @since 13.0.0 |
|
| 69 | + */ |
|
| 70 | + public function getPermissions(); |
|
| 71 | 71 | } |