diff options
Diffstat (limited to 'lib/public/Share_Backend.php')
| -rw-r--r-- | lib/public/Share_Backend.php | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/lib/public/Share_Backend.php b/lib/public/Share_Backend.php new file mode 100644 index 00000000000..110403c1f49 --- /dev/null +++ b/lib/public/Share_Backend.php @@ -0,0 +1,96 @@ +<?php +/** + * @author Björn Schießle <schiessle@owncloud.com> + * @author Joas Schilling <nickvergessen@owncloud.com> + * @author Morris Jobke <hey@morrisjobke.de> + * @author Robin McCorkell <robin@mccorkell.me.uk> + * + * @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 that apps must implement to share content. + * @since 5.0.0 + */ +interface Share_Backend { + + /** + * Check if this $itemSource exist for the user + * @param string $itemSource + * @param string $uidOwner Owner of the item + * @return boolean|null Source + * + * Return false if the item does not exist for the user + * @since 5.0.0 + */ + public function isValidSource($itemSource, $uidOwner); + + /** + * Get a unique name of the item for the specified user + * @param string $itemSource + * @param string|false $shareWith User the item is being shared with + * @param array|null $exclude List of similar item names already existing as shared items @deprecated since version OC7 + * @return string Target name + * + * This function needs to verify that the user does not already have an item with this name. + * If it does generate a new name e.g. name_# + * @since 5.0.0 + */ + public function generateTarget($itemSource, $shareWith, $exclude = null); + + /** + * Converts the shared item sources back into the item in the specified format + * @param array $items Shared items + * @param int $format + * @return array + * + * The items array is a 3-dimensional array with the item_source as the + * first key and the share id as the second key to an array with the share + * info. + * + * The key/value pairs included in the share info depend on the function originally called: + * If called by getItem(s)Shared: id, item_type, item, item_source, + * share_type, share_with, permissions, stime, file_source + * + * If called by getItem(s)SharedWith: id, item_type, item, item_source, + * item_target, share_type, share_with, permissions, stime, file_source, + * file_target + * + * This function allows the backend to control the output of shared items with custom formats. + * It is only called through calls to the public getItem(s)Shared(With) functions. + * @since 5.0.0 + */ + public function formatItems($items, $format, $parameters = null); + + /** + * Check if a given share type is allowd by the back-end + * + * @param int $shareType share type + * @return boolean + * + * The back-end can enable/disable specific share types. Just return true if + * the back-end doesn't provide any specific settings for it and want to allow + * all share types defined by the share API + * @since 8.0.0 + */ + public function isShareTypeAllowed($shareType); + +} |