Basic implementation of resource and collection handling

Signed-off-by: Joas Schilling <coding@schilljs.com>

5 files changed, 199 insertions, 0 deletions

diff --git a/lib/public/Collaboration/Resources/ICollection.php b/lib/public/Collaboration/Resources/ICollection.php
new file mode 100644
index 00000000000..408ec67401a
--- /dev/null
+++ b/lib/public/Collaboration/Resources/ICollection.php
@@ -0,0 +1,52 @@
+<?php
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2018 Joas Schilling <coding@schilljs.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\Collaboration\Resources;
+
+/**
+ * @since 15.0.0
+ */
+interface ICollection {
+
+	/**
+	 * @return IResource[]
+	 * @since 15.0.0
+	 */
+	public function getResources(): array;
+
+	/**
+	 * Adds a resource to a collection
+	 *
+	 * @param IResource $resource
+	 * @throws ResourceException when the resource is already part of the collection
+	 * @since 15.0.0
+	 */
+	public function addResource(IResource $resource);
+
+	/**
+	 * Removes a resource from a collection
+	 *
+	 * @param IResource $resource
+	 * @since 15.0.0
+	 */
+	public function removeResource(IResource $resource);
+}
diff --git a/lib/public/Collaboration/Resources/IManager.php b/lib/public/Collaboration/Resources/IManager.php
new file mode 100644
index 00000000000..9a7fda28bb4
--- /dev/null
+++ b/lib/public/Collaboration/Resources/IManager.php
@@ -0,0 +1,45 @@
+<?php
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2018 Joas Schilling <coding@schilljs.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\Collaboration\Resources;
+
+/**
+ * @since 15.0.0
+ */
+interface IManager extends IProvider {
+
+	/**
+	 * @param int $id
+	 * @return ICollection
+	 * @since 15.0.0
+	 */
+	public function getCollection(int $id): ICollection;
+
+	/**
+	 * @param string $type
+	 * @param string $id
+	 * @return IResource
+	 * @since 15.0.0
+	 */
+	public function getResource(string $type, string $id): IResource;
+
+}
diff --git a/lib/public/Collaboration/Resources/IProvider.php b/lib/public/Collaboration/Resources/IProvider.php
new file mode 100644
index 00000000000..06e2a6a81ee
--- /dev/null
+++ b/lib/public/Collaboration/Resources/IProvider.php
@@ -0,0 +1,27 @@
+<?php
+/**
+ * @copyright Copyright (c) 2018 Joas Schilling <coding@schilljs.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\Collaboration\Resources;
+
+
+interface IProvider {
+
+}
diff --git a/lib/public/Collaboration/Resources/IResource.php b/lib/public/Collaboration/Resources/IResource.php
new file mode 100644
index 00000000000..42631bc27a8
--- /dev/null
+++ b/lib/public/Collaboration/Resources/IResource.php
@@ -0,0 +1,48 @@
+<?php
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2018 Joas Schilling <coding@schilljs.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\Collaboration\Resources;
+
+/**
+ * @since 15.0.0
+ */
+interface IResource {
+
+	/**
+	 * @return string
+	 * @since 15.0.0
+	 */
+	public function getType(): string;
+
+	/**
+	 * @return string
+	 * @since 15.0.0
+	 */
+	public function getId(): string;
+
+	/**
+	 * @param IResource $resource
+	 * @return ICollection[]
+	 * @since 15.0.0
+	 */
+	public function getCollections(IResource $resource): array;
+}
diff --git a/lib/public/Collaboration/Resources/ResourceException.php b/lib/public/Collaboration/Resources/ResourceException.php
new file mode 100644
index 00000000000..f31b2031a89
--- /dev/null
+++ b/lib/public/Collaboration/Resources/ResourceException.php
@@ -0,0 +1,27 @@
+<?php
+/**
+ * @copyright Copyright (c) 2018 Joas Schilling <coding@schilljs.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\Collaboration\Resources;
+
+
+class ResourceException extends \RuntimeException {
+
+}