Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
66 changes: 66 additions & 0 deletions storage/src/delete_object_contexts.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<?php
/**
* Copyright 2026 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

/**
* For instructions on how to run the full sample:
*
* @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/storage/README.md
*/

namespace Google\Cloud\Samples\Storage;

# [START storage_delete_object_contexts]
use Google\Cloud\Storage\StorageClient;

/**
* Delete all custom contexts from an existing object.
*
* @param string $bucketName The name of your Cloud Storage bucket.
* (e.g. 'my-bucket')
* @param string $objectName The name of your Cloud Storage object.
* (e.g. 'my-object')
*/
function delete_object_contexts(string $bucketName, string $objectName): void
{
$storage = new StorageClient();
$bucket = $storage->bucket($bucketName);
$object = $bucket->object($objectName);

// Fetch the current metageneration so the update can be made conditional.
$info = $object->info();

// To delete all contexts, set the 'custom' key to null, which is sent as a
// JSON null and clears every context. Do not use an empty PHP array: it
// serializes as a JSON list ([]) rather than an empty map.
// Optional: set a metageneration-match precondition to avoid potential
// race conditions and data corruptions. The request to update is aborted
// if the object's metageneration does not match your precondition.
$object->update([
'contexts' => [
'custom' => null,
],
], [
'ifMetagenerationMatch' => $info['metageneration'],

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To prevent potential PHP warnings or errors (such as Undefined array key "metageneration" in PHP 8) if the object metadata is incomplete or if the API response is unexpected, it is safer to use the null coalescing operator to provide a fallback value.

        'ifMetagenerationMatch' => $info['metageneration'] ?? null,

]);

printf('Deleted object contexts for object %s in bucket %s.' . PHP_EOL, $objectName, $bucketName);
}
# [END storage_delete_object_contexts]

// The following 2 lines are only needed to run the samples
require_once __DIR__ . '/../../testing/sample_helpers.php';
\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
13 changes: 8 additions & 5 deletions storage/test/ObjectsTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -77,12 +77,15 @@ public function testObjectContexts()
]);
$this->assertStringContainsString("Found object: $objectInfo", $listOutput);

// Clear all contexts on the object.
$object->update([
'contexts' => [
'custom' => null,
],
// Delete all contexts on the object.
$deleteOutput = $this->runFunctionSnippet('delete_object_contexts', [
$bucketName,
$objectInfo,
]);
$this->assertStringContainsString(
"Deleted object contexts for object $objectInfo in bucket $bucketName.",
$deleteOutput
);
$object->reload();

$clearedGetOutput = $this->runFunctionSnippet('get_object_contexts', [
Expand Down
Loading