parent
a2457b5fb9
commit
dfde04291e
@ -0,0 +1,68 @@ |
||||
<?php |
||||
/** |
||||
* ownCloud |
||||
* |
||||
* @author Bjoern Schiessle, Michael Gapczynski |
||||
* @copyright 2012 Michael Gapczynski <mtgap@owncloud.com> |
||||
* 2014 Bjoern Schiessle <schiessle@owncloud.com> |
||||
* |
||||
* This file is licensed under the Affero General Public License version 3 or |
||||
* later. |
||||
* See the COPYING-README file. |
||||
*/ |
||||
|
||||
// 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. |
||||
*/ |
||||
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 |
||||
*/ |
||||
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_# |
||||
*/ |
||||
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 TODO |
||||
* |
||||
* 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. |
||||
*/ |
||||
public function formatItems($items, $format, $parameters = null); |
||||
|
||||
} |
@ -0,0 +1,29 @@ |
||||
<?php |
||||
/** |
||||
* ownCloud |
||||
* |
||||
* @author Bjoern Schiessle, Michael Gapczynski |
||||
* @copyright 2012 Michael Gapczynski <mtgap@owncloud.com> |
||||
* 2014 Bjoern Schiessle <schiessle@owncloud.com> |
||||
* |
||||
* This file is licensed under the Affero General Public License version 3 or |
||||
* later. |
||||
* See the COPYING-README file. |
||||
*/ |
||||
|
||||
// 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. |
||||
*/ |
||||
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 |
||||
*/ |
||||
public function getChildren($itemSource); |
||||
} |
@ -0,0 +1,31 @@ |
||||
<?php |
||||
/** |
||||
* ownCloud |
||||
* |
||||
* @author Bjoern Schiessle, Michael Gapczynski |
||||
* @copyright 2012 Michael Gapczynski <mtgap@owncloud.com> |
||||
* 2014 Bjoern Schiessle <schiessle@owncloud.com> |
||||
* |
||||
* This file is licensed under the Affero General Public License version 3 or |
||||
* later. |
||||
* See the COPYING-README file. |
||||
*/ |
||||
|
||||
// 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 share backends that share content that is dependent on files. |
||||
* Extends the Share_Backend interface. |
||||
*/ |
||||
interface Share_Backend_File_Dependent extends Share_Backend { |
||||
/** |
||||
* Get the file path of the item |
||||
* @param string $itemSource |
||||
* @param string $uidOwner User that is the owner of shared item |
||||
* @return string|false |
||||
*/ |
||||
public function getFilePath($itemSource, $uidOwner); |
||||
|
||||
} |
Loading…
Reference in new issue