diff options
Diffstat (limited to 'lib/public/Share_Backend_Collection.php')
| -rw-r--r-- | lib/public/Share_Backend_Collection.php | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/lib/public/Share_Backend_Collection.php b/lib/public/Share_Backend_Collection.php new file mode 100644 index 00000000000..185cf32ce3e --- /dev/null +++ b/lib/public/Share_Backend_Collection.php @@ -0,0 +1,40 @@ +<?php +/** + * @author Joas Schilling <nickvergessen@owncloud.com> + * @author Morris Jobke <hey@morrisjobke.de> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * 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, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +// use OCP namespace for all classes that are considered public. +// This means that they should be used by apps instead of the internal ownCloud classes +namespace OCP; + +/** + * Interface for collections of of items implemented by another share backend. + * Extends the Share_Backend interface. + * @since 5.0.0 + */ +interface Share_Backend_Collection extends Share_Backend { + /** + * Get the sources of the children of the item + * @param string $itemSource + * @return array Returns an array of children each inside an array with the keys: source, target, and file_path if applicable + * @since 5.0.0 + */ + public function getChildren($itemSource); +} |