Storage.php 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. <?php
  2. namespace Illuminate\Support\Facades;
  3. use Illuminate\Filesystem\Filesystem;
  4. /**
  5. * @method static \Illuminate\Contracts\Filesystem\Filesystem assertExists(string|array $path)
  6. * @method static \Illuminate\Contracts\Filesystem\Filesystem assertMissing(string|array $path)
  7. * @method static \Illuminate\Contracts\Filesystem\Filesystem cloud()
  8. * @method static \Illuminate\Contracts\Filesystem\Filesystem build(string|array $root)
  9. * @method static \Illuminate\Contracts\Filesystem\Filesystem disk(string|null $name = null)
  10. * @method static \Illuminate\Filesystem\FilesystemManager extend(string $driver, \Closure $callback)
  11. * @method static \Symfony\Component\HttpFoundation\StreamedResponse download(string $path, string|null $name = null, array|null $headers = [])
  12. * @method static \Symfony\Component\HttpFoundation\StreamedResponse response(string $path, string|null $name = null, array|null $headers = [], string|null $disposition = 'inline')
  13. * @method static array allDirectories(string|null $directory = null)
  14. * @method static array allFiles(string|null $directory = null)
  15. * @method static array directories(string|null $directory = null, bool $recursive = false)
  16. * @method static array files(string|null $directory = null, bool $recursive = false)
  17. * @method static bool append(string $path, string $data)
  18. * @method static bool copy(string $from, string $to)
  19. * @method static bool delete(string|array $paths)
  20. * @method static bool deleteDirectory(string $directory)
  21. * @method static bool exists(string $path)
  22. * @method static bool makeDirectory(string $path)
  23. * @method static bool missing(string $path)
  24. * @method static bool move(string $from, string $to)
  25. * @method static bool prepend(string $path, string $data)
  26. * @method static bool put(string $path, \Psr\Http\Message\StreamInterface|\Illuminate\Http\File|\Illuminate\Http\UploadedFile|string|resource $contents, mixed $options = [])
  27. * @method static bool setVisibility(string $path, string $visibility)
  28. * @method static bool writeStream(string $path, resource $resource, array $options = [])
  29. * @method static int lastModified(string $path)
  30. * @method static int size(string $path)
  31. * @method static resource|null readStream(string $path)
  32. * @method static string get(string $path)
  33. * @method static string getVisibility(string $path)
  34. * @method static string path(string $path)
  35. * @method static string temporaryUrl(string $path, \DateTimeInterface $expiration, array $options = [])
  36. * @method static string url(string $path)
  37. * @method static string|false mimeType(string $path)
  38. * @method static string|false putFile(string $path, \Illuminate\Http\File|\Illuminate\Http\UploadedFile|string $file, mixed $options = [])
  39. * @method static string|false putFileAs(string $path, \Illuminate\Http\File|\Illuminate\Http\UploadedFile|string $file, string $name, mixed $options = [])
  40. * @method static void macro(string $name, object|callable $macro)
  41. * @method static void buildTemporaryUrlsUsing(\Closure $callback)
  42. *
  43. * @see \Illuminate\Filesystem\FilesystemManager
  44. */
  45. class Storage extends Facade
  46. {
  47. /**
  48. * Replace the given disk with a local testing disk.
  49. *
  50. * @param string|null $disk
  51. * @param array $config
  52. * @return \Illuminate\Contracts\Filesystem\Filesystem
  53. */
  54. public static function fake($disk = null, array $config = [])
  55. {
  56. $disk = $disk ?: static::$app['config']->get('filesystems.default');
  57. $root = storage_path('framework/testing/disks/'.$disk);
  58. if ($token = ParallelTesting::token()) {
  59. $root = "{$root}_test_{$token}";
  60. }
  61. (new Filesystem)->cleanDirectory($root);
  62. static::set($disk, $fake = static::createLocalDriver(array_merge($config, [
  63. 'root' => $root,
  64. ])));
  65. return $fake;
  66. }
  67. /**
  68. * Replace the given disk with a persistent local testing disk.
  69. *
  70. * @param string|null $disk
  71. * @param array $config
  72. * @return \Illuminate\Contracts\Filesystem\Filesystem
  73. */
  74. public static function persistentFake($disk = null, array $config = [])
  75. {
  76. $disk = $disk ?: static::$app['config']->get('filesystems.default');
  77. static::set($disk, $fake = static::createLocalDriver(array_merge($config, [
  78. 'root' => storage_path('framework/testing/disks/'.$disk),
  79. ])));
  80. return $fake;
  81. }
  82. /**
  83. * Get the registered name of the component.
  84. *
  85. * @return string
  86. */
  87. protected static function getFacadeAccessor()
  88. {
  89. return 'filesystem';
  90. }
  91. }