Skip to content

Commit a37a177

Browse files
authored
feat(Storage): add samples for MoveObject (#2078)
1 parent 6962dba commit a37a177

File tree

2 files changed

+93
-0
lines changed

2 files changed

+93
-0
lines changed

storage/src/move_object_atomic.php

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<?php
2+
/**
3+
* Copyright 2025 Google Inc.
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
/**
19+
* For instructions on how to run the full sample:
20+
*
21+
* @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/storage/README.md
22+
*/
23+
24+
namespace Google\Cloud\Samples\Storage;
25+
26+
# [START storage_move_object]
27+
use Google\Cloud\Storage\StorageClient;
28+
29+
/**
30+
* Move an object to a new name within HNS-enabled bucket.
31+
*
32+
* @param string $bucketName The name of your Cloud Storage bucket.
33+
* (e.g. 'my-bucket')
34+
* @param string $objectName The name of your Cloud Storage object.
35+
* (e.g. 'my-object')
36+
* @param string $newObjectName the destination object name.
37+
* (e.g. 'my-other-object')
38+
*/
39+
function move_object_atomic(string $bucketName, string $objectName, string $newObjectName): void
40+
{
41+
$storage = new StorageClient();
42+
$bucket = $storage->bucket($bucketName);
43+
$object = $bucket->object($objectName);
44+
$object->move($newObjectName);
45+
printf('Moved gs://%s/%s to gs://%s/%s' . PHP_EOL,
46+
$bucketName,
47+
$objectName,
48+
$bucketName,
49+
$newObjectName);
50+
}
51+
# [END storage_move_object]
52+
53+
// The following 2 lines are only needed to run the samples
54+
require_once __DIR__ . '/../../testing/sample_helpers.php';
55+
\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

storage/test/ObjectsTest.php

+38
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,44 @@ public function testManageObject()
151151
$this->assertEquals($output, $outputString);
152152
}
153153

154+
public function testMoveObjectAtomic()
155+
{
156+
$bucketName = self::$bucketName . '-hns';
157+
$objectName = 'test-object-' . time();
158+
$newObjectName = $objectName . '-moved';
159+
$bucket = self::$storage->createBucket($bucketName, [
160+
'hierarchicalNamespace' => ['enabled' => true],
161+
'iamConfiguration' => ['uniformBucketLevelAccess' => ['enabled' => true]]
162+
]);
163+
164+
$object = $bucket->upload('test', ['name' => $objectName]);
165+
$this->assertTrue($object->exists());
166+
167+
$output = self::runFunctionSnippet('move_object_atomic', [
168+
$bucketName,
169+
$objectName,
170+
$newObjectName
171+
]);
172+
173+
$this->assertEquals(
174+
sprintf(
175+
'Moved gs://%s/%s to gs://%s/%s' . PHP_EOL,
176+
$bucketName,
177+
$objectName,
178+
$bucketName,
179+
$newObjectName
180+
),
181+
$output
182+
);
183+
184+
$this->assertFalse($object->exists());
185+
$movedObject = $bucket->object($newObjectName);
186+
$this->assertTrue($movedObject->exists());
187+
188+
$bucket->object($newObjectName)->delete();
189+
$bucket->delete();
190+
}
191+
154192
public function testCompose()
155193
{
156194
$bucket = self::$storage->bucket(self::$bucketName);

0 commit comments

Comments
 (0)