aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/sabre/dav/lib/CalDAV/Backend/BackendInterface.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/sabre/dav/lib/CalDAV/Backend/BackendInterface.php')
-rw-r--r--vendor/sabre/dav/lib/CalDAV/Backend/BackendInterface.php57
1 files changed, 32 insertions, 25 deletions
diff --git a/vendor/sabre/dav/lib/CalDAV/Backend/BackendInterface.php b/vendor/sabre/dav/lib/CalDAV/Backend/BackendInterface.php
index bd8ee7602..7d125cf89 100644
--- a/vendor/sabre/dav/lib/CalDAV/Backend/BackendInterface.php
+++ b/vendor/sabre/dav/lib/CalDAV/Backend/BackendInterface.php
@@ -1,5 +1,7 @@
<?php
+declare(strict_types=1);
+
namespace Sabre\CalDAV\Backend;
/**
@@ -9,8 +11,8 @@ namespace Sabre\CalDAV\Backend;
* @author Evert Pot (http://evertpot.com/)
* @license http://sabre.io/license/ Modified BSD License
*/
-interface BackendInterface {
-
+interface BackendInterface
+{
/**
* Returns a list of calendars for a principal.
*
@@ -34,9 +36,10 @@ interface BackendInterface {
* ACL will automatically be put in read-only mode.
*
* @param string $principalUri
+ *
* @return array
*/
- function getCalendarsForUser($principalUri);
+ public function getCalendarsForUser($principalUri);
/**
* Creates a new calendar for a principal.
@@ -48,10 +51,11 @@ interface BackendInterface {
*
* @param string $principalUri
* @param string $calendarUri
- * @param array $properties
+ * @param array $properties
+ *
* @return mixed
*/
- function createCalendar($principalUri, $calendarUri, array $properties);
+ public function createCalendar($principalUri, $calendarUri, array $properties);
/**
* Updates properties for a calendar.
@@ -65,19 +69,17 @@ interface BackendInterface {
*
* Read the PropPatch documentation for more info and examples.
*
- * @param mixed $calendarId
+ * @param mixed $calendarId
* @param \Sabre\DAV\PropPatch $propPatch
- * @return void
*/
- function updateCalendar($calendarId, \Sabre\DAV\PropPatch $propPatch);
+ public function updateCalendar($calendarId, \Sabre\DAV\PropPatch $propPatch);
/**
- * Delete a calendar and all its objects
+ * Delete a calendar and all its objects.
*
* @param mixed $calendarId
- * @return void
*/
- function deleteCalendar($calendarId);
+ public function deleteCalendar($calendarId);
/**
* Returns all calendar objects within a calendar.
@@ -108,9 +110,10 @@ interface BackendInterface {
* amount of times this is needed is reduced by a great degree.
*
* @param mixed $calendarId
+ *
* @return array
*/
- function getCalendarObjects($calendarId);
+ public function getCalendarObjects($calendarId);
/**
* Returns information from a single calendar object, based on it's object
@@ -124,11 +127,12 @@ interface BackendInterface {
*
* This method must return null if the object did not exist.
*
- * @param mixed $calendarId
+ * @param mixed $calendarId
* @param string $objectUri
+ *
* @return array|null
*/
- function getCalendarObject($calendarId, $objectUri);
+ public function getCalendarObject($calendarId, $objectUri);
/**
* Returns a list of calendar objects.
@@ -140,9 +144,10 @@ interface BackendInterface {
*
* @param mixed $calendarId
* @param array $uris
+ *
* @return array
*/
- function getMultipleCalendarObjects($calendarId, array $uris);
+ public function getMultipleCalendarObjects($calendarId, array $uris);
/**
* Creates a new calendar object.
@@ -157,12 +162,13 @@ interface BackendInterface {
* calendar-data. If the result of a subsequent GET to this object is not
* the exact same as this request body, you should omit the ETag.
*
- * @param mixed $calendarId
+ * @param mixed $calendarId
* @param string $objectUri
* @param string $calendarData
+ *
* @return string|null
*/
- function createCalendarObject($calendarId, $objectUri, $calendarData);
+ public function createCalendarObject($calendarId, $objectUri, $calendarData);
/**
* Updates an existing calendarobject, based on it's uri.
@@ -177,23 +183,23 @@ interface BackendInterface {
* calendar-data. If the result of a subsequent GET to this object is not
* the exact same as this request body, you should omit the ETag.
*
- * @param mixed $calendarId
+ * @param mixed $calendarId
* @param string $objectUri
* @param string $calendarData
+ *
* @return string|null
*/
- function updateCalendarObject($calendarId, $objectUri, $calendarData);
+ public function updateCalendarObject($calendarId, $objectUri, $calendarData);
/**
* Deletes an existing calendar object.
*
* The object uri is only the basename, or filename and not a full path.
*
- * @param mixed $calendarId
+ * @param mixed $calendarId
* @param string $objectUri
- * @return void
*/
- function deleteCalendarObject($calendarId, $objectUri);
+ public function deleteCalendarObject($calendarId, $objectUri);
/**
* Performs a calendar-query on the contents of this calendar.
@@ -242,9 +248,10 @@ interface BackendInterface {
*
* @param mixed $calendarId
* @param array $filters
+ *
* @return array
*/
- function calendarQuery($calendarId, array $filters);
+ public function calendarQuery($calendarId, array $filters);
/**
* Searches through all of a users calendars and calendar objects to find
@@ -263,8 +270,8 @@ interface BackendInterface {
*
* @param string $principalUri
* @param string $uid
+ *
* @return string|null
*/
- function getCalendarObjectByUID($principalUri, $uid);
-
+ public function getCalendarObjectByUID($principalUri, $uid);
}