- The example above demonstrates the responsive images technique used in the Laravel MediaLibrary.
+ The example above demonstrates the responsive images technique used in the Laravel MediaLibrary.
Try this:
@@ -30,7 +30,7 @@ weight: 5
What happens?
-
- We start with an image that has
srcset values, rendered by the Laravel MediaLibrary
+ We start with an image that has srcset values, rendered by the Laravel MediaLibrary
-
An initial
sizes="1px" attribute is used to render an inline base64-encoded SVG placeholder first
diff --git a/docs/responsive-images/generating-your-own-tiny-placeholder.md b/docs/responsive-images/generating-your-own-tiny-placeholder.md
index 4b8f9915b..36c49a21e 100644
--- a/docs/responsive-images/generating-your-own-tiny-placeholder.md
+++ b/docs/responsive-images/generating-your-own-tiny-placeholder.md
@@ -3,7 +3,7 @@ title: Generating your own tiny placeholder
weight: 4
---
-When generating responsive images, the media library will generate a tiny version of your image which will be used for [progressive image loading](/laravel-medialibrary/v8/responsive-images/getting-started-with-responsive-images#progressive-image-loading). By default this tiny version will be blurred version of the original.
+When generating responsive images, the media library will generate a tiny version of your image which will be used for [progressive image loading](/laravel-medialibrary/v9/responsive-images/getting-started-with-responsive-images#progressive-image-loading). By default this tiny version will be blurred version of the original.
You can customize how the tiny version of the image should be generated. Maybe you want a to just use the dominant color instead of blur. In the `responsive_images.tiny_placeholder_generator` of the `media-library` config file you can specify a class that implements `Spatie\MediaLibrary\ResponsiveImages\TinyPlaceholderGenerator`. This interface only requires you to implement one function:
diff --git a/docs/responsive-images/getting-started-with-responsive-images.md b/docs/responsive-images/getting-started-with-responsive-images.md
index ff830fa51..78eca6462 100644
--- a/docs/responsive-images/getting-started-with-responsive-images.md
+++ b/docs/responsive-images/getting-started-with-responsive-images.md
@@ -7,7 +7,7 @@ Websites are viewed on various devices with widely differing screen sizes and co
The media library has support for generating the necessary files and html markup for responsive images. In addition the medialibrary also has support for progressive image loading.
-Try a [demo of the concept](/laravel-medialibrary/v8/responsive-images/demo) here.
+Try a [demo of the concept](/laravel-medialibrary/v9/responsive-images/demo) here.
### Introducing the srcset attribute
@@ -76,7 +76,7 @@ $yourModel
->toMediaCollection();
```
-Behind the scenes, the media library will generate multiple size variations of your image. To learn which variations are generated and how to customize head over [here](/laravel-medialibrary/v8/responsive-images/using-your-own-width-calculator).
+Behind the scenes, the media library will generate multiple size variations of your image. To learn which variations are generated and how to customize head over [here](/laravel-medialibrary/v9/responsive-images/using-your-own-width-calculator).
### Displaying responsive images
@@ -96,7 +96,7 @@ Per image attached to your model the resulting html will look more or less like
### Generating responsive images for conversions
-You can also generate responsive images for any [image conversions](https://docs.spatie.be/laravel-medialibrary/v8/converting-images/defining-conversions) you define. Simply use `withResponsiveImages` when defining a conversion.
+You can also generate responsive images for any [image conversions](https://docs.spatie.be/laravel-medialibrary/v9/converting-images/defining-conversions) you define. Simply use `withResponsiveImages` when defining a conversion.
Here's an example where we define a conversion to make a greyscale version and generate responsive, greyscaled images.
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
new file mode 100644
index 000000000..5f567aeb9
--- /dev/null
+++ b/docs/troubleshooting.md
@@ -0,0 +1,27 @@
+---
+title: Troubleshooting
+weight: 8
+---
+
+
+Here are some common problems and how to solve them.
+
+## Cannot find module '@babel/compat-data/corejs3-shipped-proposals'
+
+This is caused by a compatability issue between a version of `@babel/preset-env` that an older release of Laravel Mix required, and certain versions of node.
+
+### Fix
+
+```
+yarn upgrade laravel-mix
+```
+
+This will upgrade your installation of `laravel-mix` to a version that requires `@babel/preset-env: ^7.9`. You shouldn't have to change anything else, since this upgrade is a non-breaking change.
+
+## Cannot find name 'describe' / Cannot find name 'test'
+
+This is your TypeScript checker finding methods that it does not have types for.
+
+### Fix
+
+You should add `"include": ["resources/**/*"]` to your tsconfig.json (edit the path to where you manage your JS), or add `"exclude": ["vendor"]`. This doesn't normally happen with other libraries because `node_modules` is excluded from type checking by default.
diff --git a/docs/working-with-media-collections/defining-media-collections.md b/docs/working-with-media-collections/defining-media-collections.md
index 816005332..65fd0eb99 100644
--- a/docs/working-with-media-collections/defining-media-collections.md
+++ b/docs/working-with-media-collections/defining-media-collections.md
@@ -3,9 +3,9 @@ title: Defining media collections
weight: 2
---
-A media collection can be more than [just a name to group files](/laravel-medialibrary/v8/working-with-media-collections/simple-media-collections). By defining a media collection in your model you can add certain behaviour collections.
+A media collection can be more than [just a name to group files](/laravel-medialibrary/v9/working-with-media-collections/simple-media-collections). By defining a media collection in your model you can add certain behaviour collections.
-To get started with media collections add a function called `registerMediaCollections` to [your prepared model](/laravel-medialibrary/v8/basic-usage/preparing-your-model). Inside that function you can use `addMediaCollection` to start a media collection.
+To get started with media collections add a function called `registerMediaCollections` to [your prepared model](/laravel-medialibrary/v9/basic-usage/preparing-your-model). Inside that function you can use `addMediaCollection` to start a media collection.
```php
// in your model
@@ -197,7 +197,7 @@ $yourModel->getFirstMediaUrl('avatar'); // will return an url to the `$secondFil
## Registering media conversions
-It's recommended that your first read the section on [converting images](/laravel-medialibrary/v8/converting-images/defining-conversions) before reading the following paragraphs.
+It's recommended that your first read the section on [converting images](/laravel-medialibrary/v9/converting-images/defining-conversions) before reading the following paragraphs.
Normally image conversions are registered inside the `registerMediaConversions` function on your model. However, images conversions can also be registered inside media collections.
@@ -227,7 +227,7 @@ $yourModel->addMedia($pathToImage)->toMediaCollection('my-collection');
$yourModel->getFirstMediaUrl('thumb') // returns an url to a 100x100 version of the added image.
```
-Take a look at the [defining conversions section](/laravel-medialibrary/v8/converting-images/defining-conversions) to learn all the functions you can tack on to `addMediaConversion`.
+Take a look at the [defining conversions section](/laravel-medialibrary/v9/converting-images/defining-conversions) to learn all the functions you can tack on to `addMediaConversion`.
## Generating responsive images
diff --git a/resources/views/responsiveImage.blade.php b/resources/views/responsiveImage.blade.php
index 4f90ec397..d98852b20 100644
--- a/resources/views/responsiveImage.blade.php
+++ b/resources/views/responsiveImage.blade.php
@@ -1 +1 @@
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/resources/views/responsiveImageWithPlaceholder.blade.php b/resources/views/responsiveImageWithPlaceholder.blade.php
index 8b0d2e3b7..00ec43194 100644
--- a/resources/views/responsiveImageWithPlaceholder.blade.php
+++ b/resources/views/responsiveImageWithPlaceholder.blade.php
@@ -1 +1 @@
-
+
diff --git a/src/Conversions/Actions/PerformConversionAction.php b/src/Conversions/Actions/PerformConversionAction.php
new file mode 100644
index 000000000..e8efaa2c2
--- /dev/null
+++ b/src/Conversions/Actions/PerformConversionAction.php
@@ -0,0 +1,60 @@
+convert($copiedOriginalFile, $conversion);
+
+ $manipulationResult = (new PerformManipulationsAction)->execute($media, $conversion, $copiedOriginalFile);
+
+ $newFileName = $conversion->getConversionFile($media);
+
+ $renamedFile = $this->renameInLocalDirectory($manipulationResult, $newFileName);
+
+ if ($conversion->shouldGenerateResponsiveImages()) {
+ /** @var ResponsiveImageGenerator $responsiveImageGenerator */
+ $responsiveImageGenerator = app(ResponsiveImageGenerator::class);
+
+ $responsiveImageGenerator->generateResponsiveImagesForConversion(
+ $media,
+ $conversion,
+ $renamedFile
+ );
+ }
+
+ app(Filesystem::class)->copyToMediaLibrary($renamedFile, $media, 'conversions');
+
+ $media->markAsConversionGenerated($conversion->getName());
+
+ event(new ConversionHasBeenCompleted($media, $conversion));
+ }
+
+ protected function renameInLocalDirectory(
+ string $fileNameWithDirectory,
+ string $newFileNameWithoutDirectory
+ ): string {
+ $targetFile = pathinfo($fileNameWithDirectory, PATHINFO_DIRNAME).'/'.$newFileNameWithoutDirectory;
+
+ rename($fileNameWithDirectory, $targetFile);
+
+ return $targetFile;
+ }
+}
diff --git a/src/Conversions/Actions/PerformManipulationsAction.php b/src/Conversions/Actions/PerformManipulationsAction.php
new file mode 100644
index 000000000..eaa2b3ef2
--- /dev/null
+++ b/src/Conversions/Actions/PerformManipulationsAction.php
@@ -0,0 +1,49 @@
+getManipulations()->isEmpty()) {
+ return $imageFile;
+ }
+
+ $conversionTempFile = $this->getConversionTempFileName($media, $conversion, $imageFile);
+
+ File::copy($imageFile, $conversionTempFile);
+
+ $supportedFormats = ['jpg', 'pjpg', 'png', 'gif'];
+ if ($conversion->shouldKeepOriginalImageFormat() && in_array($media->extension, $supportedFormats)) {
+ $conversion->format($media->extension);
+ }
+
+ ImageFactory::load($conversionTempFile)
+ ->manipulate($conversion->getManipulations())
+ ->save();
+
+ return $conversionTempFile;
+ }
+
+ protected function getConversionTempFileName(
+ Media $media,
+ Conversion $conversion,
+ string $imageFile
+ ): string {
+ $directory = pathinfo($imageFile, PATHINFO_DIRNAME);
+
+ $fileName = Str::random(32)."{$conversion->getName()}.{$media->extension}";
+
+ return "{$directory}/{$fileName}";
+ }
+}
diff --git a/src/Conversions/Conversion.php b/src/Conversions/Conversion.php
index 4d03e2302..32480f07f 100644
--- a/src/Conversions/Conversion.php
+++ b/src/Conversions/Conversion.php
@@ -5,13 +5,14 @@
use BadMethodCallException;
use Spatie\Image\Manipulations;
use Spatie\MediaLibrary\MediaCollections\Models\Media;
+use Spatie\MediaLibrary\Support\FileNamer\FileNamer;
/** @mixin \Spatie\Image\Manipulations */
class Conversion
{
protected string $name = '';
- protected ConversionFileNamer $conversionFileNamer;
+ protected FileNamer $fileNamer;
protected float $extractVideoFrameAtSecond = 0;
@@ -37,7 +38,7 @@ public function __construct(string $name)
->optimize(config('media-library.image_optimizers'))
->format(Manipulations::FORMAT_JPG);
- $this->conversionFileNamer = app(config('media-library.conversion_file_namer'));
+ $this->fileNamer = app(config('media-library.file_namer'));
$this->loadingAttributeValue = config('media-library.default_loading_attribute_value');
@@ -217,8 +218,10 @@ public function getResultExtension(string $originalFileExtension = ''): string
public function getConversionFile(Media $media): string
{
- $fileName = $this->conversionFileNamer->getFileName($this, $media);
- $extension = $this->conversionFileNamer->getExtension($this, $media);
+ $fileName = $this->fileNamer->conversionFileName($media->file_name, $this);
+
+ $fileExtension = $this->fileNamer->extensionFromBaseImage($media->file_name);
+ $extension = $this->getResultExtension($fileExtension) ?: $fileExtension;
return "{$fileName}.{$extension}";
}
diff --git a/src/Conversions/ConversionCollection.php b/src/Conversions/ConversionCollection.php
index 9788298f7..931ccdee1 100644
--- a/src/Conversions/ConversionCollection.php
+++ b/src/Conversions/ConversionCollection.php
@@ -83,13 +83,6 @@ public function getConversions(string $collectionName = ''): self
return $this->filter(fn (Conversion $conversion) => $conversion->shouldBePerformedOn($collectionName));
}
- public function getQueuedConversions(string $collectionName = ''): self
- {
- return $this
- ->getConversions($collectionName)
- ->filter(fn (Conversion $conversion) => $conversion->shouldBeQueued());
- }
-
protected function addManipulationToConversion(Manipulations $manipulations, string $conversionName)
{
/** @var \Spatie\MediaLibrary\Conversions\Conversion|null $conversion */
@@ -116,13 +109,6 @@ protected function addManipulationToConversion(Manipulations $manipulations, str
}
}
- public function getNonQueuedConversions(string $collectionName = ''): self
- {
- return $this
- ->getConversions($collectionName)
- ->reject(fn (Conversion $conversion) => $conversion->shouldBeQueued());
- }
-
public function getConversionsFiles(string $collectionName = ''): self
{
return $this
diff --git a/src/Conversions/ConversionFileNamer.php b/src/Conversions/ConversionFileNamer.php
deleted file mode 100644
index 45badd9a7..000000000
--- a/src/Conversions/ConversionFileNamer.php
+++ /dev/null
@@ -1,17 +0,0 @@
-file_name, PATHINFO_EXTENSION);
-
- return $conversion->getResultExtension($fileExtension) ?: $fileExtension;
- }
-}
diff --git a/src/Conversions/DefaultConversionFileNamer.php b/src/Conversions/DefaultConversionFileNamer.php
deleted file mode 100644
index 34bb1bfce..000000000
--- a/src/Conversions/DefaultConversionFileNamer.php
+++ /dev/null
@@ -1,15 +0,0 @@
-file_name, PATHINFO_FILENAME);
-
- return "{$fileName}-{$conversion->getName()}";
- }
-}
diff --git a/src/Conversions/FileManipulator.php b/src/Conversions/FileManipulator.php
index 93eeeeeac..0a8b06b17 100644
--- a/src/Conversions/FileManipulator.php
+++ b/src/Conversions/FileManipulator.php
@@ -2,164 +2,104 @@
namespace Spatie\MediaLibrary\Conversions;
-use Illuminate\Support\Facades\File;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Str;
-use Spatie\MediaLibrary\Conversions\Events\ConversionHasBeenCompleted;
-use Spatie\MediaLibrary\Conversions\Events\ConversionWillStart;
+use Spatie\MediaLibrary\Conversions\Actions\PerformConversionAction;
use Spatie\MediaLibrary\Conversions\ImageGenerators\ImageGeneratorFactory;
use Spatie\MediaLibrary\Conversions\Jobs\PerformConversionsJob;
use Spatie\MediaLibrary\MediaCollections\Filesystem;
use Spatie\MediaLibrary\MediaCollections\Models\Media;
-use Spatie\MediaLibrary\ResponsiveImages\ResponsiveImageGenerator;
-use Spatie\MediaLibrary\Support\ImageFactory;
use Spatie\MediaLibrary\Support\TemporaryDirectory;
class FileManipulator
{
- public function createDerivedFiles(Media $media, array $only = [], bool $onlyMissing = false): void
- {
- $profileCollection = ConversionCollection::createForMedia($media);
-
- if (! empty($only)) {
- $profileCollection = $profileCollection->filter(
- fn (Conversion $conversion) => in_array($conversion->getName(), $only)
- );
+ public function createDerivedFiles(
+ Media $media,
+ array $onlyConversionNames = [],
+ bool $onlyMissing = false
+ ): void {
+ if (!$this->canConvertMedia($media)) {
+ return;
}
- $this->performConversions(
- $profileCollection->getNonQueuedConversions($media->collection_name),
- $media,
- $onlyMissing
- );
+ [$queuedConversions, $conversions] = ConversionCollection::createForMedia($media)
+ ->filter(function (Conversion $conversion) use ($onlyConversionNames) {
+ if (count($onlyConversionNames) === 0) {
+ return true;
+ }
- $queuedConversions = $profileCollection->getQueuedConversions($media->collection_name);
+ return in_array($conversion->getName(), $onlyConversionNames);
+ })
+ ->filter(fn (Conversion $conversion) => $conversion->shouldBePerformedOn($media->collection_name))
+ ->partition(fn (Conversion $conversion) => $conversion->shouldBeQueued());
- if ($queuedConversions->isNotEmpty()) {
- $this->dispatchQueuedConversions($media, $queuedConversions, $onlyMissing);
- }
+ $this
+ ->dispatchQueuedConversions($media, $queuedConversions, $onlyMissing)
+ ->performConversions($conversions, $media, $onlyMissing);
}
- public function performConversions(ConversionCollection $conversions, Media $media, bool $onlyMissing = false)
- {
+ public function performConversions(
+ ConversionCollection $conversions,
+ Media $media,
+ bool $onlyMissing = false
+ ): self {
if ($conversions->isEmpty()) {
- return;
- }
-
- $imageGenerator = ImageGeneratorFactory::forMedia($media);
-
- if (! $imageGenerator) {
- return;
+ return $this;
}
$temporaryDirectory = TemporaryDirectory::create();
- $copiedOriginalFile = $this->filesystem()->copyFromMediaLibrary(
+ $copiedOriginalFile = app(Filesystem::class)->copyFromMediaLibrary(
$media,
- $temporaryDirectory->path(Str::random(16).'.'.$media->extension)
+ $temporaryDirectory->path(Str::random(32) . '.' . $media->extension)
);
$conversions
->reject(function (Conversion $conversion) use ($onlyMissing, $media) {
$relativePath = $media->getPath($conversion->getName());
- $rootPath = config("filesystems.disks.{$media->disk}.root");
-
- if ($rootPath) {
+ if ($rootPath = config("filesystems.disks.{$media->disk}.root")) {
$relativePath = str_replace($rootPath, '', $relativePath);
}
return $onlyMissing && Storage::disk($media->disk)->exists($relativePath);
})
- ->each(function (Conversion $conversion) use ($media, $imageGenerator, $copiedOriginalFile) {
- event(new ConversionWillStart($media, $conversion, $copiedOriginalFile));
-
- $copiedOriginalFile = $imageGenerator->convert($copiedOriginalFile, $conversion);
-
- $manipulationResult = $this->performManipulations($media, $conversion, $copiedOriginalFile);
-
- $newFileName = $conversion->getConversionFile($media);
-
- $renamedFile = $this->renameInLocalDirectory($manipulationResult, $newFileName);
-
- if ($conversion->shouldGenerateResponsiveImages()) {
- /** @var ResponsiveImageGenerator $responsiveImageGenerator */
- $responsiveImageGenerator = app(ResponsiveImageGenerator::class);
-
- $responsiveImageGenerator->generateResponsiveImagesForConversion(
- $media,
- $conversion,
- $renamedFile
- );
- }
-
- $this->filesystem()->copyToMediaLibrary($renamedFile, $media, 'conversions');
-
- $media->markAsConversionGenerated($conversion->getName(), true);
-
- event(new ConversionHasBeenCompleted($media, $conversion));
+ ->each(function (Conversion $conversion) use ($media, $copiedOriginalFile) {
+ (new PerformConversionAction)->execute($conversion, $media, $copiedOriginalFile);
});
$temporaryDirectory->delete();
- }
-
- public function performManipulations(Media $media, Conversion $conversion, string $imageFile): string
- {
- if ($conversion->getManipulations()->isEmpty()) {
- return $imageFile;
- }
- $conversionTempFile = $this->getConversionTempFileName($media, $conversion, $imageFile);
-
- File::copy($imageFile, $conversionTempFile);
-
- $supportedFormats = ['jpg', 'pjpg', 'png', 'gif'];
- if ($conversion->shouldKeepOriginalImageFormat() && in_array($media->extension, $supportedFormats)) {
- $conversion->format($media->extension);
- }
-
- ImageFactory::load($conversionTempFile)
- ->manipulate($conversion->getManipulations())
- ->save();
-
- return $conversionTempFile;
+ return $this;
}
- protected function dispatchQueuedConversions(Media $media, ConversionCollection $queuedConversions, bool $onlyMissing = false)
- {
- $performConversionsJobClass = config('media-library.jobs.perform_conversions', PerformConversionsJob::class);
-
- $job = new $performConversionsJobClass($queuedConversions, $media, $onlyMissing);
-
- if ($customQueue = config('media-library.queue_name')) {
- $job->onQueue($customQueue);
+ protected function dispatchQueuedConversions(
+ Media $media,
+ ConversionCollection $conversions,
+ bool $onlyMissing = false
+ ): self {
+ if ($conversions->isEmpty()) {
+ return $this;
}
- dispatch($job);
- }
-
- protected function renameInLocalDirectory(
- string $fileNameWithDirectory,
- string $newFileNameWithoutDirectory
- ): string {
- $targetFile = pathinfo($fileNameWithDirectory, PATHINFO_DIRNAME).'/'.$newFileNameWithoutDirectory;
+ $performConversionsJobClass = config(
+ 'media-library.jobs.perform_conversions',
+ PerformConversionsJob::class
+ );
- rename($fileNameWithDirectory, $targetFile);
+ /** @var PerformConversionsJob $job */
+ $job = (new $performConversionsJobClass($conversions, $media, $onlyMissing))
+ ->onQueue(config('media-library.queue_name'));
- return $targetFile;
- }
+ dispatch($job);
- protected function filesystem(): Filesystem
- {
- return app(Filesystem::class);
+ return $this;
}
- protected function getConversionTempFileName(Media $media, Conversion $conversion, string $imageFile): string
+ protected function canConvertMedia(Media $media): bool
{
- $directory = pathinfo($imageFile, PATHINFO_DIRNAME);
-
- $fileName = Str::random(16)."{$conversion->getName()}.{$media->extension}";
+ $imageGenerator = ImageGeneratorFactory::forMedia($media);
- return "{$directory}/{$fileName}";
+ return $imageGenerator ? true : false;
}
}
diff --git a/src/HasMedia.php b/src/HasMedia.php
index a1bc154c2..5e1343f5f 100644
--- a/src/HasMedia.php
+++ b/src/HasMedia.php
@@ -67,6 +67,7 @@ public function shouldDeletePreservingMedia(): bool;
* @param string $collectionName
*
* @return mixed
+ *
*/
public function loadMedia(string $collectionName);
diff --git a/src/InteractsWithMedia.php b/src/InteractsWithMedia.php
index 6baa7738e..62673ab4d 100644
--- a/src/InteractsWithMedia.php
+++ b/src/InteractsWithMedia.php
@@ -6,6 +6,7 @@
use Illuminate\Database\Eloquent\Relations\MorphMany;
use Illuminate\Database\Eloquent\SoftDeletes;
use Illuminate\Http\File;
+use Illuminate\Http\Request;
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Validator;
@@ -23,6 +24,8 @@
use Spatie\MediaLibrary\MediaCollections\MediaCollection;
use Spatie\MediaLibrary\MediaCollections\MediaRepository;
use Spatie\MediaLibrary\MediaCollections\Models\Media;
+use Spatie\MediaLibrary\Support\MediaLibraryPro;
+use Spatie\MediaLibraryPro\PendingMediaLibraryRequestHandler;
trait InteractsWithMedia
{
@@ -70,6 +73,11 @@ public function addMedia($file): FileAdder
return app(FileAdderFactory::class)->create($this, $file);
}
+ public function addMediaFromRequest(string $key): FileAdder
+ {
+ return app(FileAdderFactory::class)->createFromRequest($this, $key);
+ }
+
/**
* Add a file from the given disk.
*
@@ -83,9 +91,26 @@ public function addMediaFromDisk(string $key, string $disk = null): FileAdder
return app(FileAdderFactory::class)->createFromDisk($this, $key, $disk ?: config('filesystems.default'));
}
- public function addMediaFromRequest(string $key): FileAdder
+ public function addFromMediaLibraryRequest(?array $mediaLibraryRequestItems): PendingMediaLibraryRequestHandler
{
- return app(FileAdderFactory::class)->createFromRequest($this, $key);
+ MediaLibraryPro::ensureInstalled();
+
+ return new PendingMediaLibraryRequestHandler(
+ $mediaLibraryRequestItems ?? [],
+ $this,
+ $preserveExisting = true
+ );
+ }
+
+ public function syncFromMediaLibraryRequest(?array $mediaLibraryRequestItems): PendingMediaLibraryRequestHandler
+ {
+ MediaLibraryPro::ensureInstalled();
+
+ return new PendingMediaLibraryRequestHandler(
+ $mediaLibraryRequestItems ?? [],
+ $this,
+ $preserveExisting = false
+ );
}
/**
@@ -238,11 +263,13 @@ public function hasMedia(string $collectionName = 'default'): bool
* @param string $collectionName
* @param array|callable $filters
*
- * @return \Illuminate\Support\Collection
+ * @return MediaCollections\Models\Collections\MediaCollection
*/
- public function getMedia(string $collectionName = 'default', $filters = []): Collection
+ public function getMedia(string $collectionName = 'default', $filters = []): MediaCollections\Models\Collections\MediaCollection
{
- return app(MediaRepository::class)->getCollection($this, $collectionName, $filters);
+ return app(MediaRepository::class)
+ ->getCollection($this, $collectionName, $filters)
+ ->collectionName($collectionName);
}
public function getFirstMedia(string $collectionName = 'default', $filters = []): ?Media
@@ -499,6 +526,8 @@ public function loadMedia(string $collectionName): Collection
? $this->media
: collect($this->unAttachedMediaLibraryItems)->pluck('media');
+ $collection = new MediaCollections\Models\Collections\MediaCollection($collection);
+
return $collection
->filter(fn (Media $mediaItem) => $mediaItem->collection_name === $collectionName)
->sortBy('order_column')
diff --git a/src/MediaCollections/Commands/CleanCommand.php b/src/MediaCollections/Commands/CleanCommand.php
index f2c28f375..d597c71b5 100644
--- a/src/MediaCollections/Commands/CleanCommand.php
+++ b/src/MediaCollections/Commands/CleanCommand.php
@@ -175,10 +175,12 @@ protected function markConversionAsRemoved(Media $media, string $conversionPath)
$generatedConversionName = null;
$media->getGeneratedConversions()
- ->filter(fn (bool $isGenerated, string $generatedConversionName) => Str::contains($conversionFile, $generatedConversionName))
- ->each(function (bool $isGenerated, string $generatedConversionName) use ($media) {
- $media->markAsConversionGenerated($generatedConversionName, false);
- });
+ ->filter(
+ fn (bool $isGenerated, string $generatedConversionName) => Str::contains($conversionFile, $generatedConversionName)
+ )
+ ->each(
+ fn (bool $isGenerated, string $conversionName) => $media->markAsConversionNotGenerated($conversionName)
+ );
$media->save();
}
diff --git a/src/MediaCollections/Contracts/MediaLibraryRequest.php b/src/MediaCollections/Contracts/MediaLibraryRequest.php
new file mode 100644
index 000000000..3595addec
--- /dev/null
+++ b/src/MediaCollections/Contracts/MediaLibraryRequest.php
@@ -0,0 +1,10 @@
+filesystem = $fileSystem;
@@ -113,6 +116,10 @@ public function setFile($file): self
return $this;
}
+ if ($file instanceof TemporaryUpload) {
+ return $this;
+ }
+
throw UnknownType::create();
}
@@ -135,6 +142,13 @@ public function setName(string $name): self
return $this;
}
+ public function setOrder(int $order): self
+ {
+ $this->order = $order;
+
+ return $this;
+ }
+
public function usingFileName(string $fileName): self
{
return $this->setFileName($fileName);
@@ -241,6 +255,7 @@ public function toMediaCollectionFromRemote(string $collectionName = 'default',
$media->size = $storage->size($this->pathToFile);
$media->custom_properties = $this->customProperties;
+ $media->generated_conversions = [];
$media->responsive_images = [];
$media->manipulations = $this->manipulations;
@@ -262,6 +277,10 @@ public function toMediaCollection(string $collectionName = 'default', string $di
return $this->toMediaCollectionFromRemote($collectionName, $diskName);
}
+ if ($this->file instanceof TemporaryUpload) {
+ return $this->toMediaCollectionFromTemporaryUpload($collectionName, $diskName);
+ }
+
if (! is_file($this->pathToFile)) {
throw FileDoesNotExist::create($this->pathToFile);
}
@@ -290,8 +309,14 @@ public function toMediaCollection(string $collectionName = 'default', string $di
$media->mime_type = File::getMimeType($this->pathToFile);
$media->size = filesize($this->pathToFile);
+
+ if (! is_null($this->order)) {
+ $media->order_column = $this->order;
+ }
+
$media->custom_properties = $this->customProperties;
+ $media->generated_conversions = [];
$media->responsive_images = [];
$media->manipulations = $this->manipulations;
@@ -460,4 +485,23 @@ protected function checkGenerateResponsiveImages(Media $media)
$this->withResponsiveImages();
}
}
+
+ protected function toMediaCollectionFromTemporaryUpload(string $collectionName, string $diskName): Media
+ {
+ /** @var TemporaryUpload $temporaryUpload */
+ $temporaryUpload = $this->file;
+
+ $media = $temporaryUpload->getFirstMedia();
+
+ $media->name = $this->mediaName;
+ $media->custom_properties = $this->customProperties;
+
+ if (! is_null($this->order)) {
+ $media->order_column = $this->order;
+ }
+
+ $media->save();
+
+ return $temporaryUpload->moveMedia($this->subject, $collectionName, $diskName);
+ }
}
diff --git a/src/MediaCollections/FileAdderFactory.php b/src/MediaCollections/FileAdderFactory.php
index 26241c26e..7d196548d 100644
--- a/src/MediaCollections/FileAdderFactory.php
+++ b/src/MediaCollections/FileAdderFactory.php
@@ -6,6 +6,7 @@
use Illuminate\Support\Collection;
use Spatie\MediaLibrary\MediaCollections\Exceptions\RequestDoesNotHaveFile;
use Spatie\MediaLibrary\Support\RemoteFile;
+use Spatie\MediaLibraryPro\Dto\PendingMediaItem;
class FileAdderFactory
{
@@ -69,4 +70,16 @@ public static function createAllFromRequest(Model $subject): Collection
return static::createMultipleFromRequest($subject, $fileKeys);
}
+
+ public static function createForPendingMedia(Model $subject, PendingMediaItem $pendingMedia): FileAdder
+ {
+ /** @var \Spatie\MediaLibrary\MediaCollections\FileAdder $fileAdder */
+ $fileAdder = app(FileAdder::class);
+
+ return $fileAdder
+ ->setSubject($subject)
+ ->setFile($pendingMedia->temporaryUpload)
+ ->setName($pendingMedia->name)
+ ->setOrder($pendingMedia->order);
+ }
}
diff --git a/src/MediaCollections/HtmlableMedia.php b/src/MediaCollections/HtmlableMedia.php
index c59a526a2..ddfd7eb6e 100644
--- a/src/MediaCollections/HtmlableMedia.php
+++ b/src/MediaCollections/HtmlableMedia.php
@@ -70,13 +70,17 @@ public function toHtml()
$viewName = 'image';
$width = '';
+ $height = '';
if ($this->media->hasResponsiveImages($this->conversionName)) {
$viewName = config('media-library.responsive_images.use_tiny_placeholders')
? 'responsiveImageWithPlaceholder'
: 'responsiveImage';
- $width = $this->media->responsiveImages($this->conversionName)->files->first()->width();
+ $responsiveImage = $this->media->responsiveImages($this->conversionName)->files->first();
+
+ $width = $responsiveImage->width();
+ $height = $responsiveImage->height();
}
$media = $this->media;
@@ -88,6 +92,7 @@ public function toHtml()
'attributeString',
'loadingAttributeValue',
'width',
+ 'height',
))->render();
}
diff --git a/src/MediaCollections/Models/Collections/MediaCollection.php b/src/MediaCollections/Models/Collections/MediaCollection.php
index 9aa9cd168..a549d03f5 100644
--- a/src/MediaCollections/Models/Collections/MediaCollection.php
+++ b/src/MediaCollections/Models/Collections/MediaCollection.php
@@ -2,12 +2,71 @@
namespace Spatie\MediaLibrary\MediaCollections\Models\Collections;
+use Illuminate\Contracts\Support\Htmlable;
use Illuminate\Database\Eloquent\Collection;
+use Spatie\MediaLibrary\MediaCollections\Models\Media;
+use Spatie\MediaLibrary\Support\MediaLibraryPro;
-class MediaCollection extends Collection
+class MediaCollection extends Collection implements Htmlable
{
+ public ?string $collectionName = null;
+
+ public ?string $formFieldName = null;
+
+ public function collectionName(string $collectionName): self
+ {
+ $this->collectionName = $collectionName;
+
+ return $this;
+ }
+
+ public function formFieldName(string $formFieldName): self
+ {
+ $this->formFieldName = $formFieldName;
+
+ return $this;
+ }
+
public function totalSizeInBytes(): int
{
return $this->sum('size');
}
+
+ public function toHtml()
+ {
+ MediaLibraryPro::ensureInstalled();
+
+ return e(json_encode(old($this->formFieldName ?? $this->collectionName) ?? $this->map(function (Media $media) {
+ return [
+ 'name' => $media->name,
+ 'file_name' => $media->file_name,
+ 'uuid' => $media->uuid,
+ 'preview_url' => $media->hasGeneratedConversion('preview') ? $media->getUrl('preview') : '',
+ 'order' => $media->order_column,
+ 'custom_properties' => $media->custom_properties,
+ 'extension' => $media->extension,
+ 'size' => $media->size,
+ ];
+ })->keyBy('uuid')));
+ }
+
+ public function jsonSerialize()
+ {
+ if (!($this->formFieldName ?? $this->collectionName)) {
+ return [];
+ }
+
+ return old($this->formFieldName ?? $this->collectionName) ?? $this->map(function (Media $media) {
+ return [
+ 'name' => $media->name,
+ 'file_name' => $media->file_name,
+ 'uuid' => $media->uuid,
+ 'preview_url' => $media->hasGeneratedConversion('preview') ? $media->getUrl('preview') : '',
+ 'order' => $media->order_column,
+ 'custom_properties' => $media->custom_properties,
+ 'extension' => $media->extension,
+ 'size' => $media->size,
+ ];
+ })->keyBy('uuid');
+ }
}
diff --git a/src/MediaCollections/Models/Media.php b/src/MediaCollections/Models/Media.php
index ede086fdb..8b00dabcc 100644
--- a/src/MediaCollections/Models/Media.php
+++ b/src/MediaCollections/Models/Media.php
@@ -5,7 +5,9 @@
use DateTimeInterface;
use Illuminate\Contracts\Support\Htmlable;
use Illuminate\Contracts\Support\Responsable;
+use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\MorphTo;
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
@@ -21,8 +23,10 @@
use Spatie\MediaLibrary\MediaCollections\Models\Concerns\IsSorted;
use Spatie\MediaLibrary\ResponsiveImages\RegisteredResponsiveImages;
use Spatie\MediaLibrary\Support\File;
+use Spatie\MediaLibrary\Support\MediaLibraryPro;
use Spatie\MediaLibrary\Support\TemporaryDirectory;
use Spatie\MediaLibrary\Support\UrlGenerator\UrlGeneratorFactory;
+use Spatie\MediaLibraryPro\Models\TemporaryUpload;
class Media extends Model implements Responsable, Htmlable
{
@@ -39,6 +43,7 @@ class Media extends Model implements Responsable, Htmlable
protected $casts = [
'manipulations' => 'array',
'custom_properties' => 'array',
+ 'generated_conversions' => 'array',
'responsive_images' => 'array',
];
@@ -182,34 +187,53 @@ public function getMediaConversionNames(): array
return $conversions->map(fn (Conversion $conversion) => $conversion->getName())->toArray();
}
- public function hasGeneratedConversion(string $conversionName): bool
+ public function getGeneratedConversions(): Collection
{
- $generatedConversions = $this->getGeneratedConversions();
+ return collect($this->generated_conversions ?? []);
+ }
- return $generatedConversions[$conversionName] ?? false;
+
+ public function markAsConversionGenerated(string $conversionName): self
+ {
+ $generatedConversions = $this->generated_conversions;
+
+ Arr::set($generatedConversions, $conversionName, true);
+
+ $this->generated_conversions = $generatedConversions;
+
+ $this->save();
+
+ return $this;
}
- public function markAsConversionGenerated(string $conversionName, bool $generated): self
+ public function markAsConversionNotGenerated(string $conversionName): self
{
- $this->setCustomProperty("generated_conversions.{$conversionName}", $generated);
+ $generatedConversions = $this->generated_conversions;
+
+ Arr::set($generatedConversions, $conversionName, false);
+
+ $this->generated_conversions = $generatedConversions;
$this->save();
return $this;
}
- public function getGeneratedConversions(): Collection
+ public function hasGeneratedConversion(string $conversionName): bool
{
- return collect($this->getCustomProperty('generated_conversions', []));
+ $generatedConversions = $this->getGeneratedConversions();
+
+ return $generatedConversions[$conversionName] ?? false;
}
+
public function toResponse($request)
{
$downloadHeaders = [
'Cache-Control' => 'must-revalidate, post-check=0, pre-check=0',
'Content-Type' => $this->mime_type,
'Content-Length' => $this->size,
- 'Content-Disposition' => 'attachment; filename="'.$this->file_name.'"',
+ 'Content-Disposition' => 'attachment; filename="' . $this->file_name . '"',
'Pragma' => 'public',
];
@@ -252,7 +276,7 @@ public function copy(HasMedia $model, $collectionName = 'default', string $diskN
{
$temporaryDirectory = TemporaryDirectory::create();
- $temporaryFile = $temporaryDirectory->path('/').DIRECTORY_SEPARATOR.$this->file_name;
+ $temporaryFile = $temporaryDirectory->path('/') . DIRECTORY_SEPARATOR . $this->file_name;
/** @var \Spatie\MediaLibrary\MediaCollections\Filesystem $filesystem */
$filesystem = app(Filesystem::class);
@@ -262,6 +286,7 @@ public function copy(HasMedia $model, $collectionName = 'default', string $diskN
$newMedia = $model
->addMedia($temporaryFile)
->usingName($this->name)
+ ->setOrder($this->order_column)
->withCustomProperties($this->custom_properties)
->toMediaCollection($collectionName, $diskName);
@@ -299,4 +324,25 @@ public function __invoke(...$arguments): HtmlableMedia
{
return $this->img(...$arguments);
}
+
+ public function temporaryUpload(): BelongsTo
+ {
+ MediaLibraryPro::ensureInstalled();
+
+ return $this->belongsTo(TemporaryUpload::class);
+ }
+
+ public static function findWithTemporaryUploadInCurrentSession(array $uuids)
+ {
+ MediaLibraryPro::ensureInstalled();
+
+ return static::query()
+ ->whereIn('uuid', $uuids)
+ ->whereHasMorph(
+ 'model',
+ [TemporaryUpload::class],
+ fn (Builder $builder) => $builder->where('session_id', session()->getId())
+ )
+ ->get();
+ }
}
diff --git a/src/MediaCollections/Models/Observers/MediaObserver.php b/src/MediaCollections/Models/Observers/MediaObserver.php
index 65881d992..83698e1e9 100644
--- a/src/MediaCollections/Models/Observers/MediaObserver.php
+++ b/src/MediaCollections/Models/Observers/MediaObserver.php
@@ -13,7 +13,9 @@ class MediaObserver
public function creating(Media $media)
{
if ($media->shouldSortWhenCreating()) {
- $media->setHighestOrderNumber();
+ if (is_null($media->order_column)) {
+ $media->setHighestOrderNumber();
+ }
}
}
@@ -35,7 +37,7 @@ public function updated(Media $media)
$original = $media->getOriginal('manipulations');
- if (! $this->isLaravel7orHigher()) {
+ if (!$this->isLaravel7orHigher()) {
$original = json_decode($original, true);
}
@@ -55,7 +57,7 @@ public function updated(Media $media)
public function deleted(Media $media)
{
if (in_array(SoftDeletes::class, class_uses_recursive($media))) {
- if (! $media->isForceDeleting()) {
+ if (!$media->isForceDeleting()) {
return;
}
}
diff --git a/src/ResponsiveImages/ResponsiveImage.php b/src/ResponsiveImages/ResponsiveImage.php
index 7516f5f2a..83c6634e0 100644
--- a/src/ResponsiveImages/ResponsiveImage.php
+++ b/src/ResponsiveImages/ResponsiveImage.php
@@ -91,7 +91,9 @@ protected function getPropertyParts(): array
protected function stringBetween(string $subject, string $startCharacter, string $endCharacter): string
{
- $between = strstr($subject, $startCharacter);
+ $lastPos = strrpos($subject, $startCharacter);
+
+ $between = substr($subject, $lastPos);
$between = str_replace('___', '', $between);
diff --git a/src/ResponsiveImages/ResponsiveImageGenerator.php b/src/ResponsiveImages/ResponsiveImageGenerator.php
index 39e89ccb5..4935da9f2 100644
--- a/src/ResponsiveImages/ResponsiveImageGenerator.php
+++ b/src/ResponsiveImages/ResponsiveImageGenerator.php
@@ -11,6 +11,7 @@
use Spatie\MediaLibrary\ResponsiveImages\TinyPlaceholderGenerator\TinyPlaceholderGenerator;
use Spatie\MediaLibrary\ResponsiveImages\WidthCalculator\WidthCalculator;
use Spatie\MediaLibrary\Support\File;
+use Spatie\MediaLibrary\Support\FileNamer\FileNamer;
use Spatie\MediaLibrary\Support\ImageFactory;
use Spatie\MediaLibrary\Support\TemporaryDirectory;
use Spatie\TemporaryDirectory\TemporaryDirectory as BaseTemporaryDirectory;
@@ -25,6 +26,8 @@ class ResponsiveImageGenerator
protected const DEFAULT_CONVERSION_QUALITY = 90;
+ protected FileNamer $fileNamer;
+
public function __construct(
Filesystem $filesystem,
WidthCalculator $widthCalculator,
@@ -35,6 +38,8 @@ public function __construct(
$this->widthCalculator = $widthCalculator;
$this->tinyPlaceholderGenerator = $tinyPlaceholderGenerator;
+
+ $this->fileNamer = app(config('media-library.file_namer'));
}
public function generateResponsiveImages(Media $media): void
@@ -87,11 +92,8 @@ public function generateResponsiveImage(
BaseTemporaryDirectory $temporaryDirectory,
int $conversionQuality = self::DEFAULT_CONVERSION_QUALITY
): void {
- $responsiveImagePath = $this->appendToFileName(
- $media->file_name,
- "___{$conversionName}_{$targetWidth}",
- $baseImage
- );
+ $extension = $this->fileNamer->extensionFromBaseImage($baseImage);
+ $responsiveImagePath = $this->fileNamer->temporaryFileName($media, $extension);
$tempDestination = $temporaryDirectory->path($responsiveImagePath);
@@ -103,15 +105,22 @@ public function generateResponsiveImage(
$responsiveImageHeight = ImageFactory::load($tempDestination)->getHeight();
- $finalImageFileName = $this->appendToFileName($responsiveImagePath, "_{$responsiveImageHeight}");
+ // Users can customize the name like they want, but we expect the last part in a certain format
+ $fileName = $this->addPropertiesToFileName(
+ $responsiveImagePath,
+ $conversionName,
+ $targetWidth,
+ $responsiveImageHeight,
+ $extension
+ );
- $finalResponsiveImagePath = $temporaryDirectory->path($finalImageFileName);
+ $responsiveImagePath = $temporaryDirectory->path($fileName);
- rename($tempDestination, $finalResponsiveImagePath);
+ rename($tempDestination, $responsiveImagePath);
- $this->filesystem->copyToMediaLibrary($finalResponsiveImagePath, $media, 'responsiveImages');
+ $this->filesystem->copyToMediaLibrary($responsiveImagePath, $media, 'responsiveImages');
- ResponsiveImage::register($media, $finalImageFileName, $conversionName);
+ ResponsiveImage::register($media, $fileName, $conversionName);
}
public function generateTinyJpg(
@@ -177,4 +186,10 @@ protected function cleanResponsiveImages(Media $media, string $conversionName =
return $media;
}
+
+ protected function addPropertiesToFileName(string $fileName, string $conversionName, int $width, int $height, string $extension): string
+ {
+ $fileName = pathinfo($fileName, PATHINFO_FILENAME);
+ return "{$fileName}___{$conversionName}_{$width}_{$height}.{$extension}";
+ }
}
diff --git a/src/Support/Factories/TemporaryUploadFactory.php b/src/Support/Factories/TemporaryUploadFactory.php
new file mode 100644
index 000000000..652f60262
--- /dev/null
+++ b/src/Support/Factories/TemporaryUploadFactory.php
@@ -0,0 +1,7 @@
+getName()}";
+ }
+
+ public function responsiveFileName(string $fileName): string
+ {
+ return pathinfo($fileName, PATHINFO_FILENAME);
+ }
+}
diff --git a/src/Support/FileNamer/FileNamer.php b/src/Support/FileNamer/FileNamer.php
new file mode 100644
index 000000000..25d520488
--- /dev/null
+++ b/src/Support/FileNamer/FileNamer.php
@@ -0,0 +1,23 @@
+responsiveFileName($media->file_name)}.{$extension}";
+ }
+
+ public function extensionFromBaseImage(string $baseImage): string
+ {
+ return pathinfo($baseImage, PATHINFO_EXTENSION);
+ }
+}
diff --git a/src/Support/MediaLibraryPro.php b/src/Support/MediaLibraryPro.php
new file mode 100644
index 000000000..f50da93ff
--- /dev/null
+++ b/src/Support/MediaLibraryPro.php
@@ -0,0 +1,21 @@
+', $media->id)->delete();
- $media->markAsConversionGenerated('test-deprecated', true);
+ $media->markAsConversionGenerated('test-deprecated');
$media->save();
diff --git a/tests/Conversions/ConversionFileNamerTest.php b/tests/Conversions/ConversionFileNamerTest.php
index 91649cb46..6d2d1c27a 100644
--- a/tests/Conversions/ConversionFileNamerTest.php
+++ b/tests/Conversions/ConversionFileNamerTest.php
@@ -3,25 +3,27 @@
namespace Spatie\MediaLibrary\Tests\Conversions;
use Spatie\MediaLibrary\Tests\TestCase;
-use Spatie\MediaLibrary\Tests\TestSupport\testfiles\TestConversionFileNamer;
+use Spatie\MediaLibrary\Tests\TestSupport\TestFileNamer;
class ConversionFileNamerTest extends TestCase
{
+ public string $fileName = "prefix_test_suffix";
+
/** @test */
- public function it_can_use_a_custom_conversion_file_namer()
+ public function it_can_use_a_custom_file_namer()
{
- config()->set('media-library.conversion_file_namer', TestConversionFileNamer::class);
+ config()->set("media-library.file_namer", TestFileNamer::class);
$this
->testModelWithConversion
->addMedia($this->getTestJpg())
->toMediaCollection();
- $path = $this->testModelWithConversion->refresh()->getFirstMediaPath('default', 'thumb');
+ $path = $this->testModelWithConversion->refresh()->getFirstMediaPath("default", "thumb");
- $this->assertStringEndsWith('test---thumb.jpg', $path);
+ $this->assertStringEndsWith("{$this->fileName}---thumb.jpg", $path);
$this->assertFileExists($path);
- $this->assertEquals('/media/1/conversions/test---thumb.jpg', $this->testModelWithConversion->getFirstMediaUrl('default', 'thumb'));
+ $this->assertEquals("/media/1/conversions/{$this->fileName}---thumb.jpg", $this->testModelWithConversion->getFirstMediaUrl("default", "thumb"));
}
}
diff --git a/tests/Conversions/FileManipulatorTest.php b/tests/Conversions/FileManipulatorTest.php
index 098e78ecf..277b5e2d5 100644
--- a/tests/Conversions/FileManipulatorTest.php
+++ b/tests/Conversions/FileManipulatorTest.php
@@ -2,8 +2,8 @@
namespace Spatie\MediaLibrary\Tests\Conversions;
+use Spatie\MediaLibrary\Conversions\Actions\PerformManipulationsAction;
use Spatie\MediaLibrary\Conversions\Conversion;
-use Spatie\MediaLibrary\Conversions\FileManipulator;
use Spatie\MediaLibrary\Tests\TestCase;
class FileManipulatorTest extends TestCase
@@ -25,7 +25,7 @@ public function it_does_not_perform_manipulations_if_not_necessary()
$imageFile = $this->getTestJpg();
$media = $this->testModelWithoutMediaConversions->addMedia($this->getTestJpg())->toMediaCollection();
- $conversionTempFile = (new FileManipulator)->performManipulations(
+ $conversionTempFile = (new PerformManipulationsAction())->execute(
$media,
$this->conversion->withoutManipulations(),
$imageFile
diff --git a/tests/Feature/FileAdder/IntegrationTest.php b/tests/Feature/FileAdder/IntegrationTest.php
index 987158ca4..b5ca9e2b4 100644
--- a/tests/Feature/FileAdder/IntegrationTest.php
+++ b/tests/Feature/FileAdder/IntegrationTest.php
@@ -174,6 +174,8 @@ public function it_can_add_an_upload_to_the_media_library_from_the_current_reque
filesize($this->getTestFilesDirectory('test.jpg'))
);
+ $this->withoutExceptionHandling();
+
$result = $this->call('get', 'upload', [], [], ['file' => $fileUpload]);
$this->assertEquals(200, $result->getStatusCode());
diff --git a/tests/Feature/Media/ToHtmlTest.php b/tests/Feature/Media/ToHtmlTest.php
index aa869505d..17501aa94 100644
--- a/tests/Feature/Media/ToHtmlTest.php
+++ b/tests/Feature/Media/ToHtmlTest.php
@@ -111,7 +111,7 @@ public function it_will_not_rendering_extra_javascript_or_including_base64_svg_w
$imgTag = $media->refresh()->img();
- $this->assertEquals('
', $imgTag);
+ $this->assertEquals('', $imgTag);
}
/** @test */
diff --git a/tests/Feature/S3Integration/S3IntegrationTest.php b/tests/Feature/S3Integration/S3IntegrationTest.php
index 9f347de37..55e188707 100644
--- a/tests/Feature/S3Integration/S3IntegrationTest.php
+++ b/tests/Feature/S3Integration/S3IntegrationTest.php
@@ -40,13 +40,17 @@ public function tearDown(): void
/** @test */
public function it_can_add_media_from_a_disk_to_s3()
{
- Storage::disk('s3_disk')->put('tmp/test.jpg', file_get_contents($this->getTestJpg()));
+ $randomNumber = rand();
+
+ $fileName = "test{$randomNumber}.jpg";
+
+ Storage::disk('s3_disk')->put("tmp/{$fileName}", file_get_contents($this->getTestJpg()));
$media = $this->testModel
- ->addMediaFromDisk('tmp/test.jpg', 's3_disk')
+ ->addMediaFromDisk("tmp/{$fileName}", 's3_disk')
->toMediaCollection('default', 's3_disk');
- $this->assertS3FileExists("{$this->s3BaseDirectory}/{$media->id}/test.jpg");
+ $this->assertS3FileExists("{$this->s3BaseDirectory}/{$media->id}/{$fileName}");
}
/** @test */
diff --git a/tests/ResponsiveImages/ResponsiveImageFileNamerTest.php b/tests/ResponsiveImages/ResponsiveImageFileNamerTest.php
new file mode 100644
index 000000000..f118b1b17
--- /dev/null
+++ b/tests/ResponsiveImages/ResponsiveImageFileNamerTest.php
@@ -0,0 +1,18 @@
+set("media-library.file_namer", TestFileNamer::class);
+
+ $this->fileName = "prefix_test_suffix";
+ $this->fileNameWithUnderscore = "prefix_test__suffix";
+ }
+}
diff --git a/tests/ResponsiveImages/ResponsiveImageGeneratorFileNamerTest.php b/tests/ResponsiveImages/ResponsiveImageGeneratorFileNamerTest.php
new file mode 100644
index 000000000..d89dce928
--- /dev/null
+++ b/tests/ResponsiveImages/ResponsiveImageGeneratorFileNamerTest.php
@@ -0,0 +1,17 @@
+set("media-library.file_namer", TestFileNamer::class);
+
+ $this->fileName = "prefix_test_suffix";
+ }
+}
diff --git a/tests/ResponsiveImages/ResponsiveImageGeneratorTest.php b/tests/ResponsiveImages/ResponsiveImageGeneratorTest.php
index 71820aeeb..9505ef1f7 100644
--- a/tests/ResponsiveImages/ResponsiveImageGeneratorTest.php
+++ b/tests/ResponsiveImages/ResponsiveImageGeneratorTest.php
@@ -8,6 +8,8 @@
class ResponsiveImageGeneratorTest extends TestCase
{
+ public string $fileName = "test";
+
/** @test */
public function it_can_generate_responsive_images()
{
@@ -16,9 +18,9 @@ public function it_can_generate_responsive_images()
->withResponsiveImages()
->toMediaCollection();
- $this->assertFileExists($this->getTempDirectory('media/1/responsive-images/test___media_library_original_237_195.jpg'));
- $this->assertFileExists($this->getTempDirectory('media/1/responsive-images/test___media_library_original_284_233.jpg'));
- $this->assertFileExists($this->getTempDirectory('media/1/responsive-images/test___media_library_original_340_280.jpg'));
+ $this->assertFileExists($this->getTempDirectory("media/1/responsive-images/{$this->fileName}___media_library_original_237_195.jpg"));
+ $this->assertFileExists($this->getTempDirectory("media/1/responsive-images/{$this->fileName}___media_library_original_284_233.jpg"));
+ $this->assertFileExists($this->getTempDirectory("media/1/responsive-images/{$this->fileName}___media_library_original_340_280.jpg"));
}
/** @test */
@@ -29,11 +31,11 @@ public function it_will_generate_responsive_images_if_withResponsiveImagesIf_ret
->withResponsiveImagesIf(fn () => true)
->toMediaCollection();
- $this->assertFileExists($this->getTempDirectory('media/1/responsive-images/test___media_library_original_237_195.jpg'));
- $this->assertFileExists($this->getTempDirectory('media/1/responsive-images/test___media_library_original_284_233.jpg'));
- $this->assertFileExists($this->getTempDirectory('media/1/responsive-images/test___media_library_original_340_280.jpg'));
+ $this->assertFileExists($this->getTempDirectory("media/1/responsive-images/{$this->fileName}___media_library_original_237_195.jpg"));
+ $this->assertFileExists($this->getTempDirectory("media/1/responsive-images/{$this->fileName}___media_library_original_284_233.jpg"));
+ $this->assertFileExists($this->getTempDirectory("media/1/responsive-images/{$this->fileName}___media_library_original_340_280.jpg"));
}
-
+
/** @test */
public function it_will_not_generate_responsive_images_if_withResponsiveImagesIf_returns_false()
{
@@ -42,7 +44,7 @@ public function it_will_not_generate_responsive_images_if_withResponsiveImagesIf
->withResponsiveImagesIf(fn () => false)
->toMediaCollection();
- $this->assertFileDoesNotExist($this->getTempDirectory('media/1/responsive-images/test___media_library_original_237_195.jpg'));
+ $this->assertFileDoesNotExist($this->getTempDirectory("media/1/responsive-images/{$this->fileName}___media_library_original_237_195.jpg"));
}
/** @test */
@@ -53,7 +55,7 @@ public function its_conversions_can_have_responsive_images()
->withResponsiveImages()
->toMediaCollection();
- $this->assertFileExists($this->getTempDirectory('media/1/responsive-images/test___thumb_50_41.jpg'));
+ $this->assertFileExists($this->getTempDirectory("media/1/responsive-images/{$this->fileName}___thumb_50_41.jpg"));
}
/** @test */
@@ -64,7 +66,7 @@ public function its_conversions_can_have_responsive_images_and_change_format()
->withResponsiveImages()
->toMediaCollection();
- $this->assertFileExists($this->getTempDirectory('media/1/responsive-images/test___pngtojpg_700_883.jpg'));
+ $this->assertFileExists($this->getTempDirectory("media/1/responsive-images/{$this->fileName}___pngtojpg_700_883.jpg"));
}
/** @test */
@@ -84,32 +86,32 @@ public function it_triggers_an_event_when_the_responsive_images_are_generated()
public function it_cleans_the_responsive_images_urls_from_the_db_before_regeneration()
{
$media = $this->testModelWithResponsiveImages
- ->addMedia($this->getTestFilesDirectory('test.jpg'))
+ ->addMedia($this->getTestFilesDirectory("test.jpg"))
->withResponsiveImages()
->toMediaCollection();
- $this->assertCount(1, $media->fresh()->responsive_images['thumb']['urls']);
+ $this->assertCount(1, $media->fresh()->responsive_images["thumb"]["urls"]);
- $this->artisan('media-library:regenerate');
- $this->assertCount(1, $media->fresh()->responsive_images['thumb']['urls']);
+ $this->artisan("media-library:regenerate");
+ $this->assertCount(1, $media->fresh()->responsive_images["thumb"]["urls"]);
}
/** @test */
public function it_will_add_responsive_image_entries_when_there_were_none_when_regenerating()
{
$media = $this->testModelWithResponsiveImages
- ->addMedia($this->getTestFilesDirectory('test.jpg'))
+ ->addMedia($this->getTestFilesDirectory("test.jpg"))
->withResponsiveImages()
->toMediaCollection();
// remove all responsive image db entries
$responsiveImages = $media->responsive_images;
- $responsiveImages['thumb']['urls'] = [];
+ $responsiveImages["thumb"]["urls"] = [];
$media->responsive_images = $responsiveImages;
$media->save();
- $this->assertCount(0, $media->fresh()->responsive_images['thumb']['urls']);
+ $this->assertCount(0, $media->fresh()->responsive_images["thumb"]["urls"]);
- $this->artisan('media-library:regenerate');
- $this->assertCount(1, $media->fresh()->responsive_images['thumb']['urls']);
+ $this->artisan("media-library:regenerate");
+ $this->assertCount(1, $media->fresh()->responsive_images["thumb"]["urls"]);
}
}
diff --git a/tests/ResponsiveImages/ResponsiveImageTest.php b/tests/ResponsiveImages/ResponsiveImageTest.php
index 9a0a11d46..8f9628945 100644
--- a/tests/ResponsiveImages/ResponsiveImageTest.php
+++ b/tests/ResponsiveImages/ResponsiveImageTest.php
@@ -6,6 +6,9 @@
class ResponsiveImageTest extends TestCase
{
+ public string $fileName = 'test';
+ public string $fileNameWithUnderscore = 'test_';
+
/** @test */
public function a_media_instance_can_get_responsive_image_urls()
{
@@ -18,16 +21,16 @@ public function a_media_instance_can_get_responsive_image_urls()
$media = $this->testModelWithResponsiveImages->getFirstMedia();
$this->assertEquals([
- 'http://localhost/media/1/responsive-images/test___media_library_original_340_280.jpg',
- 'http://localhost/media/1/responsive-images/test___media_library_original_284_233.jpg',
- 'http://localhost/media/1/responsive-images/test___media_library_original_237_195.jpg',
+ "http://localhost/media/1/responsive-images/{$this->fileName}___media_library_original_340_280.jpg",
+ "http://localhost/media/1/responsive-images/{$this->fileName}___media_library_original_284_233.jpg",
+ "http://localhost/media/1/responsive-images/{$this->fileName}___media_library_original_237_195.jpg",
], $media->getResponsiveImageUrls());
$this->assertEquals([
- 'http://localhost/media/1/responsive-images/test___thumb_50_41.jpg',
- ], $media->getResponsiveImageUrls('thumb'));
+ "http://localhost/media/1/responsive-images/{$this->fileName}___thumb_50_41.jpg",
+ ], $media->getResponsiveImageUrls("thumb"));
- $this->assertEquals([], $media->getResponsiveImageUrls('non-existing-conversion'));
+ $this->assertEquals([], $media->getResponsiveImageUrls("non-existing-conversion"));
}
/** @test */
@@ -41,16 +44,16 @@ public function a_media_instance_can_generate_the_contents_of_scrset()
$media = $this->testModelWithResponsiveImages->getFirstMedia();
$this->assertStringContainsString(
- 'http://localhost/media/1/responsive-images/test___media_library_original_340_280.jpg 340w, http://localhost/media/1/responsive-images/test___media_library_original_284_233.jpg 284w, http://localhost/media/1/responsive-images/test___media_library_original_237_195.jpg 237w',
+ "http://localhost/media/1/responsive-images/{$this->fileName}___media_library_original_340_280.jpg 340w, http://localhost/media/1/responsive-images/{$this->fileName}___media_library_original_284_233.jpg 284w, http://localhost/media/1/responsive-images/{$this->fileName}___media_library_original_237_195.jpg 237w",
$media->getSrcset()
);
- $this->assertStringContainsString('data:image/svg+xml;base64', $media->getSrcset());
+ $this->assertStringContainsString("data:image/svg+xml;base64", $media->getSrcset());
$this->assertStringContainsString(
- 'http://localhost/media/1/responsive-images/test___thumb_50_41.jpg 50w',
- $media->getSrcset('thumb')
+ "http://localhost/media/1/responsive-images/{$this->fileName}___thumb_50_41.jpg 50w",
+ $media->getSrcset("thumb")
);
- $this->assertStringContainsString('data:image/svg+xml;base64,', $media->getSrcset('thumb'));
+ $this->assertStringContainsString("data:image/svg+xml;base64,", $media->getSrcset("thumb"));
}
/** @test */
@@ -65,7 +68,7 @@ public function a_responsive_image_can_return_some_properties()
$responsiveImage = $media->responsiveImages()->files->first();
- $this->assertEquals('media_library_original', $responsiveImage->generatedFor());
+ $this->assertEquals("media_library_original", $responsiveImage->generatedFor());
$this->assertEquals(340, $responsiveImage->width());
@@ -78,10 +81,10 @@ public function responsive_image_generation_respects_the_conversion_quality_sett
$this->testModelWithResponsiveImages
->addMedia($this->getTestJpg())
->preservingOriginal()
- ->toMediaCollection('default');
+ ->toMediaCollection("default");
- $standardQualityResponsiveConversion = $this->getTempDirectory('media/1/responsive-images/test___standardQuality_340_280.jpg');
- $lowerQualityResponsiveConversion = $this->getTempDirectory('media/1/responsive-images/test___lowerQuality_340_280.jpg');
+ $standardQualityResponsiveConversion = $this->getTempDirectory("media/1/responsive-images/{$this->fileName}___standardQuality_340_280.jpg");
+ $lowerQualityResponsiveConversion = $this->getTempDirectory("media/1/responsive-images/{$this->fileName}___lowerQuality_340_280.jpg");
$this->assertLessThan(filesize($standardQualityResponsiveConversion), filesize($lowerQualityResponsiveConversion));
}
@@ -92,13 +95,37 @@ public function a_media_instance_can_get_responsive_image_urls_with_conversions_
$this->testModelWithResponsiveImages
->addMedia($this->getTestJpg())
->withResponsiveImages()
- ->storingConversionsOnDisk('secondMediaDisk')
+ ->storingConversionsOnDisk("secondMediaDisk")
->toMediaCollection();
$media = $this->testModelWithResponsiveImages->getFirstMedia();
$this->assertEquals([
- 'http://localhost/media2/1/responsive-images/test___thumb_50_41.jpg',
- ], $media->getResponsiveImageUrls('thumb'));
+ "http://localhost/media2/1/responsive-images/{$this->fileName}___thumb_50_41.jpg",
+ ], $media->getResponsiveImageUrls("thumb"));
+ }
+
+ /** @test */
+ public function it_can_handle_file_names_with_underscore()
+ {
+ $this
+ ->testModelWithResponsiveImages
+ ->addMedia($this->getTestImageEndingWithUnderscore())
+ ->withResponsiveImages()
+ ->toMediaCollection();
+
+ $media = $this->testModelWithResponsiveImages->getFirstMedia();
+
+ $this->assertSame([
+ "http://localhost/media/1/responsive-images/{$this->fileNameWithUnderscore}___media_library_original_340_280.jpg",
+ "http://localhost/media/1/responsive-images/{$this->fileNameWithUnderscore}___media_library_original_284_233.jpg",
+ "http://localhost/media/1/responsive-images/{$this->fileNameWithUnderscore}___media_library_original_237_195.jpg",
+ ], $media->getResponsiveImageUrls());
+
+ $this->assertSame([
+ "http://localhost/media/1/responsive-images/{$this->fileNameWithUnderscore}___thumb_50_41.jpg",
+ ], $media->getResponsiveImageUrls("thumb"));
+
+ $this->assertSame([], $media->getResponsiveImageUrls("non-existing-conversion"));
}
}
diff --git a/tests/TestCase.php b/tests/TestCase.php
index fb809b3cd..80132a5ab 100644
--- a/tests/TestCase.php
+++ b/tests/TestCase.php
@@ -3,12 +3,14 @@
namespace Spatie\MediaLibrary\Tests;
use CreateMediaTable;
+use CreateTemporaryUploadsTable;
use Dotenv\Dotenv;
use File;
use Illuminate\Database\Eloquent\Relations\Relation;
use Illuminate\Database\Schema\Blueprint;
use Orchestra\Testbench\TestCase as Orchestra;
use Spatie\MediaLibrary\MediaLibraryServiceProvider;
+use Spatie\MediaLibrary\Support\MediaLibraryPro;
use Spatie\MediaLibrary\Tests\TestSupport\TestModels\TestModel;
use Spatie\MediaLibrary\Tests\TestSupport\TestModels\TestModelWithConversion;
use Spatie\MediaLibrary\Tests\TestSupport\TestModels\TestModelWithConversionQueued;
@@ -74,9 +76,11 @@ protected function loadEnvironmentVariables()
*/
protected function getPackageProviders($app)
{
- return [
- MediaLibraryServiceProvider::class,
+ $serviceProviders = [
+ MedialibraryServiceProvider::class,
];
+
+ return $serviceProviders;
}
/**
@@ -129,7 +133,14 @@ protected function setUpDatabase($app)
TestModel::create(['name' => 'test']);
- include_once __DIR__.'/../database/migrations/create_media_table.php.stub';
+
+ if (MediaLibraryPro::isInstalled()) {
+ include_once __DIR__ . '/../vendor/spatie/laravel-medialibrary-pro/database/migrations/create_temporary_uploads_table.stub';
+ (new CreateTemporaryUploadsTable())->up();
+ }
+
+ include_once(__DIR__ . '/../database/migrations/create_media_table.php.stub');
+
(new CreateMediaTable())->up();
}
@@ -216,6 +227,11 @@ public function getTestImageWithoutExtension(): string
return $this->getTestFilesDirectory('image');
}
+ public function getTestImageEndingWithUnderscore(): string
+ {
+ return $this->getTestFilesDirectory('test_.jpg');
+ }
+
public function getAntaresThumbJpgWithAccent(): string
{
return $this->getTestFilesDirectory('antarèsthumb.jpg');
diff --git a/tests/TestSupport/TestFileNamer.php b/tests/TestSupport/TestFileNamer.php
new file mode 100644
index 000000000..45e91b2be
--- /dev/null
+++ b/tests/TestSupport/TestFileNamer.php
@@ -0,0 +1,23 @@
+getName()}";
+ }
+}
diff --git a/tests/TestSupport/testfiles/TestConversionFileNamer.php b/tests/TestSupport/testfiles/TestConversionFileNamer.php
deleted file mode 100644
index c22190f67..000000000
--- a/tests/TestSupport/testfiles/TestConversionFileNamer.php
+++ /dev/null
@@ -1,17 +0,0 @@
-file_name, PATHINFO_FILENAME);
-
- return "{$fileName}---{$conversion->getName()}";
- }
-}
diff --git a/tests/TestSupport/testfiles/test_.jpg b/tests/TestSupport/testfiles/test_.jpg
new file mode 100644
index 000000000..ba70fe087
Binary files /dev/null and b/tests/TestSupport/testfiles/test_.jpg differ