Better documentation for isValidSource function

This commit is contained in:
Bart Visscher 2014-05-01 18:11:55 +02:00
parent 50f49c57b5
commit c34659dd89
1 changed files with 1 additions and 4 deletions

View File

@ -341,15 +341,12 @@ class Share extends \OC\Share\Constants {
interface Share_Backend {
/**
* Get the source of the item to be stored in the database
* Check if this $itemSource exist for the user
* @param string $itemSource
* @param string $uidOwner Owner of the item
* @return boolean|null Source
*
* Return an array if the item is file dependent, the array needs two keys: 'item' and 'file'
* Return false if the item does not exist for the user
*
* The formatItems() function will translate the source returned back into the item
*/
public function isValidSource($itemSource, $uidOwner);