AdapterInterface.php 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. <?php
  2. namespace League\Flysystem;
  3. interface AdapterInterface extends ReadInterface
  4. {
  5. /**
  6. * @const VISIBILITY_PUBLIC public visibility
  7. */
  8. const VISIBILITY_PUBLIC = 'public';
  9. /**
  10. * @const VISIBILITY_PRIVATE private visibility
  11. */
  12. const VISIBILITY_PRIVATE = 'private';
  13. /**
  14. * Write a new file.
  15. *
  16. * @param string $path
  17. * @param string $contents
  18. * @param Config $config Config object
  19. *
  20. * @return array|false false on failure file meta data on success
  21. */
  22. public function write($path, $contents, Config $config);
  23. /**
  24. * Write a new file using a stream.
  25. *
  26. * @param string $path
  27. * @param resource $resource
  28. * @param Config $config Config object
  29. *
  30. * @return array|false false on failure file meta data on success
  31. */
  32. public function writeStream($path, $resource, Config $config);
  33. /**
  34. * Update a file.
  35. *
  36. * @param string $path
  37. * @param string $contents
  38. * @param Config $config Config object
  39. *
  40. * @return array|false false on failure file meta data on success
  41. */
  42. public function update($path, $contents, Config $config);
  43. /**
  44. * Update a file using a stream.
  45. *
  46. * @param string $path
  47. * @param resource $resource
  48. * @param Config $config Config object
  49. *
  50. * @return array|false false on failure file meta data on success
  51. */
  52. public function updateStream($path, $resource, Config $config);
  53. /**
  54. * Rename a file.
  55. *
  56. * @param string $path
  57. * @param string $newpath
  58. *
  59. * @return bool
  60. */
  61. public function rename($path, $newpath);
  62. /**
  63. * Copy a file.
  64. *
  65. * @param string $path
  66. * @param string $newpath
  67. *
  68. * @return bool
  69. */
  70. public function copy($path, $newpath);
  71. /**
  72. * Delete a file.
  73. *
  74. * @param string $path
  75. *
  76. * @return bool
  77. */
  78. public function delete($path);
  79. /**
  80. * Delete a directory.
  81. *
  82. * @param string $dirname
  83. *
  84. * @return bool
  85. */
  86. public function deleteDir($dirname);
  87. /**
  88. * Create a directory.
  89. *
  90. * @param string $dirname directory name
  91. * @param Config $config
  92. *
  93. * @return array|false
  94. */
  95. public function createDir($dirname, Config $config);
  96. /**
  97. * Set the visibility for a file.
  98. *
  99. * @param string $path
  100. * @param string $visibility
  101. *
  102. * @return array|false file meta data
  103. */
  104. public function setVisibility($path, $visibility);
  105. }