IProviderFactory.php 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Julius Härtl <jus@bitgrid.net>
  6. * @author Robin Appelman <robin@icewind.nl>
  7. * @author Roeland Jago Douma <roeland@famdouma.nl>
  8. *
  9. * @license AGPL-3.0
  10. *
  11. * This code is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License, version 3,
  13. * as published by the Free Software Foundation.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License, version 3,
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>
  22. *
  23. */
  24. namespace OCP\Share;
  25. use OC\Share20\Exception\ProviderException;
  26. /**
  27. * Interface IProviderFactory
  28. *
  29. * @since 9.0.0
  30. */
  31. interface IProviderFactory {
  32. /**
  33. * @param string $id
  34. * @return IShareProvider
  35. * @throws ProviderException
  36. * @since 9.0.0
  37. */
  38. public function getProvider($id);
  39. /**
  40. * @param int $shareType
  41. * @return IShareProvider
  42. * @throws ProviderException
  43. * @since 9.0.0
  44. */
  45. public function getProviderForType($shareType);
  46. /**
  47. * @return IShareProvider[]
  48. * @since 11.0.0
  49. */
  50. public function getAllProviders();
  51. /**
  52. * @since 21.0.0
  53. * @param string $shareProvier
  54. */
  55. public function registerProvider(string $shareProvier): void;
  56. }