Storage.php 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
  1. <?php
  2. namespace Illuminate\Support\Facades;
  3. use Illuminate\Filesystem\Filesystem;
  4. /**
  5. * @method static \Illuminate\Contracts\Filesystem\Filesystem drive(string|null $name = null)
  6. * @method static \Illuminate\Contracts\Filesystem\Filesystem disk(string|null $name = null)
  7. * @method static \Illuminate\Contracts\Filesystem\Cloud cloud()
  8. * @method static \Illuminate\Contracts\Filesystem\Filesystem build(string|array $config)
  9. * @method static \Illuminate\Contracts\Filesystem\Filesystem createLocalDriver(array $config)
  10. * @method static \Illuminate\Contracts\Filesystem\Filesystem createFtpDriver(array $config)
  11. * @method static \Illuminate\Contracts\Filesystem\Filesystem createSftpDriver(array $config)
  12. * @method static \Illuminate\Contracts\Filesystem\Cloud createS3Driver(array $config)
  13. * @method static \Illuminate\Contracts\Filesystem\Filesystem createScopedDriver(array $config)
  14. * @method static \Illuminate\Filesystem\FilesystemManager set(string $name, mixed $disk)
  15. * @method static string getDefaultDriver()
  16. * @method static string getDefaultCloudDriver()
  17. * @method static \Illuminate\Filesystem\FilesystemManager forgetDisk(array|string $disk)
  18. * @method static void purge(string|null $name = null)
  19. * @method static \Illuminate\Filesystem\FilesystemManager extend(string $driver, \Closure $callback)
  20. * @method static \Illuminate\Filesystem\FilesystemManager setApplication(\Illuminate\Contracts\Foundation\Application $app)
  21. * @method static bool exists(string $path)
  22. * @method static string|null get(string $path)
  23. * @method static resource|null readStream(string $path)
  24. * @method static bool put(string $path, \Psr\Http\Message\StreamInterface|\Illuminate\Http\File|\Illuminate\Http\UploadedFile|string|resource $contents, mixed $options = [])
  25. * @method static bool writeStream(string $path, resource $resource, array $options = [])
  26. * @method static string getVisibility(string $path)
  27. * @method static bool setVisibility(string $path, string $visibility)
  28. * @method static bool prepend(string $path, string $data)
  29. * @method static bool append(string $path, string $data)
  30. * @method static bool delete(string|array $paths)
  31. * @method static bool copy(string $from, string $to)
  32. * @method static bool move(string $from, string $to)
  33. * @method static int size(string $path)
  34. * @method static int lastModified(string $path)
  35. * @method static array files(string|null $directory = null, bool $recursive = false)
  36. * @method static array allFiles(string|null $directory = null)
  37. * @method static array directories(string|null $directory = null, bool $recursive = false)
  38. * @method static array allDirectories(string|null $directory = null)
  39. * @method static bool makeDirectory(string $path)
  40. * @method static bool deleteDirectory(string $directory)
  41. * @method static \Illuminate\Filesystem\FilesystemAdapter assertExists(string|array $path, string|null $content = null)
  42. * @method static \Illuminate\Filesystem\FilesystemAdapter assertMissing(string|array $path)
  43. * @method static \Illuminate\Filesystem\FilesystemAdapter assertDirectoryEmpty(string $path)
  44. * @method static bool missing(string $path)
  45. * @method static bool fileExists(string $path)
  46. * @method static bool fileMissing(string $path)
  47. * @method static bool directoryExists(string $path)
  48. * @method static bool directoryMissing(string $path)
  49. * @method static string path(string $path)
  50. * @method static array|null json(string $path, int $flags = 0)
  51. * @method static \Symfony\Component\HttpFoundation\StreamedResponse response(string $path, string|null $name = null, array $headers = [], string|null $disposition = 'inline')
  52. * @method static \Symfony\Component\HttpFoundation\StreamedResponse download(string $path, string|null $name = null, array $headers = [])
  53. * @method static string|false putFile(\Illuminate\Http\File|\Illuminate\Http\UploadedFile|string $path, \Illuminate\Http\File|\Illuminate\Http\UploadedFile|string|array|null $file = null, mixed $options = [])
  54. * @method static string|false putFileAs(\Illuminate\Http\File|\Illuminate\Http\UploadedFile|string $path, \Illuminate\Http\File|\Illuminate\Http\UploadedFile|string|array|null $file, string|array|null $name = null, mixed $options = [])
  55. * @method static string|false checksum(string $path, array $options = [])
  56. * @method static string|false mimeType(string $path)
  57. * @method static string url(string $path)
  58. * @method static bool providesTemporaryUrls()
  59. * @method static string temporaryUrl(string $path, \DateTimeInterface $expiration, array $options = [])
  60. * @method static array temporaryUploadUrl(string $path, \DateTimeInterface $expiration, array $options = [])
  61. * @method static \League\Flysystem\FilesystemOperator getDriver()
  62. * @method static \League\Flysystem\FilesystemAdapter getAdapter()
  63. * @method static array getConfig()
  64. * @method static void buildTemporaryUrlsUsing(\Closure $callback)
  65. * @method static \Illuminate\Filesystem\FilesystemAdapter|mixed when(\Closure|mixed|null $value = null, callable|null $callback = null, callable|null $default = null)
  66. * @method static \Illuminate\Filesystem\FilesystemAdapter|mixed unless(\Closure|mixed|null $value = null, callable|null $callback = null, callable|null $default = null)
  67. * @method static void macro(string $name, object|callable $macro)
  68. * @method static void mixin(object $mixin, bool $replace = true)
  69. * @method static bool hasMacro(string $name)
  70. * @method static void flushMacros()
  71. * @method static mixed macroCall(string $method, array $parameters)
  72. * @method static bool has(string $location)
  73. * @method static string read(string $location)
  74. * @method static \League\Flysystem\DirectoryListing listContents(string $location, bool $deep = false)
  75. * @method static int fileSize(string $path)
  76. * @method static string visibility(string $path)
  77. * @method static void write(string $location, string $contents, array $config = [])
  78. * @method static void createDirectory(string $location, array $config = [])
  79. *
  80. * @see \Illuminate\Filesystem\FilesystemManager
  81. */
  82. class Storage extends Facade
  83. {
  84. /**
  85. * Replace the given disk with a local testing disk.
  86. *
  87. * @param string|null $disk
  88. * @param array $config
  89. * @return \Illuminate\Contracts\Filesystem\Filesystem
  90. */
  91. public static function fake($disk = null, array $config = [])
  92. {
  93. $disk = $disk ?: static::$app['config']->get('filesystems.default');
  94. $root = storage_path('framework/testing/disks/'.$disk);
  95. if ($token = ParallelTesting::token()) {
  96. $root = "{$root}_test_{$token}";
  97. }
  98. (new Filesystem)->cleanDirectory($root);
  99. static::set($disk, $fake = static::createLocalDriver(array_merge($config, [
  100. 'root' => $root,
  101. ])));
  102. return tap($fake)->buildTemporaryUrlsUsing(function ($path, $expiration) {
  103. return URL::to($path.'?expiration='.$expiration->getTimestamp());
  104. });
  105. }
  106. /**
  107. * Replace the given disk with a persistent local testing disk.
  108. *
  109. * @param string|null $disk
  110. * @param array $config
  111. * @return \Illuminate\Contracts\Filesystem\Filesystem
  112. */
  113. public static function persistentFake($disk = null, array $config = [])
  114. {
  115. $disk = $disk ?: static::$app['config']->get('filesystems.default');
  116. static::set($disk, $fake = static::createLocalDriver(array_merge($config, [
  117. 'root' => storage_path('framework/testing/disks/'.$disk),
  118. ])));
  119. return $fake;
  120. }
  121. /**
  122. * Get the registered name of the component.
  123. *
  124. * @return string
  125. */
  126. protected static function getFacadeAccessor()
  127. {
  128. return 'filesystem';
  129. }
  130. }