@@ -32,54 +32,54 @@ |
||
| 32 | 32 | * @since 24.0.0 |
| 33 | 33 | */ |
| 34 | 34 | interface IExportDestination { |
| 35 | - /** |
|
| 36 | - * Adds a file to the export |
|
| 37 | - * |
|
| 38 | - * @param string $path Full path to the file in the export archive. Parent directories will be created if needed. |
|
| 39 | - * @param string $content The full content of the file. |
|
| 40 | - * @throws UserMigrationException |
|
| 41 | - * |
|
| 42 | - * @since 24.0.0 |
|
| 43 | - */ |
|
| 44 | - public function addFileContents(string $path, string $content): void; |
|
| 35 | + /** |
|
| 36 | + * Adds a file to the export |
|
| 37 | + * |
|
| 38 | + * @param string $path Full path to the file in the export archive. Parent directories will be created if needed. |
|
| 39 | + * @param string $content The full content of the file. |
|
| 40 | + * @throws UserMigrationException |
|
| 41 | + * |
|
| 42 | + * @since 24.0.0 |
|
| 43 | + */ |
|
| 44 | + public function addFileContents(string $path, string $content): void; |
|
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * Adds a file to the export as a stream |
|
| 48 | - * |
|
| 49 | - * @param string $path Full path to the file in the export archive. Parent directories will be created if needed. |
|
| 50 | - * @param resource $stream A stream resource to read from to get the file content. |
|
| 51 | - * @throws UserMigrationException |
|
| 52 | - * |
|
| 53 | - * @since 24.0.0 |
|
| 54 | - */ |
|
| 55 | - public function addFileAsStream(string $path, $stream): void; |
|
| 46 | + /** |
|
| 47 | + * Adds a file to the export as a stream |
|
| 48 | + * |
|
| 49 | + * @param string $path Full path to the file in the export archive. Parent directories will be created if needed. |
|
| 50 | + * @param resource $stream A stream resource to read from to get the file content. |
|
| 51 | + * @throws UserMigrationException |
|
| 52 | + * |
|
| 53 | + * @since 24.0.0 |
|
| 54 | + */ |
|
| 55 | + public function addFileAsStream(string $path, $stream): void; |
|
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * Copy a folder to the export |
|
| 59 | - * |
|
| 60 | - * @param Folder $folder folder to copy to the export archive. |
|
| 61 | - * @param string $destinationPath Full path to the folder in the export archive. Parent directories will be created if needed. |
|
| 62 | - * @param ?callable(\OCP\Files\Node):bool $nodeFilter Callback to filter nodes to copy |
|
| 63 | - * @throws UserMigrationException |
|
| 64 | - * |
|
| 65 | - * @since 24.0.0 |
|
| 66 | - */ |
|
| 67 | - public function copyFolder(Folder $folder, string $destinationPath, ?callable $nodeFilter = null): void; |
|
| 57 | + /** |
|
| 58 | + * Copy a folder to the export |
|
| 59 | + * |
|
| 60 | + * @param Folder $folder folder to copy to the export archive. |
|
| 61 | + * @param string $destinationPath Full path to the folder in the export archive. Parent directories will be created if needed. |
|
| 62 | + * @param ?callable(\OCP\Files\Node):bool $nodeFilter Callback to filter nodes to copy |
|
| 63 | + * @throws UserMigrationException |
|
| 64 | + * |
|
| 65 | + * @since 24.0.0 |
|
| 66 | + */ |
|
| 67 | + public function copyFolder(Folder $folder, string $destinationPath, ?callable $nodeFilter = null): void; |
|
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * @param array<string,int> $versions Migrators and their versions. |
|
| 71 | - * @throws UserMigrationException |
|
| 72 | - * |
|
| 73 | - * @since 24.0.0 |
|
| 74 | - */ |
|
| 75 | - public function setMigratorVersions(array $versions): void; |
|
| 69 | + /** |
|
| 70 | + * @param array<string,int> $versions Migrators and their versions. |
|
| 71 | + * @throws UserMigrationException |
|
| 72 | + * |
|
| 73 | + * @since 24.0.0 |
|
| 74 | + */ |
|
| 75 | + public function setMigratorVersions(array $versions): void; |
|
| 76 | 76 | |
| 77 | - /** |
|
| 78 | - * Called after export is complete |
|
| 79 | - * |
|
| 80 | - * @throws UserMigrationException |
|
| 81 | - * |
|
| 82 | - * @since 24.0.0 |
|
| 83 | - */ |
|
| 84 | - public function close(): void; |
|
| 77 | + /** |
|
| 78 | + * Called after export is complete |
|
| 79 | + * |
|
| 80 | + * @throws UserMigrationException |
|
| 81 | + * |
|
| 82 | + * @since 24.0.0 |
|
| 83 | + */ |
|
| 84 | + public function close(): void; |
|
| 85 | 85 | } |
@@ -34,68 +34,68 @@ |
||
| 34 | 34 | * @since 4.5.0 |
| 35 | 35 | */ |
| 36 | 36 | interface UserInterface { |
| 37 | - /** |
|
| 38 | - * Check if backend implements actions |
|
| 39 | - * @param int $actions bitwise-or'ed actions |
|
| 40 | - * @return boolean |
|
| 41 | - * |
|
| 42 | - * Returns the supported actions as int to be |
|
| 43 | - * compared with \OC\User\Backend::CREATE_USER etc. |
|
| 44 | - * @since 4.5.0 |
|
| 45 | - * @deprecated 14.0.0 Switch to the interfaces from OCP\User\Backend |
|
| 46 | - */ |
|
| 47 | - public function implementsActions($actions); |
|
| 37 | + /** |
|
| 38 | + * Check if backend implements actions |
|
| 39 | + * @param int $actions bitwise-or'ed actions |
|
| 40 | + * @return boolean |
|
| 41 | + * |
|
| 42 | + * Returns the supported actions as int to be |
|
| 43 | + * compared with \OC\User\Backend::CREATE_USER etc. |
|
| 44 | + * @since 4.5.0 |
|
| 45 | + * @deprecated 14.0.0 Switch to the interfaces from OCP\User\Backend |
|
| 46 | + */ |
|
| 47 | + public function implementsActions($actions); |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * delete a user |
|
| 51 | - * @param string $uid The username of the user to delete |
|
| 52 | - * @return bool |
|
| 53 | - * @since 4.5.0 |
|
| 54 | - */ |
|
| 55 | - public function deleteUser($uid); |
|
| 49 | + /** |
|
| 50 | + * delete a user |
|
| 51 | + * @param string $uid The username of the user to delete |
|
| 52 | + * @return bool |
|
| 53 | + * @since 4.5.0 |
|
| 54 | + */ |
|
| 55 | + public function deleteUser($uid); |
|
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * Get a list of all users |
|
| 59 | - * |
|
| 60 | - * @param string $search |
|
| 61 | - * @param null|int $limit |
|
| 62 | - * @param null|int $offset |
|
| 63 | - * @return string[] an array of all uids |
|
| 64 | - * @since 4.5.0 |
|
| 65 | - */ |
|
| 66 | - public function getUsers($search = '', $limit = null, $offset = null); |
|
| 57 | + /** |
|
| 58 | + * Get a list of all users |
|
| 59 | + * |
|
| 60 | + * @param string $search |
|
| 61 | + * @param null|int $limit |
|
| 62 | + * @param null|int $offset |
|
| 63 | + * @return string[] an array of all uids |
|
| 64 | + * @since 4.5.0 |
|
| 65 | + */ |
|
| 66 | + public function getUsers($search = '', $limit = null, $offset = null); |
|
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * check if a user exists |
|
| 70 | - * @param string $uid the username |
|
| 71 | - * @return boolean |
|
| 72 | - * @since 4.5.0 |
|
| 73 | - */ |
|
| 74 | - public function userExists($uid); |
|
| 68 | + /** |
|
| 69 | + * check if a user exists |
|
| 70 | + * @param string $uid the username |
|
| 71 | + * @return boolean |
|
| 72 | + * @since 4.5.0 |
|
| 73 | + */ |
|
| 74 | + public function userExists($uid); |
|
| 75 | 75 | |
| 76 | - /** |
|
| 77 | - * get display name of the user |
|
| 78 | - * @param string $uid user ID of the user |
|
| 79 | - * @return string display name |
|
| 80 | - * @since 4.5.0 |
|
| 81 | - */ |
|
| 82 | - public function getDisplayName($uid); |
|
| 76 | + /** |
|
| 77 | + * get display name of the user |
|
| 78 | + * @param string $uid user ID of the user |
|
| 79 | + * @return string display name |
|
| 80 | + * @since 4.5.0 |
|
| 81 | + */ |
|
| 82 | + public function getDisplayName($uid); |
|
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * Get a list of all display names and user ids. |
|
| 86 | - * |
|
| 87 | - * @param string $search |
|
| 88 | - * @param int|null $limit |
|
| 89 | - * @param int|null $offset |
|
| 90 | - * @return array an array of all displayNames (value) and the corresponding uids (key) |
|
| 91 | - * @since 4.5.0 |
|
| 92 | - */ |
|
| 93 | - public function getDisplayNames($search = '', $limit = null, $offset = null); |
|
| 84 | + /** |
|
| 85 | + * Get a list of all display names and user ids. |
|
| 86 | + * |
|
| 87 | + * @param string $search |
|
| 88 | + * @param int|null $limit |
|
| 89 | + * @param int|null $offset |
|
| 90 | + * @return array an array of all displayNames (value) and the corresponding uids (key) |
|
| 91 | + * @since 4.5.0 |
|
| 92 | + */ |
|
| 93 | + public function getDisplayNames($search = '', $limit = null, $offset = null); |
|
| 94 | 94 | |
| 95 | - /** |
|
| 96 | - * Check if a user list is available or not |
|
| 97 | - * @return boolean if users can be listed or not |
|
| 98 | - * @since 4.5.0 |
|
| 99 | - */ |
|
| 100 | - public function hasUserListings(); |
|
| 95 | + /** |
|
| 96 | + * Check if a user list is available or not |
|
| 97 | + * @return boolean if users can be listed or not |
|
| 98 | + * @since 4.5.0 |
|
| 99 | + */ |
|
| 100 | + public function hasUserListings(); |
|
| 101 | 101 | } |
@@ -34,105 +34,105 @@ |
||
| 34 | 34 | * @since 23.0.0 |
| 35 | 35 | */ |
| 36 | 36 | interface ICalendarQuery { |
| 37 | - /** |
|
| 38 | - * @since 24.0.0 |
|
| 39 | - */ |
|
| 40 | - public const SEARCH_PROPERTY_CATEGORIES = 'CATEGORIES'; |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * @since 24.0.0 |
|
| 44 | - */ |
|
| 45 | - public const SEARCH_PROPERTY_COMMENT = 'COMMENT'; |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * @since 24.0.0 |
|
| 49 | - */ |
|
| 50 | - public const SEARCH_PROPERTY_DESCRIPTION = 'DESCRIPTION'; |
|
| 51 | - |
|
| 52 | - /** |
|
| 53 | - * @since 24.0.0 |
|
| 54 | - */ |
|
| 55 | - public const SEARCH_PROPERTY_LOCATION = 'LOCATION'; |
|
| 56 | - |
|
| 57 | - /** |
|
| 58 | - * @since 24.0.0 |
|
| 59 | - */ |
|
| 60 | - public const SEARCH_PROPERTY_RESOURCES = 'RESOURCES'; |
|
| 61 | - |
|
| 62 | - /** |
|
| 63 | - * @since 24.0.0 |
|
| 64 | - */ |
|
| 65 | - public const SEARCH_PROPERTY_STATUS = 'STATUS'; |
|
| 66 | - |
|
| 67 | - /** |
|
| 68 | - * @since 24.0.0 |
|
| 69 | - */ |
|
| 70 | - public const SEARCH_PROPERTY_SUMMARY = 'SUMMARY'; |
|
| 71 | - |
|
| 72 | - /** |
|
| 73 | - * @since 24.0.0 |
|
| 74 | - */ |
|
| 75 | - public const SEARCH_PROPERTY_ATTENDEE = 'ATTENDEE'; |
|
| 76 | - |
|
| 77 | - /** |
|
| 78 | - * @since 24.0.0 |
|
| 79 | - */ |
|
| 80 | - public const SEARCH_PROPERTY_CONTACT = 'CONTACT'; |
|
| 81 | - |
|
| 82 | - /** |
|
| 83 | - * @since 24.0.0 |
|
| 84 | - */ |
|
| 85 | - public const SEARCH_PROPERTY_ORGANIZER = 'ORGANIZER'; |
|
| 86 | - |
|
| 87 | - /** |
|
| 88 | - * Limit the results to the calendar uri(s) |
|
| 89 | - * |
|
| 90 | - * @since 23.0.0 |
|
| 91 | - */ |
|
| 92 | - public function addSearchCalendar(string $calendarUri): void; |
|
| 93 | - |
|
| 94 | - /** |
|
| 95 | - * Search the property values |
|
| 96 | - * |
|
| 97 | - * @since 23.0.0 |
|
| 98 | - */ |
|
| 99 | - public function setSearchPattern(string $pattern): void; |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * Define the property name(s) to search for |
|
| 103 | - * |
|
| 104 | - * Note: Nextcloud only indexes *some* properties. You can not search for |
|
| 105 | - * arbitrary properties. |
|
| 106 | - * |
|
| 107 | - * @param string $value any of the ICalendarQuery::SEARCH_PROPERTY_* values |
|
| 108 | - * @psalm-param ICalendarQuery::SEARCH_PROPERTY_* $value |
|
| 109 | - * |
|
| 110 | - * @since 23.0.0 |
|
| 111 | - */ |
|
| 112 | - public function addSearchProperty(string $value): void; |
|
| 113 | - |
|
| 114 | - /** |
|
| 115 | - * @since 23.0.0 |
|
| 116 | - */ |
|
| 117 | - public function addType(string $value): void; |
|
| 118 | - |
|
| 119 | - /** |
|
| 120 | - * @since 23.0.0 |
|
| 121 | - */ |
|
| 122 | - public function setTimerangeStart(DateTimeImmutable $startTime): void; |
|
| 123 | - |
|
| 124 | - /** |
|
| 125 | - * @since 23.0.0 |
|
| 126 | - */ |
|
| 127 | - public function setTimerangeEnd(DateTimeImmutable $endTime): void; |
|
| 128 | - |
|
| 129 | - /** |
|
| 130 | - * @since 23.0.0 |
|
| 131 | - */ |
|
| 132 | - public function setLimit(int $limit): void; |
|
| 133 | - |
|
| 134 | - /** |
|
| 135 | - * @since 23.0.0 |
|
| 136 | - */ |
|
| 137 | - public function setOffset(int $offset): void; |
|
| 37 | + /** |
|
| 38 | + * @since 24.0.0 |
|
| 39 | + */ |
|
| 40 | + public const SEARCH_PROPERTY_CATEGORIES = 'CATEGORIES'; |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * @since 24.0.0 |
|
| 44 | + */ |
|
| 45 | + public const SEARCH_PROPERTY_COMMENT = 'COMMENT'; |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * @since 24.0.0 |
|
| 49 | + */ |
|
| 50 | + public const SEARCH_PROPERTY_DESCRIPTION = 'DESCRIPTION'; |
|
| 51 | + |
|
| 52 | + /** |
|
| 53 | + * @since 24.0.0 |
|
| 54 | + */ |
|
| 55 | + public const SEARCH_PROPERTY_LOCATION = 'LOCATION'; |
|
| 56 | + |
|
| 57 | + /** |
|
| 58 | + * @since 24.0.0 |
|
| 59 | + */ |
|
| 60 | + public const SEARCH_PROPERTY_RESOURCES = 'RESOURCES'; |
|
| 61 | + |
|
| 62 | + /** |
|
| 63 | + * @since 24.0.0 |
|
| 64 | + */ |
|
| 65 | + public const SEARCH_PROPERTY_STATUS = 'STATUS'; |
|
| 66 | + |
|
| 67 | + /** |
|
| 68 | + * @since 24.0.0 |
|
| 69 | + */ |
|
| 70 | + public const SEARCH_PROPERTY_SUMMARY = 'SUMMARY'; |
|
| 71 | + |
|
| 72 | + /** |
|
| 73 | + * @since 24.0.0 |
|
| 74 | + */ |
|
| 75 | + public const SEARCH_PROPERTY_ATTENDEE = 'ATTENDEE'; |
|
| 76 | + |
|
| 77 | + /** |
|
| 78 | + * @since 24.0.0 |
|
| 79 | + */ |
|
| 80 | + public const SEARCH_PROPERTY_CONTACT = 'CONTACT'; |
|
| 81 | + |
|
| 82 | + /** |
|
| 83 | + * @since 24.0.0 |
|
| 84 | + */ |
|
| 85 | + public const SEARCH_PROPERTY_ORGANIZER = 'ORGANIZER'; |
|
| 86 | + |
|
| 87 | + /** |
|
| 88 | + * Limit the results to the calendar uri(s) |
|
| 89 | + * |
|
| 90 | + * @since 23.0.0 |
|
| 91 | + */ |
|
| 92 | + public function addSearchCalendar(string $calendarUri): void; |
|
| 93 | + |
|
| 94 | + /** |
|
| 95 | + * Search the property values |
|
| 96 | + * |
|
| 97 | + * @since 23.0.0 |
|
| 98 | + */ |
|
| 99 | + public function setSearchPattern(string $pattern): void; |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * Define the property name(s) to search for |
|
| 103 | + * |
|
| 104 | + * Note: Nextcloud only indexes *some* properties. You can not search for |
|
| 105 | + * arbitrary properties. |
|
| 106 | + * |
|
| 107 | + * @param string $value any of the ICalendarQuery::SEARCH_PROPERTY_* values |
|
| 108 | + * @psalm-param ICalendarQuery::SEARCH_PROPERTY_* $value |
|
| 109 | + * |
|
| 110 | + * @since 23.0.0 |
|
| 111 | + */ |
|
| 112 | + public function addSearchProperty(string $value): void; |
|
| 113 | + |
|
| 114 | + /** |
|
| 115 | + * @since 23.0.0 |
|
| 116 | + */ |
|
| 117 | + public function addType(string $value): void; |
|
| 118 | + |
|
| 119 | + /** |
|
| 120 | + * @since 23.0.0 |
|
| 121 | + */ |
|
| 122 | + public function setTimerangeStart(DateTimeImmutable $startTime): void; |
|
| 123 | + |
|
| 124 | + /** |
|
| 125 | + * @since 23.0.0 |
|
| 126 | + */ |
|
| 127 | + public function setTimerangeEnd(DateTimeImmutable $endTime): void; |
|
| 128 | + |
|
| 129 | + /** |
|
| 130 | + * @since 23.0.0 |
|
| 131 | + */ |
|
| 132 | + public function setLimit(int $limit): void; |
|
| 133 | + |
|
| 134 | + /** |
|
| 135 | + * @since 23.0.0 |
|
| 136 | + */ |
|
| 137 | + public function setOffset(int $offset): void; |
|
| 138 | 138 | } |
@@ -28,50 +28,50 @@ |
||
| 28 | 28 | * @since 14.0.0 |
| 29 | 29 | */ |
| 30 | 30 | interface IResource { |
| 31 | - /** |
|
| 32 | - * get the resource id |
|
| 33 | - * |
|
| 34 | - * This id has to be unique within the backend |
|
| 35 | - * |
|
| 36 | - * @return string |
|
| 37 | - * @since 14.0.0 |
|
| 38 | - */ |
|
| 39 | - public function getId():string; |
|
| 31 | + /** |
|
| 32 | + * get the resource id |
|
| 33 | + * |
|
| 34 | + * This id has to be unique within the backend |
|
| 35 | + * |
|
| 36 | + * @return string |
|
| 37 | + * @since 14.0.0 |
|
| 38 | + */ |
|
| 39 | + public function getId():string; |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * get the display name for a resource |
|
| 43 | - * |
|
| 44 | - * @return string |
|
| 45 | - * @since 14.0.0 |
|
| 46 | - */ |
|
| 47 | - public function getDisplayName():string; |
|
| 41 | + /** |
|
| 42 | + * get the display name for a resource |
|
| 43 | + * |
|
| 44 | + * @return string |
|
| 45 | + * @since 14.0.0 |
|
| 46 | + */ |
|
| 47 | + public function getDisplayName():string; |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * Get a list of groupIds that are allowed to access this resource |
|
| 51 | - * |
|
| 52 | - * If an empty array is returned, no group restrictions are |
|
| 53 | - * applied. |
|
| 54 | - * |
|
| 55 | - * @return string[] |
|
| 56 | - * @since 14.0.0 |
|
| 57 | - */ |
|
| 58 | - public function getGroupRestrictions():array; |
|
| 49 | + /** |
|
| 50 | + * Get a list of groupIds that are allowed to access this resource |
|
| 51 | + * |
|
| 52 | + * If an empty array is returned, no group restrictions are |
|
| 53 | + * applied. |
|
| 54 | + * |
|
| 55 | + * @return string[] |
|
| 56 | + * @since 14.0.0 |
|
| 57 | + */ |
|
| 58 | + public function getGroupRestrictions():array; |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * get email-address for resource |
|
| 62 | - * |
|
| 63 | - * The email address has to be globally unique |
|
| 64 | - * |
|
| 65 | - * @return string |
|
| 66 | - * @since 14.0.0 |
|
| 67 | - */ |
|
| 68 | - public function getEMail():string; |
|
| 60 | + /** |
|
| 61 | + * get email-address for resource |
|
| 62 | + * |
|
| 63 | + * The email address has to be globally unique |
|
| 64 | + * |
|
| 65 | + * @return string |
|
| 66 | + * @since 14.0.0 |
|
| 67 | + */ |
|
| 68 | + public function getEMail():string; |
|
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * Get corresponding backend object |
|
| 72 | - * |
|
| 73 | - * @return IBackend |
|
| 74 | - * @since 14.0.0 |
|
| 75 | - */ |
|
| 76 | - public function getBackend():IBackend; |
|
| 70 | + /** |
|
| 71 | + * Get corresponding backend object |
|
| 72 | + * |
|
| 73 | + * @return IBackend |
|
| 74 | + * @since 14.0.0 |
|
| 75 | + */ |
|
| 76 | + public function getBackend():IBackend; |
|
| 77 | 77 | } |
@@ -31,39 +31,39 @@ |
||
| 31 | 31 | * @since 14.0.0 |
| 32 | 32 | */ |
| 33 | 33 | interface IBackend { |
| 34 | - /** |
|
| 35 | - * get a list of all resources in this backend |
|
| 36 | - * |
|
| 37 | - * @throws BackendTemporarilyUnavailableException |
|
| 38 | - * @return IResource[] |
|
| 39 | - * @since 14.0.0 |
|
| 40 | - */ |
|
| 41 | - public function getAllResources():array; |
|
| 34 | + /** |
|
| 35 | + * get a list of all resources in this backend |
|
| 36 | + * |
|
| 37 | + * @throws BackendTemporarilyUnavailableException |
|
| 38 | + * @return IResource[] |
|
| 39 | + * @since 14.0.0 |
|
| 40 | + */ |
|
| 41 | + public function getAllResources():array; |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * get a list of all resource identifiers in this backend |
|
| 45 | - * |
|
| 46 | - * @throws BackendTemporarilyUnavailableException |
|
| 47 | - * @return string[] |
|
| 48 | - * @since 14.0.0 |
|
| 49 | - */ |
|
| 50 | - public function listAllResources():array; |
|
| 43 | + /** |
|
| 44 | + * get a list of all resource identifiers in this backend |
|
| 45 | + * |
|
| 46 | + * @throws BackendTemporarilyUnavailableException |
|
| 47 | + * @return string[] |
|
| 48 | + * @since 14.0.0 |
|
| 49 | + */ |
|
| 50 | + public function listAllResources():array; |
|
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * get a resource by it's id |
|
| 54 | - * |
|
| 55 | - * @param string $id |
|
| 56 | - * @throws BackendTemporarilyUnavailableException |
|
| 57 | - * @return IResource|null |
|
| 58 | - * @since 14.0.0 |
|
| 59 | - */ |
|
| 60 | - public function getResource($id); |
|
| 52 | + /** |
|
| 53 | + * get a resource by it's id |
|
| 54 | + * |
|
| 55 | + * @param string $id |
|
| 56 | + * @throws BackendTemporarilyUnavailableException |
|
| 57 | + * @return IResource|null |
|
| 58 | + * @since 14.0.0 |
|
| 59 | + */ |
|
| 60 | + public function getResource($id); |
|
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * Get unique identifier of the backend |
|
| 64 | - * |
|
| 65 | - * @return string |
|
| 66 | - * @since 14.0.0 |
|
| 67 | - */ |
|
| 68 | - public function getBackendIdentifier():string; |
|
| 62 | + /** |
|
| 63 | + * Get unique identifier of the backend |
|
| 64 | + * |
|
| 65 | + * @return string |
|
| 66 | + * @since 14.0.0 |
|
| 67 | + */ |
|
| 68 | + public function getBackendIdentifier():string; |
|
| 69 | 69 | } |
@@ -32,84 +32,84 @@ |
||
| 32 | 32 | * @since 17.0.0 |
| 33 | 33 | */ |
| 34 | 34 | interface IResourceMetadata { |
| 35 | - /** |
|
| 36 | - * Type of resource |
|
| 37 | - * |
|
| 38 | - * Allowed values for this key include: |
|
| 39 | - * - projector |
|
| 40 | - * - tv |
|
| 41 | - * - vehicle |
|
| 42 | - * - other |
|
| 43 | - * |
|
| 44 | - * @since 17.0.0 |
|
| 45 | - */ |
|
| 46 | - public const RESOURCE_TYPE = '{http://nextcloud.com/ns}resource-type'; |
|
| 35 | + /** |
|
| 36 | + * Type of resource |
|
| 37 | + * |
|
| 38 | + * Allowed values for this key include: |
|
| 39 | + * - projector |
|
| 40 | + * - tv |
|
| 41 | + * - vehicle |
|
| 42 | + * - other |
|
| 43 | + * |
|
| 44 | + * @since 17.0.0 |
|
| 45 | + */ |
|
| 46 | + public const RESOURCE_TYPE = '{http://nextcloud.com/ns}resource-type'; |
|
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * If resource is of type vehicle, this describes the type of vehicle |
|
| 50 | - * |
|
| 51 | - * Allowed values: |
|
| 52 | - * - bicycle |
|
| 53 | - * - scooter |
|
| 54 | - * - motorbike |
|
| 55 | - * - car |
|
| 56 | - * - plane |
|
| 57 | - * - helicopter |
|
| 58 | - * - other |
|
| 59 | - * |
|
| 60 | - * @since 17.0.0 |
|
| 61 | - */ |
|
| 62 | - public const VEHICLE_TYPE = '{http://nextcloud.com/ns}resource-vehicle-type'; |
|
| 48 | + /** |
|
| 49 | + * If resource is of type vehicle, this describes the type of vehicle |
|
| 50 | + * |
|
| 51 | + * Allowed values: |
|
| 52 | + * - bicycle |
|
| 53 | + * - scooter |
|
| 54 | + * - motorbike |
|
| 55 | + * - car |
|
| 56 | + * - plane |
|
| 57 | + * - helicopter |
|
| 58 | + * - other |
|
| 59 | + * |
|
| 60 | + * @since 17.0.0 |
|
| 61 | + */ |
|
| 62 | + public const VEHICLE_TYPE = '{http://nextcloud.com/ns}resource-vehicle-type'; |
|
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * Make of the vehicle |
|
| 66 | - * |
|
| 67 | - * @since 17.0.0 |
|
| 68 | - */ |
|
| 69 | - public const VEHICLE_MAKE = '{http://nextcloud.com/ns}resource-vehicle-make'; |
|
| 64 | + /** |
|
| 65 | + * Make of the vehicle |
|
| 66 | + * |
|
| 67 | + * @since 17.0.0 |
|
| 68 | + */ |
|
| 69 | + public const VEHICLE_MAKE = '{http://nextcloud.com/ns}resource-vehicle-make'; |
|
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * Model of the vehicle |
|
| 73 | - * |
|
| 74 | - * @since 17.0.0 |
|
| 75 | - */ |
|
| 76 | - public const VEHICLE_MODEL = '{http://nextcloud.com/ns}resource-vehicle-model'; |
|
| 71 | + /** |
|
| 72 | + * Model of the vehicle |
|
| 73 | + * |
|
| 74 | + * @since 17.0.0 |
|
| 75 | + */ |
|
| 76 | + public const VEHICLE_MODEL = '{http://nextcloud.com/ns}resource-vehicle-model'; |
|
| 77 | 77 | |
| 78 | - /** |
|
| 79 | - * Whether or not the car is electric |
|
| 80 | - * |
|
| 81 | - * use '1' for electric, '0' for non-electric |
|
| 82 | - * |
|
| 83 | - * @since 17.0.0 |
|
| 84 | - */ |
|
| 85 | - public const VEHICLE_IS_ELECTRIC = '{http://nextcloud.com/ns}resource-vehicle-is-electric'; |
|
| 78 | + /** |
|
| 79 | + * Whether or not the car is electric |
|
| 80 | + * |
|
| 81 | + * use '1' for electric, '0' for non-electric |
|
| 82 | + * |
|
| 83 | + * @since 17.0.0 |
|
| 84 | + */ |
|
| 85 | + public const VEHICLE_IS_ELECTRIC = '{http://nextcloud.com/ns}resource-vehicle-is-electric'; |
|
| 86 | 86 | |
| 87 | - /** |
|
| 88 | - * Range of vehicle with a full tank |
|
| 89 | - * |
|
| 90 | - * @since 17.0.0 |
|
| 91 | - */ |
|
| 92 | - public const VEHICLE_RANGE = '{http://nextcloud.com/ns}resource-vehicle-range'; |
|
| 87 | + /** |
|
| 88 | + * Range of vehicle with a full tank |
|
| 89 | + * |
|
| 90 | + * @since 17.0.0 |
|
| 91 | + */ |
|
| 92 | + public const VEHICLE_RANGE = '{http://nextcloud.com/ns}resource-vehicle-range'; |
|
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * Seating capacity of the vehicle |
|
| 96 | - * |
|
| 97 | - * @since 17.0.0 |
|
| 98 | - */ |
|
| 99 | - public const VEHICLE_SEATING_CAPACITY = '{http://nextcloud.com/ns}resource-vehicle-seating-capacity'; |
|
| 94 | + /** |
|
| 95 | + * Seating capacity of the vehicle |
|
| 96 | + * |
|
| 97 | + * @since 17.0.0 |
|
| 98 | + */ |
|
| 99 | + public const VEHICLE_SEATING_CAPACITY = '{http://nextcloud.com/ns}resource-vehicle-seating-capacity'; |
|
| 100 | 100 | |
| 101 | - /** |
|
| 102 | - * Contact information about the person who is responsible to administer / maintain this resource |
|
| 103 | - * This key stores a textual description of name and possible ways to contact the person |
|
| 104 | - * |
|
| 105 | - * @since 17.0.0 |
|
| 106 | - */ |
|
| 107 | - public const CONTACT_PERSON = '{http://nextcloud.com/ns}resource-contact-person'; |
|
| 101 | + /** |
|
| 102 | + * Contact information about the person who is responsible to administer / maintain this resource |
|
| 103 | + * This key stores a textual description of name and possible ways to contact the person |
|
| 104 | + * |
|
| 105 | + * @since 17.0.0 |
|
| 106 | + */ |
|
| 107 | + public const CONTACT_PERSON = '{http://nextcloud.com/ns}resource-contact-person'; |
|
| 108 | 108 | |
| 109 | - /** |
|
| 110 | - * Link to the vcard of the contact person |
|
| 111 | - * |
|
| 112 | - * @since 17.0.0 |
|
| 113 | - */ |
|
| 114 | - public const CONTACT_PERSON_VCARD = '{http://nextcloud.com/ns}resource-contact-person-vcard'; |
|
| 109 | + /** |
|
| 110 | + * Link to the vcard of the contact person |
|
| 111 | + * |
|
| 112 | + * @since 17.0.0 |
|
| 113 | + */ |
|
| 114 | + public const CONTACT_PERSON_VCARD = '{http://nextcloud.com/ns}resource-contact-person-vcard'; |
|
| 115 | 115 | } |
@@ -30,33 +30,33 @@ |
||
| 30 | 30 | * @since 17.0.0 |
| 31 | 31 | */ |
| 32 | 32 | interface IMetadataProvider { |
| 33 | - /** |
|
| 34 | - * Get a list of all metadata keys available for this room |
|
| 35 | - * |
|
| 36 | - * Room backends are allowed to return custom keys, beyond the ones |
|
| 37 | - * defined in this class. If they do, they should make sure to use their |
|
| 38 | - * own namespace. |
|
| 39 | - * |
|
| 40 | - * @return String[] - A list of available keys |
|
| 41 | - * @since 17.0.0 |
|
| 42 | - */ |
|
| 43 | - public function getAllAvailableMetadataKeys():array; |
|
| 33 | + /** |
|
| 34 | + * Get a list of all metadata keys available for this room |
|
| 35 | + * |
|
| 36 | + * Room backends are allowed to return custom keys, beyond the ones |
|
| 37 | + * defined in this class. If they do, they should make sure to use their |
|
| 38 | + * own namespace. |
|
| 39 | + * |
|
| 40 | + * @return String[] - A list of available keys |
|
| 41 | + * @since 17.0.0 |
|
| 42 | + */ |
|
| 43 | + public function getAllAvailableMetadataKeys():array; |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * Get whether or not a metadata key is set for this room |
|
| 47 | - * |
|
| 48 | - * @param string $key - The key to check for |
|
| 49 | - * @return bool - Whether or not key is available |
|
| 50 | - * @since 17.0.0 |
|
| 51 | - */ |
|
| 52 | - public function hasMetadataForKey(string $key):bool; |
|
| 45 | + /** |
|
| 46 | + * Get whether or not a metadata key is set for this room |
|
| 47 | + * |
|
| 48 | + * @param string $key - The key to check for |
|
| 49 | + * @return bool - Whether or not key is available |
|
| 50 | + * @since 17.0.0 |
|
| 51 | + */ |
|
| 52 | + public function hasMetadataForKey(string $key):bool; |
|
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * Get the value for a metadata key |
|
| 56 | - * |
|
| 57 | - * @param string $key - The key to check for |
|
| 58 | - * @return string|null - The value stored for the key, null if no value stored |
|
| 59 | - * @since 17.0.0 |
|
| 60 | - */ |
|
| 61 | - public function getMetadataForKey(string $key):?string; |
|
| 54 | + /** |
|
| 55 | + * Get the value for a metadata key |
|
| 56 | + * |
|
| 57 | + * @param string $key - The key to check for |
|
| 58 | + * @return string|null - The value stored for the key, null if no value stored |
|
| 59 | + * @since 17.0.0 |
|
| 60 | + */ |
|
| 61 | + public function getMetadataForKey(string $key):?string; |
|
| 62 | 62 | } |
@@ -28,50 +28,50 @@ |
||
| 28 | 28 | * @since 14.0.0 |
| 29 | 29 | */ |
| 30 | 30 | interface IRoom { |
| 31 | - /** |
|
| 32 | - * Get a unique ID for the room |
|
| 33 | - * |
|
| 34 | - * This id has to be unique within the backend |
|
| 35 | - * |
|
| 36 | - * @return string |
|
| 37 | - * @since 14.0.0 |
|
| 38 | - */ |
|
| 39 | - public function getId():string; |
|
| 31 | + /** |
|
| 32 | + * Get a unique ID for the room |
|
| 33 | + * |
|
| 34 | + * This id has to be unique within the backend |
|
| 35 | + * |
|
| 36 | + * @return string |
|
| 37 | + * @since 14.0.0 |
|
| 38 | + */ |
|
| 39 | + public function getId():string; |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * Get the display name for the room |
|
| 43 | - * |
|
| 44 | - * @return string |
|
| 45 | - * @since 14.0.0 |
|
| 46 | - */ |
|
| 47 | - public function getDisplayName():string; |
|
| 41 | + /** |
|
| 42 | + * Get the display name for the room |
|
| 43 | + * |
|
| 44 | + * @return string |
|
| 45 | + * @since 14.0.0 |
|
| 46 | + */ |
|
| 47 | + public function getDisplayName():string; |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * Get a list of groupIds that are allowed to access this room |
|
| 51 | - * |
|
| 52 | - * If an empty array is returned, no group restrictions are |
|
| 53 | - * applied. |
|
| 54 | - * |
|
| 55 | - * @return string[] |
|
| 56 | - * @since 14.0.0 |
|
| 57 | - */ |
|
| 58 | - public function getGroupRestrictions():array; |
|
| 49 | + /** |
|
| 50 | + * Get a list of groupIds that are allowed to access this room |
|
| 51 | + * |
|
| 52 | + * If an empty array is returned, no group restrictions are |
|
| 53 | + * applied. |
|
| 54 | + * |
|
| 55 | + * @return string[] |
|
| 56 | + * @since 14.0.0 |
|
| 57 | + */ |
|
| 58 | + public function getGroupRestrictions():array; |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * Get the email-address for the room |
|
| 62 | - * |
|
| 63 | - * The email-address has to be globally unique |
|
| 64 | - * |
|
| 65 | - * @return string |
|
| 66 | - * @since 14.0.0 |
|
| 67 | - */ |
|
| 68 | - public function getEMail():string; |
|
| 60 | + /** |
|
| 61 | + * Get the email-address for the room |
|
| 62 | + * |
|
| 63 | + * The email-address has to be globally unique |
|
| 64 | + * |
|
| 65 | + * @return string |
|
| 66 | + * @since 14.0.0 |
|
| 67 | + */ |
|
| 68 | + public function getEMail():string; |
|
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * Get corresponding backend object |
|
| 72 | - * |
|
| 73 | - * @return IBackend |
|
| 74 | - * @since 14.0.0 |
|
| 75 | - */ |
|
| 76 | - public function getBackend():IBackend; |
|
| 70 | + /** |
|
| 71 | + * Get corresponding backend object |
|
| 72 | + * |
|
| 73 | + * @return IBackend |
|
| 74 | + * @since 14.0.0 |
|
| 75 | + */ |
|
| 76 | + public function getBackend():IBackend; |
|
| 77 | 77 | } |
@@ -32,61 +32,61 @@ |
||
| 32 | 32 | * @since 17.0.0 |
| 33 | 33 | */ |
| 34 | 34 | interface IRoomMetadata { |
| 35 | - /** |
|
| 36 | - * Type of room |
|
| 37 | - * |
|
| 38 | - * Allowed values for this key are: |
|
| 39 | - * - meeting-room |
|
| 40 | - * - lecture-hall |
|
| 41 | - * - seminar-room |
|
| 42 | - * - other |
|
| 43 | - * |
|
| 44 | - * @since 17.0.0 |
|
| 45 | - */ |
|
| 46 | - public const ROOM_TYPE = '{http://nextcloud.com/ns}room-type'; |
|
| 35 | + /** |
|
| 36 | + * Type of room |
|
| 37 | + * |
|
| 38 | + * Allowed values for this key are: |
|
| 39 | + * - meeting-room |
|
| 40 | + * - lecture-hall |
|
| 41 | + * - seminar-room |
|
| 42 | + * - other |
|
| 43 | + * |
|
| 44 | + * @since 17.0.0 |
|
| 45 | + */ |
|
| 46 | + public const ROOM_TYPE = '{http://nextcloud.com/ns}room-type'; |
|
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * Seating capacity of the room |
|
| 50 | - * |
|
| 51 | - * @since 17.0.0 |
|
| 52 | - */ |
|
| 53 | - public const CAPACITY = '{http://nextcloud.com/ns}room-seating-capacity'; |
|
| 48 | + /** |
|
| 49 | + * Seating capacity of the room |
|
| 50 | + * |
|
| 51 | + * @since 17.0.0 |
|
| 52 | + */ |
|
| 53 | + public const CAPACITY = '{http://nextcloud.com/ns}room-seating-capacity'; |
|
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * The physical address of the building this room is located in |
|
| 57 | - * |
|
| 58 | - * @since 17.0.0 |
|
| 59 | - */ |
|
| 60 | - public const BUILDING_ADDRESS = '{http://nextcloud.com/ns}room-building-address'; |
|
| 55 | + /** |
|
| 56 | + * The physical address of the building this room is located in |
|
| 57 | + * |
|
| 58 | + * @since 17.0.0 |
|
| 59 | + */ |
|
| 60 | + public const BUILDING_ADDRESS = '{http://nextcloud.com/ns}room-building-address'; |
|
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * The story of the building this rooms is located in |
|
| 64 | - * |
|
| 65 | - * @since 17.0.0 |
|
| 66 | - */ |
|
| 67 | - public const BUILDING_STORY = '{http://nextcloud.com/ns}room-building-story'; |
|
| 62 | + /** |
|
| 63 | + * The story of the building this rooms is located in |
|
| 64 | + * |
|
| 65 | + * @since 17.0.0 |
|
| 66 | + */ |
|
| 67 | + public const BUILDING_STORY = '{http://nextcloud.com/ns}room-building-story'; |
|
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * The room-number |
|
| 71 | - * |
|
| 72 | - * @since 17.0.0 |
|
| 73 | - */ |
|
| 74 | - public const BUILDING_ROOM_NUMBER = '{http://nextcloud.com/ns}room-building-room-number'; |
|
| 69 | + /** |
|
| 70 | + * The room-number |
|
| 71 | + * |
|
| 72 | + * @since 17.0.0 |
|
| 73 | + */ |
|
| 74 | + public const BUILDING_ROOM_NUMBER = '{http://nextcloud.com/ns}room-building-room-number'; |
|
| 75 | 75 | |
| 76 | - /** |
|
| 77 | - * Features provided by the room. |
|
| 78 | - * This is a stringified list of features. |
|
| 79 | - * Example: "PHONE,VIDEO-CONFERENCING" |
|
| 80 | - * |
|
| 81 | - * Standard features include: |
|
| 82 | - * - PHONE: This room is fitted with a phone |
|
| 83 | - * - VIDEO-CONFERENCING: This room is fitted with a video-conferencing system |
|
| 84 | - * - TV: This room is fitted with a TV |
|
| 85 | - * - PROJECTOR: This room is fitted with a projector |
|
| 86 | - * - WHITEBOARD: This room is fitted with a whiteboard |
|
| 87 | - * - WHEELCHAIR-ACCESSIBLE: This room is wheelchair-accessible |
|
| 88 | - * |
|
| 89 | - * @since 17.0.0 |
|
| 90 | - */ |
|
| 91 | - public const FEATURES = '{http://nextcloud.com/ns}room-features'; |
|
| 76 | + /** |
|
| 77 | + * Features provided by the room. |
|
| 78 | + * This is a stringified list of features. |
|
| 79 | + * Example: "PHONE,VIDEO-CONFERENCING" |
|
| 80 | + * |
|
| 81 | + * Standard features include: |
|
| 82 | + * - PHONE: This room is fitted with a phone |
|
| 83 | + * - VIDEO-CONFERENCING: This room is fitted with a video-conferencing system |
|
| 84 | + * - TV: This room is fitted with a TV |
|
| 85 | + * - PROJECTOR: This room is fitted with a projector |
|
| 86 | + * - WHITEBOARD: This room is fitted with a whiteboard |
|
| 87 | + * - WHEELCHAIR-ACCESSIBLE: This room is wheelchair-accessible |
|
| 88 | + * |
|
| 89 | + * @since 17.0.0 |
|
| 90 | + */ |
|
| 91 | + public const FEATURES = '{http://nextcloud.com/ns}room-features'; |
|
| 92 | 92 | } |