adds list objects with prefix sample to storage (GoogleCloudPlatform#242)

Author: bshaffer

storage/api/composer.json

@@ -31,6 +31,7 @@
             "src/functions/get_object_acl_for_entity.php",
             "src/functions/list_buckets.php",
             "src/functions/list_objects.php",
+            "src/functions/list_objects_with_prefix.php",
             "src/functions/make_public.php",
             "src/functions/move_object.php",
             "src/functions/rotate_encryption_key.php",

storage/api/composer.lock

@@ -88,6 +88,12 @@ protected function configure()
                 InputOption::VALUE_NONE,
                 'Delete the bucket'
             )
+            ->addOption(
+                'prefix',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'List objects matching a prefix'
+            )
         ;
     }
 
@@ -111,7 +117,11 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 object_metadata($bucketName, $objectName);
             }
         } else {
-            list_objects($bucketName);
+            if ($prefix = $input->getOption('prefix')) {
+                list_objects_with_prefix($bucketName, $prefix);
+            } else {
+                list_objects($bucketName);
+            }
         }
     }
 }

storage/api/src/ObjectsCommand.php

@@ -0,0 +1,45 @@
+<?php
+/**
+ * Copyright 2015 Google Inc. All Rights Reserved.
+ *
+ * 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/master/storage/api/README.md
+ */
+
+namespace Google\Cloud\Samples\Storage;
+
+# [START list_objects_with_prefix]
+use Google\Cloud\Storage\StorageClient;
+
+/**
+ * Add ACL to a Cloud Storage Bucket.
+ *
+ * @param string $bucketName the name of your Cloud Storage bucket.
+ *
+ * @return void
+ */
+function list_objects_with_prefix($bucketName, $prefix)
+{
+    $storage = new StorageClient();
+    $bucket = $storage->bucket($bucketName);
+    $options = ['prefix' => $prefix];
+    foreach ($bucket->objects($options) as $object) {
+        printf('Object: %s' . PHP_EOL, $object->name());
+    }
+}
+# [END list_objects_with_prefix]

storage/api/src/functions/list_objects_with_prefix.php

@@ -65,6 +65,28 @@ public function testListObjects()
         $this->expectOutputRegex("/Object:/");
     }
 
+    public function testListObjectsWithPrefix()
+    {
+        if (!self::$hasCredentials) {
+            $this->markTestSkipped('No application credentials were found.');
+        }
+        if (!$bucketName = getenv('GOOGLE_STORAGE_BUCKET')) {
+            $this->markTestSkipped('No storage bucket name.');
+        }
+
+        ob_start();
+        $this->commandTester->execute(
+            [
+                'bucket' => $bucketName,
+                '--prefix' => 'test_data.csv'
+            ],
+            ['interactive' => false]
+        );
+        $output = ob_get_clean();
+
+        $this->assertEquals(1, substr_count($output, 'Object: '));
+    }
+
     public function testManageObject()
     {
         if (!self::$hasCredentials) {