diff options
author | Georg Ehrke <developer@georgehrke.com> | 2018-05-28 15:37:29 +0300 |
---|---|---|
committer | Georg Ehrke <developer@georgehrke.com> | 2018-06-25 05:58:07 +0300 |
commit | 29b777e7d1d26a3b75b0aabcca394170e6043939 (patch) | |
tree | eee58ba7793ab23eb7465c329c9f94531514d0b5 /lib/public | |
parent | a431cc3b58dc5ab2c4c1b47be2e11a35f850631e (diff) |
add resource and room interfaces
Signed-off-by: Georg Ehrke <developer@georgehrke.com>
Diffstat (limited to 'lib/public')
-rw-r--r-- | lib/public/Calendar/Resource/IBackend.php | 55 | ||||
-rw-r--r-- | lib/public/Calendar/Resource/IResource.php | 70 | ||||
-rw-r--r-- | lib/public/Calendar/Room/IBackend.php | 55 | ||||
-rw-r--r-- | lib/public/Calendar/Room/IRoom.php | 70 |
4 files changed, 250 insertions, 0 deletions
diff --git a/lib/public/Calendar/Resource/IBackend.php b/lib/public/Calendar/Resource/IBackend.php new file mode 100644 index 00000000000..99a4ff06332 --- /dev/null +++ b/lib/public/Calendar/Resource/IBackend.php @@ -0,0 +1,55 @@ +<?php +/** + * @copyright 2018, Georg Ehrke <oc.list@georgehrke.com> + * + * @author Georg Ehrke <oc.list@georgehrke.com> + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ + +namespace OCP\Calendar\Resource; + +/** + * Interface IBackend + * + * @package OCP\Calendar\Resource + * @since 14.0.0 + */ +interface IBackend { + + /** + * get a list of all resources in this backend + * + * @return IResource[] + */ + public function getAllResources(); + + /** + * get a list of all resource identifiers in this backend + * + * @return string[] + */ + public function listAllResources(); + + /** + * get a resource by it's id + * + * @param string $id + * @return IResource|null + */ + public function getResource($id); +} diff --git a/lib/public/Calendar/Resource/IResource.php b/lib/public/Calendar/Resource/IResource.php new file mode 100644 index 00000000000..a60378435b4 --- /dev/null +++ b/lib/public/Calendar/Resource/IResource.php @@ -0,0 +1,70 @@ +<?php +/** + * @copyright 2018, Georg Ehrke <oc.list@georgehrke.com> + * + * @author Georg Ehrke <oc.list@georgehrke.com> + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ + +namespace OCP\Calendar\Resource; + +/** + * Interface IResource + * + * @package OCP\Calendar\Resource + * @since 14.0.0 + */ +interface IResource { + + /** + * get the resource id + * + * This id has to be unique within the backend + * + * @return string + * @since 14.0.0 + */ + public function getId(); + + /** + * get the display name for a resource + * + * @return string + * @since 14.0.0 + */ + public function getDisplayName(); + + /** + * Get a list of groupIds that are allowed to access this resource + * + * If an empty array is returned, no group restrictions are + * applied. + * + * @return string[] + * @since 14.0.0 + */ + public function getGroupRestrictions(); + + /** + * Get the name of the backend class the room is connected with + * + * @return string + * @since 14.0.0 + */ + public function getBackendClassName(); +} diff --git a/lib/public/Calendar/Room/IBackend.php b/lib/public/Calendar/Room/IBackend.php new file mode 100644 index 00000000000..a7550347c74 --- /dev/null +++ b/lib/public/Calendar/Room/IBackend.php @@ -0,0 +1,55 @@ +<?php +/** + * @copyright 2018, Georg Ehrke <oc.list@georgehrke.com> + * + * @author Georg Ehrke <oc.list@georgehrke.com> + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ + +namespace OCP\Calendar\Room; + +/** + * Interface IBackend + * + * @package OCP\Calendar\Room + * @since 14.0.0 + */ +interface IBackend { + + /** + * get a list of all rooms in this backend + * + * @return IRoom[] + */ + public function getAllRooms(); + + /** + * get a list of all room identifiers in this backend + * + * @return string[] + */ + public function listAllRooms(); + + /** + * get a room by it's id + * + * @param string $id + * @return IRoom|null + */ + public function getRoom($id); +} diff --git a/lib/public/Calendar/Room/IRoom.php b/lib/public/Calendar/Room/IRoom.php new file mode 100644 index 00000000000..deac92a79d2 --- /dev/null +++ b/lib/public/Calendar/Room/IRoom.php @@ -0,0 +1,70 @@ +<?php +/** + * @copyright 2018, Georg Ehrke <oc.list@georgehrke.com> + * + * @author Georg Ehrke <oc.list@georgehrke.com> + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ + +namespace OCP\Calendar\Room; + +/** + * Interface IRoom + * + * @package OCP\Calendar\Room + * @since 14.0.0 + */ +interface IRoom { + + /** + * get the room id + * + * This id has to be unique within the backend + * + * @return string + * @since 14.0.0 + */ + public function getId(); + + /** + * get the display name for a room + * + * @return string + * @since 14.0.0 + */ + public function getDisplayName(); + + /** + * Get a list of groupIds that are allowed to access this room + * + * If an empty array is returned, no group restrictions are + * applied. + * + * @return string[] + * @since 14.0.0 + */ + public function getGroupRestrictions(); + + /** + * Get the name of the backend class the room is connected with + * + * @return string + * @since 14.0.0 + */ + public function getBackendClassName(); +} |