MongoDB\GridFS\Bucket::rename()

On this page

Definition
Errors/Exceptions
Examples

Definition

MongoDB\GridFS\Bucket::rename

Selects a GridFS file by its _id and alters its filename.

function rename($id, string $newFilename): void

This method has the following parameters:

Parameter	Type	Description
`$id`	mixed	The `_id` of the file.
`$newFilename`	string	The new `filename` value.

Errors/Exceptions

MongoDB\GridFS\Exception\FileNotFoundException if no file was found for the selection criteria.

MongoDB\Driver\Exception\RuntimeException for other errors at the driver level (e.g. connection errors).

Examples

copy

<?php

$bucket = (new MongoDB\Client)->test->selectGridFSBucket();

$stream = fopen('php://temp', 'w+b');
fwrite($stream, "foobar");
rewind($stream);

$id = $bucket->uploadFromStream('a', $stream);

$bucket->rename($id, 'b');

var_dump(stream_get_contents($bucket->openDownloadStreamByName('b')));

The output would then resemble:

copy

string(6) "foobar"

← MongoDB\GridFS\Bucket::openUploadStream() MongoDB\GridFS\Bucket::uploadFromStream() →