chore: add typehints for storage samples (GoogleCloudPlatform#1703)

Author: yash30201

storage/src/activate_hmac_key.php

@@ -32,7 +32,7 @@
  * @param string $projectId The ID of your Google Cloud Platform project.
  * @param string $accessId Access ID for an inactive HMAC key.
  */
-function activate_hmac_key($projectId, $accessId)
+function activate_hmac_key(string $projectId, string $accessId): void
 {
     // $projectId = 'my-project-id';
     // $accessId = 'GOOG0234230X00';

storage/src/add_bucket_acl.php

@@ -33,7 +33,7 @@
  * @param string $entity The entity for which to update access controls.
  * @param string $role The permissions to add for the specified entity.
  */
-function add_bucket_acl($bucketName, $entity, $role)
+function add_bucket_acl(string $bucketName, string $entity, string $role): void
 {
     // $bucketName = 'my-bucket';
     // $entity = '[email protected]';

storage/src/add_bucket_conditional_iam_binding.php

@@ -39,7 +39,7 @@
  * To see how to express a condition in CEL, visit:
  * @see https://cloud.google.com/storage/docs/access-control/iam#conditions.
  */
-function add_bucket_conditional_iam_binding($bucketName, $role, array $members, $title, $description, $expression)
+function add_bucket_conditional_iam_binding(string $bucketName, string $role, array $members, string $title, string $description, string $expression): void
 {
     // $bucketName = 'my-bucket';
     // $role = 'roles/storage.objectViewer';

storage/src/add_bucket_default_acl.php

@@ -33,7 +33,7 @@
  * @param string $entity The entity for which to update access controls.
  * @param string $role The permissions to add for the specified entity.
  */
-function add_bucket_default_acl($bucketName, $entity, $role)
+function add_bucket_default_acl(string $bucketName, string $entity, string $role): void
 {
     // $bucketName = 'my-bucket';
     // $entity = '[email protected]';

storage/src/add_bucket_iam_member.php

@@ -33,7 +33,7 @@
  * @param string $role The role to which the given member should be added.
  * @param string[] $members The member(s) to be added to the role.
  */
-function add_bucket_iam_member($bucketName, $role, array $members)
+function add_bucket_iam_member(string $bucketName, string $role, array $members): void
 {
     // $bucketName = 'my-bucket';
     // $role = 'roles/storage.objectViewer';

storage/src/add_bucket_label.php

@@ -33,7 +33,7 @@
  * @param string $labelName The name of the label to add.
  * @param string $labelValue The value of the label to add.
  */
-function add_bucket_label($bucketName, $labelName, $labelValue)
+function add_bucket_label(string $bucketName, string $labelName, string $labelValue): void
 {
     // $bucketName = 'my-bucket';
     // $labelName = 'label-key-to-add';

storage/src/add_object_acl.php

@@ -34,7 +34,7 @@
  * @param string $entity The entity for which to update access controls.
  * @param string $role The permissions to add for the specified entity.
  */
-function add_object_acl($bucketName, $objectName, $entity, $role)
+function add_object_acl(string $bucketName, string $objectName, string $entity, string $role): void
 {
     // $bucketName = 'my-bucket';
     // $objectName = 'my-object';

storage/src/bucket_delete_default_kms_key.php

@@ -31,7 +31,7 @@
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
  */
-function bucket_delete_default_kms_key($bucketName)
+function bucket_delete_default_kms_key(string $bucketName): void
 {
     // $bucketName = 'my-bucket';
 

storage/src/change_default_storage_class.php

@@ -31,7 +31,7 @@
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
  */
-function change_default_storage_class($bucketName)
+function change_default_storage_class(string $bucketName): void
 {
     // $bucketName = 'my-bucket';
 

storage/src/change_file_storage_class.php

@@ -33,7 +33,7 @@
  * @param string $objectName The name of your Cloud Storage object.
  * @param string $storageClass The storage class of the new object.
  */
-function change_file_storage_class($bucketName, $objectName, $storageClass)
+function change_file_storage_class(string $bucketName, string $objectName, string $storageClass): void
 {
     // $bucketName = 'my-bucket';
     // $objectName = 'my-object';

storage/src/compose_file.php

@@ -34,7 +34,7 @@
  * @param string $secondObjectName The name of the second GCS object to compose.
  * @param string $targetObjectName The name of the object to be created.
  */
-function compose_file($bucketName, $firstObjectName, $secondObjectName, $targetObjectName)
+function compose_file(string $bucketName, string $firstObjectName, string $secondObjectName, string $targetObjectName): void
 {
     // $bucketName = 'my-bucket';
     // $firstObjectName = 'my-object-1';

storage/src/copy_file_archived_generation.php

@@ -34,7 +34,7 @@
  * @param string $generationToCopy The generation of the object to copy.
  * @param string $newObjectName The name of the target object.
  */
-function copy_file_archived_generation($bucketName, $objectToCopy, $generationToCopy, $newObjectName)
+function copy_file_archived_generation(string $bucketName, string $objectToCopy, string $generationToCopy, string $newObjectName): void
 {
     // $bucketName = 'my-bucket';
     // $objectToCopy = 'my-object';

storage/src/copy_object.php

@@ -34,7 +34,7 @@
  * @param string $newBucketName The destination bucket name.
  * @param string $newObjectName The destination object name.
  */
-function copy_object($bucketName, $objectName, $newBucketName, $newObjectName)
+function copy_object(string $bucketName, string $objectName, string $newBucketName, string $newObjectName): void
 {
     // $bucketName = 'my-bucket';
     // $objectName = 'my-object';

storage/src/cors_configuration.php

@@ -36,7 +36,7 @@
  * @param int $maxAgeSeconds The maximum amount of time the browser can make
  *     requests before it must repeat preflighted requests.
  */
-function cors_configuration($bucketName, $method, $origin, $responseHeader, $maxAgeSeconds)
+function cors_configuration(string $bucketName, string $method, string $origin, string $responseHeader, int $maxAgeSeconds): void
 {
     // $bucketName = 'my-bucket';
     // $method = 'GET';

storage/src/create_bucket.php

@@ -31,7 +31,7 @@
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
  */
-function create_bucket($bucketName)
+function create_bucket(string $bucketName): void
 {
     // $bucketName = 'my-bucket';
 

storage/src/create_bucket_class_location.php

@@ -31,7 +31,7 @@
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
  */
-function create_bucket_class_location($bucketName)
+function create_bucket_class_location(string $bucketName): void
 {
     // $bucketName = 'my-bucket';
 

storage/src/create_bucket_dual_region.php

@@ -34,7 +34,7 @@
  * @param string $region1 First region for the bucket's regions. Case-insensitive.
  * @param string $region2 Second region for the bucket's regions. Case-insensitive.
  */
-function create_bucket_dual_region($bucketName, $location, $region1, $region2)
+function create_bucket_dual_region(string $bucketName, string $location, string $region1, string $region2): void
 {
     // $bucketName = 'my-bucket';
     // $location = 'US';

storage/src/create_bucket_turbo_replication.php

@@ -34,7 +34,7 @@
  * @param string $location The Dual-Region location where you want your bucket to reside (e.g. "US-CENTRAL1+US-WEST1").
                                            Read more at https://cloud.google.com/storage/docs/locations#location-dr
  */
-function create_bucket_turbo_replication($bucketName, $location = 'nam4')
+function create_bucket_turbo_replication(string $bucketName, string $location = 'nam4'): void
 {
     // $bucketName = 'my-bucket';
 

storage/src/create_hmac_key.php

@@ -32,7 +32,7 @@
  * @param string $projectId The ID of your Google Cloud Platform project.
  * @param string $serviceAccountEmail Service account email to associate with the new HMAC key.
  */
-function create_hmac_key($projectId, $serviceAccountEmail)
+function create_hmac_key(string $projectId, string $serviceAccountEmail): void
 {
     // $projectId = 'my-project-id';
     // $serviceAccountEmail = '[email protected]';

storage/src/deactivate_hmac_key.php

@@ -32,7 +32,7 @@
  * @param string $projectId The ID of your Google Cloud Platform project.
  * @param string $accessId Access ID for an inactive HMAC key.
  */
-function deactivate_hmac_key($projectId, $accessId)
+function deactivate_hmac_key(string $projectId, string $accessId): void
 {
     // $projectId = 'my-project-id';
     // $accessId = 'GOOG0234230X00';

storage/src/define_bucket_website_configuration.php

@@ -35,7 +35,7 @@
  * @param string $notFoundPageObject the name of an object in the bucket to use
  *     as the 404 Not Found page.
  */
-function define_bucket_website_configuration($bucketName, $indexPageObject, $notFoundPageObject)
+function define_bucket_website_configuration(string $bucketName, string $indexPageObject, string $notFoundPageObject): void
 {
     // $bucketName = 'my-bucket';
     // $indexPageObject = 'index.html';

storage/src/delete_bucket.php

@@ -31,7 +31,7 @@
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
  */
-function delete_bucket($bucketName)
+function delete_bucket(string $bucketName): void
 {
     // $bucketName = 'my-bucket';
 

storage/src/delete_bucket_acl.php

@@ -32,7 +32,7 @@
  * @param string $bucketName The name of your Cloud Storage bucket.
  * @param string $entity The entity for which to update access controls.
  */
-function delete_bucket_acl($bucketName, $entity)
+function delete_bucket_acl(string $bucketName, string $entity): void
 {
     // $bucketName = 'my-bucket';
     // $entity = '[email protected]';

storage/src/delete_bucket_default_acl.php

@@ -32,7 +32,7 @@
  * @param string $bucketName The name of your Cloud Storage bucket.
  * @param string $entity The entity for which to update access controls.
  */
-function delete_bucket_default_acl($bucketName, $entity)
+function delete_bucket_default_acl(string $bucketName, string $entity): void
 {
     // $bucketName = 'my-bucket';
     // $entity = '[email protected]';

storage/src/delete_file_archived_generation.php

@@ -33,7 +33,7 @@
  * @param string $objectName The name of your Cloud Storage object.
  * @param string $generationToDelete the generation of the object to delete.
  */
-function delete_file_archived_generation($bucketName, $objectName, $generationToDelete)
+function delete_file_archived_generation(string $bucketName, string $objectName, string $generationToDelete): void
 {
     // $bucketName = 'my-bucket';
     // $objectName = 'my-object';

storage/src/delete_hmac_key.php

@@ -32,7 +32,7 @@
  * @param string $projectId The ID of your Google Cloud Platform project.
  * @param string $accessId Access ID for an HMAC key.
  */
-function delete_hmac_key($projectId, $accessId)
+function delete_hmac_key(string $projectId, string $accessId): void
 {
     // $projectId = 'my-project-id';
     // $accessId = 'GOOG0234230X00';

storage/src/delete_object.php

@@ -32,7 +32,7 @@
  * @param string $bucketName The name of your Cloud Storage bucket.
  * @param string $objectName The name of your Cloud Storage object.
  */
-function delete_object($bucketName, $objectName)
+function delete_object(string $bucketName, string $objectName): void
 {
     // $bucketName = 'my-bucket';
     // $objectName = 'my-object';

storage/src/delete_object_acl.php

@@ -33,7 +33,7 @@
  * @param string $objectName The name of your Cloud Storage object.
  * @param string $entity The entity for which to update access controls.
  */
-function delete_object_acl($bucketName, $objectName, $entity)
+function delete_object_acl(string $bucketName, string $objectName, string $entity): void
 {
     // $bucketName = 'my-bucket';
     // $objectName = 'my-object';

storage/src/disable_bucket_lifecycle_management.php

@@ -31,7 +31,7 @@
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
  */
-function disable_bucket_lifecycle_management($bucketName)
+function disable_bucket_lifecycle_management(string $bucketName): void
 {
     // $bucketName = 'my-bucket';
 

storage/src/disable_default_event_based_hold.php

@@ -31,7 +31,7 @@
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
  */
-function disable_default_event_based_hold($bucketName)
+function disable_default_event_based_hold(string $bucketName): void
 {
     // $bucketName = 'my-bucket';
 

storage/src/disable_requester_pays.php

@@ -31,7 +31,7 @@
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
  */
-function disable_requester_pays($bucketName)
+function disable_requester_pays(string $bucketName): void
 {
     // $bucketName = 'my-bucket';
 

storage/src/disable_uniform_bucket_level_access.php

@@ -31,7 +31,7 @@
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
  */
-function disable_uniform_bucket_level_access($bucketName)
+function disable_uniform_bucket_level_access(string $bucketName): void
 {
     // $bucketName = 'my-bucket';
 

storage/src/disable_versioning.php

@@ -31,7 +31,7 @@
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
  */
-function disable_versioning($bucketName)
+function disable_versioning(string $bucketName): void
 {
     // $bucketName = 'my-bucket';
 

storage/src/download_encrypted_object.php

@@ -35,7 +35,7 @@
  * @param string $base64EncryptionKey The base64 encoded encryption key. Should
  *     be the same key originally used to encrypt the object.
  */
-function download_encrypted_object($bucketName, $objectName, $destination, $base64EncryptionKey)
+function download_encrypted_object(string $bucketName, string $objectName, string $destination, string $base64EncryptionKey): void
 {
     // $bucketName = 'my-bucket';
     // $objectName = 'my-object';

storage/src/download_file_requester_pays.php

@@ -34,7 +34,7 @@
  * @param string $objectName The name of your Cloud Storage object.
  * @param string $destination The local destination to save the object.
  */
-function download_file_requester_pays($projectId, $bucketName, $objectName, $destination)
+function download_file_requester_pays(string $projectId, string $bucketName, string $objectName, string $destination): void
 {
     // $projectId = 'my-project-id';
     // $bucketName = 'my-bucket';

storage/src/download_object.php

@@ -34,7 +34,7 @@
  * @param string $objectName The name of your Cloud Storage object.
  * @param string $destination The local destination to save the object.
  */
-function download_object($bucketName, $objectName, $destination)
+function download_object(string $bucketName, string $objectName, string $destination): void
 {
     // $bucketName = 'my-bucket';
     // $objectName = 'my-object';

storage/src/download_public_file.php

@@ -33,7 +33,7 @@
  * @param string $objectName The name of your Cloud Storage object.
  * @param string $destination The local destination to save the object.
  */
-function download_public_file($bucketName, $objectName, $destination)
+function download_public_file(string $bucketName, string $objectName, string $destination): void
 {
     // $bucketName = 'my-bucket';
     // $objectName = 'my-object';

storage/src/enable_bucket_lifecycle_management.php

@@ -32,7 +32,7 @@
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
  */
-function enable_bucket_lifecycle_management($bucketName)
+function enable_bucket_lifecycle_management(string $bucketName): void
 {
     // $bucketName = 'my-bucket';
 

storage/src/enable_default_event_based_hold.php

@@ -31,7 +31,7 @@
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
  */
-function enable_default_event_based_hold($bucketName)
+function enable_default_event_based_hold(string $bucketName): void
 {
     // $bucketName = 'my-bucket';
 

storage/src/enable_default_kms_key.php

@@ -34,7 +34,7 @@
  *     Key names are provided in the following format:
  *     `projects//locations//keyRings//cryptoKeys/`.
  */
-function enable_default_kms_key($bucketName, $kmsKeyName)
+function enable_default_kms_key(string $bucketName, string $kmsKeyName): void
 {
     // $bucketName = 'my-bucket';
     // $kmsKeyName = "";

storage/src/enable_requester_pays.php

@@ -31,7 +31,7 @@
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
  */
-function enable_requester_pays($bucketName)
+function enable_requester_pays(string $bucketName): void
 {
     // $bucketName = 'my-bucket';
 

storage/src/enable_uniform_bucket_level_access.php

@@ -31,7 +31,7 @@
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
  */
-function enable_uniform_bucket_level_access($bucketName)
+function enable_uniform_bucket_level_access(string $bucketName): void
 {
     // $bucketName = 'my-bucket';
 

storage/src/enable_versioning.php

@@ -31,7 +31,7 @@
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
  */
-function enable_versioning($bucketName)
+function enable_versioning(string $bucketName): void
 {
     // $bucketName = 'my-bucket';
 

storage/src/generate_encryption_key.php

@@ -28,7 +28,7 @@
 /**
  * Generate a base64 encoded encryption key for Google Cloud Storage.
  */
-function generate_encryption_key()
+function generate_encryption_key(): void
 {
     $key = random_bytes(32);
     $encodedKey = base64_encode($key);