Skip to content

[6.x] Add Asset::moveUnique() method #14236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lwekuiper wants to merge 2 commits into
base: 6.x
Choose a base branch
from
+82 −1
Open

[6.x] Add Asset::moveUnique() method #14236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2a9f30
feat(assets): add unique filename support to Asset::move()
lwekuiper Mar 12, 2026
3d7c602
refactor(assets): use moveUnique() method instead of $unique paramete…
lwekuiper Mar 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion src/Assets/Asset.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -744,7 +744,9 @@ public function containerHandle()
*/
public function rename($filename, $unique = false)
{
$filename = $unique ? $this->ensureUniqueFilename($this->folder(), $filename) : $filename;
if ($unique) {
return $this->moveUnique($this->folder(), $filename);
}

return $this->move($this->folder(), $filename);
}
Expand Down Expand Up @@ -777,6 +779,21 @@ public function move($folder, $filename = null)
return $this;
}

/**
* Move the asset to a different location with a unique filename.
*
* @param string $folder The folder relative to the container.
* @param string|null $filename The new filename, if renaming.
* @return $this
*/
public function moveUnique($folder, $filename = null)
{
$filename = Uploader::getSafeFilename($filename ?: $this->filename());
$filename = $this->ensureUniqueFilename($folder, $filename);

return $this->move($folder, $filename);
}

public function moveQuietly($folder, $filename = null)
{
$this->withEvents = false;
Expand Down
64 changes: 64 additions & 0 deletions tests/Assets/AssetTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1260,6 +1260,70 @@ public function it_doesnt_lowercase_moved_files_when_configured()
], $container->assets('/', true)->map->path()->all());
}

#[Test]
public function it_can_be_moved_uniquely_to_another_folder_when_conflict_exists()
{
Storage::fake('local');
$disk = Storage::disk('local');
$disk->put('old/asset.txt', 'The asset contents');
$disk->put('new/asset.txt', 'Existing asset');
$disk->put('new/asset-1.txt', 'Another existing asset');
$container = Facades\AssetContainer::make('test')->disk('local');
Facades\AssetContainer::shouldReceive('save')->with($container);
Facades\AssetContainer::shouldReceive('findByHandle')->with('test')->andReturn($container);
$asset = $container->makeAsset('old/asset.txt')->data(['foo' => 'bar']);
$asset->save();

$return = $asset->moveUnique('new');

$this->assertEquals($asset, $return);
$disk->assertMissing('old/asset.txt');
$disk->assertExists('new/asset-2.txt');
$this->assertEquals('new/asset-2.txt', $asset->path());
}

#[Test]
public function it_can_be_moved_uniquely_to_another_folder_without_renaming_when_no_conflict()
{
Storage::fake('local');
$disk = Storage::disk('local');
$disk->put('old/asset.txt', 'The asset contents');
$container = Facades\AssetContainer::make('test')->disk('local');
Facades\AssetContainer::shouldReceive('save')->with($container);
Facades\AssetContainer::shouldReceive('findByHandle')->with('test')->andReturn($container);
$asset = $container->makeAsset('old/asset.txt')->data(['foo' => 'bar']);
$asset->save();

$return = $asset->moveUnique('new');

$this->assertEquals($asset, $return);
$disk->assertMissing('old/asset.txt');
$disk->assertExists('new/asset.txt');
$this->assertEquals('new/asset.txt', $asset->path());
}

#[Test]
public function it_does_not_ensure_unique_filename_when_moving_by_default()
{
Storage::fake('local');
$disk = Storage::disk('local');
$disk->put('old/asset.txt', 'The asset contents');
$disk->put('new/asset.txt', 'Existing asset');
$container = Facades\AssetContainer::make('test')->disk('local');
Facades\AssetContainer::shouldReceive('save')->with($container);
Facades\AssetContainer::shouldReceive('findByHandle')->with('test')->andReturn($container);
$asset = $container->makeAsset('old/asset.txt')->data(['foo' => 'bar']);
$asset->save();

$return = $asset->move('new');

$this->assertEquals($asset, $return);
$disk->assertMissing('old/asset.txt');
// Without unique flag, it overwrites the existing file
$disk->assertExists('new/asset.txt');
$this->assertEquals('new/asset.txt', $asset->path());
}

#[Test]
public function it_renames()
{
Expand Down
Loading