How to rename a file properly?

[Valery]

Hey guys,

I was doing some file renaming and stumbled upon the following problem:

rename() renames only the physical file itself but in the Admin backend it still shows up under its old name.

Can anyone point out for me what I am doing wrong, please?

[netcarver]

I once tried to do it at the registry office but the man behind the counter looked at me blankly. Apparently they only handle births, marriages and deaths, not renames using the PW API.

[Soma]

You can't just rename them physically and then think PW magically still knows which file it is. This is because PW saves the name of the file to the db. It's like the key!

So you'd also have to rename it in the DB table field_yourfieldname also and you'll see.

[kongondo]

People please, be nice            

[netcarver]

I was being nice - the man behind the counter even said he thought I was very nice as he dialed the police.

[kongondo]

I was being nice - the man behind the counter even said he thought I was very nice as he dialed the police.

Lol x3! Steve please! Hehe. You've made my evening mate

cheers

/k

[Valery]

Thanks, Soma. A bit of SQL always helps.

[Soma]

Or a bit of API vodoo.

$old_name = 'lizard.jpg';
$new_name = 'wizard';

$p = $pages->find("image.data=$old_name")->first;
$p->of(false); // outputformatting off, single and multiple image fields are from now on wire array's

$path           = $p->image->path;
$page_image     = $p->image->first();
$ext            = $page_image->ext;
$orig_image     = $page_image->filename
$new_image      = $path . $new_name . "." . $ext;

echo "orig: " . $orig_image . "<br/>";
echo "path: " . $path . "<br/>";
echo "ext: " . $ext . "<br/>";
echo "new: " . $new_image . "<br/>";

// copy and rename
copy($orig_image, $new_image);

// remove old, add new image to page
$p->image->remove($page_image); // orig, will get deleted
$p->image->add($new_image); // new
$p->save(); 

Or in a shorter code: https://gist.github.com/somatonic/6282944

[horst]

I think it also could be a bit shorter because of the $image->rename() method:
 

$old_name = 'lizard.jpg';
$new_name = 'wizard';

$p = $pages->find("image.data=$old_name")->first;
$p->of(false); // outputformatting off, single and multiple image fields are from now on wire array's

// get the image and the extension
$page_image     = $p->image->first();
$ext            = $page_image->ext;

// pathes and old file basename aren't needed because we cannot leave the pages assets directory!
$newFilename    = $new_name .'.'. $ext;

// only rename, copy and remove isn't needed
$page_image->rename($newFilename);
$p->save();

 
only written in browser, not tested, but should work, i think.
 
EDIT:
 
Have now tested and I'm afraid too: - it doesn't work!

Edited August 20, 2013 by horst

[Soma]

Ahhh Mr. ImageHorstManipulation

No it doesn't work I'm afraid to say. Also the image variations doesn't get deleted and the image will not be changed in DB.

[horst]

Ahhh Mr. ImageHorstManipulation

No it doesn't work I'm afraid to say. Also the image variations doesn't get deleted and the image will not be changed in DB.

Oh no, - so - for what is the ->rename() method useful ?

[Soma]

I looked closer and it doesn't work as simple, you have to call trackChange on image field for basename and remove variations too.

So this will work:

$old_name = 'wizard.jpg';
$new_name = 'lizard';

$p = $pages->get("image.data=$old_name");
$p->of(false); // outputformatting off, single and multiple image fields are from now on wire array's

// get the image and the extension
$image          = $p->image->find("name=$old_name")->first();
$ext            = $image->ext;

$newFilename    = $new_name . "." . $ext;

$p->image->trackChange("basename");
$image->removeVariations();
$image->rename($newFilename);

$p->save("image");

[horst]

@soma:

[Martijn Geerts]

Is there a reason for:

$image = $p->image->find("name=$old_name")->first();

instead of: 

$image = $p->image->get($old_name);

?

[Soma]

Is there a reason for:

$image = $p->image->find("name=$old_name")->first();

instead of: 

$image = $p->image->get($old_name);

?

Yeah I like it better.

[Valery]

Thanks, Soma!

Now how would one go about renaming a file? Calling get("file_field.data=...) did not seem to work for me.

[Soma]

Thanks, Soma!

Now how would one go about renaming a file? Calling get("file_field.data=...) did not seem to work for me.

It's the same, as image field is just extending file fieldtype.

[Valery]

Soma,

I tried

$image->removeVariations(); 

but it did not work for me with a file field.

Overall I like the remove/add approach better.

[Soma]

There's no variations for files (non images) or is it? I don't think you can resize pdf's. 

[Valery]

Soma,

My bad. I must admit I rather blindly copied your code which was not a good thing.

I removed the removeVariations() line and the trick with trackChanges() worked.

Thanks! It's a lot more elegant way to rename files than the "add/delete" way.

Have a very nice day

[Pete]

For anyone who comes across this topic, I'd done a Wordpress import and was storing the original filename in an extra field in my photos field, so my code to rename after I botched the names up the first time was:

foreach ($page->photos as $photo) {
    $photo->rename($photo->wordpress_filename);
}
$page->save('photos');

I suspect that you can do this too if you have a separate array of old and new names - not tested but it is the same idea as above done a different way by getting the file by current name first, then renaming it:

foreach ($renameArr as $old => $new) {
	$page->photos->getFile($old)->rename($new);
}
$page->save('photos');

The act of simply saving the relevant field after the renaming updates the database nicely whereas looking at the previous comments this wasn't always the case.