IStorageFactory.php 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Morris Jobke <hey@morrisjobke.de>
  6. * @author Robin Appelman <robin@icewind.nl>
  7. * @author Vincent Petry <pvince81@owncloud.com>
  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\Files\Storage;
  25. use OCP\Files\Mount\IMountPoint;
  26. /**
  27. * Creates storage instances and manages and applies storage wrappers
  28. * @since 8.0.0
  29. */
  30. interface IStorageFactory {
  31. /**
  32. * allow modifier storage behaviour by adding wrappers around storages
  33. *
  34. * $callback should be a function of type (string $mountPoint, Storage $storage) => Storage
  35. *
  36. * @param string $wrapperName
  37. * @param callable $callback
  38. * @return bool true if the wrapper was added, false if there was already a wrapper with this
  39. * name registered
  40. * @since 8.0.0
  41. */
  42. public function addStorageWrapper($wrapperName, $callback);
  43. /**
  44. * @param \OCP\Files\Mount\IMountPoint $mountPoint
  45. * @param string $class
  46. * @param array $arguments
  47. * @return \OCP\Files\Storage
  48. * @since 8.0.0
  49. */
  50. public function getInstance(IMountPoint $mountPoint, $class, $arguments);
  51. }