List subcollections sample + tests (GoogleCloudPlatform#574)

Author: ryanmats

firestore/README.md

@@ -82,6 +82,7 @@ To run the Cloud Firestore Samples:
       add-doc-data-after-auto-id           Auto-generate an ID for a document, then add document data.
       add-doc-data-types                   Set document data with different data types.
       add-doc-data-with-auto-id            Add document data with an auto-generated ID.
+      add-subcollection                    Add a subcollection by creating a new document.
       batch-write                          Batch write.
       chained-query                        Create a query with chained clauses.
       collection-ref                       Get a collection reference.
@@ -104,6 +105,7 @@ To run the Cloud Firestore Samples:
       invalid-range-order-by-query         An invalid range with order by query.
       invalid-range-query                  An example of an invalid range query.
       list                                 Lists commands
+      list-subcollections                  List subcollections of a document.
       multiple-cursor-conditions           Set multiple cursor conditions.
       order-by-name-desc-limit-query       Create an order by name descending with limit query.
       order-by-name-limit-query            Create an order by name with limit query.

firestore/composer.json

@@ -20,6 +20,7 @@
             "src/set_requires_id.php",
             "src/add_doc_data_with_auto_id.php",
             "src/add_doc_data_after_auto_id.php",
+            "src/list_subcollections.php",
             "src/query_create_examples.php",
             "src/create_query_state.php",
             "src/create_query_capital.php",

firestore/firestore.php

@@ -443,6 +443,48 @@
     })
 );
 
+// Add Subcollection command
+$application->add((new Command('add-subcollection'))
+    ->setDefinition($inputDefinition)
+    ->setDescription('Add a subcollection by creating a new document.')
+    ->setHelp(<<<EOF
+The <info>%command.name%</info> command adds a subcollection by creating a new document using the Google Cloud Firestore API.
+
+    <info>php %command.full_name%</info>
+
+EOF
+    )
+    ->setCode(function ($input, $output) {
+        $projectId = $input->getArgument('project');
+        $db = new FirestoreClient([
+            'projectId' => $projectId,
+        ]);
+        $cityRef = $db->collection('cities')->document('SF');
+        $subcollectionRef = $cityRef->collection('neighborhoods');
+        $data = [
+            'name' => 'Marina',
+        ];
+        $subcollectionRef->document('Marina')->set($data);
+    })
+);
+
+// List Subcollections command
+$application->add((new Command('list-subcollections'))
+    ->setDefinition($inputDefinition)
+    ->setDescription('List subcollections of a document.')
+    ->setHelp(<<<EOF
+The <info>%command.name%</info> command lists subcollections of a document using the Google Cloud Firestore API.
+
+    <info>php %command.full_name%</info>
+
+EOF
+    )
+    ->setCode(function ($input, $output) {
+        $projectId = $input->getArgument('project');
+        list_subcollections($projectId);
+    })
+);
+
 // Order By Name Limit Query command
 $application->add((new Command('order-by-name-limit-query'))
     ->setDefinition($inputDefinition)
@@ -816,6 +858,8 @@
         $db = new FirestoreClient([
             'projectId' => $projectId,
         ]);
+        $subcollection = $db->collection('cities/SF/neighborhoods');
+        delete_collection($subcollection, 2);
         $cityCollection = $db->collection('cities');
         delete_collection($cityCollection, 2);
         $dataCollection = $db->collection('data');

firestore/src/list_subcollections.php

@@ -0,0 +1,47 @@
+<?php
+/**
+ * Copyright 2018 Google Inc.
+ *
+ * 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/firestore/README.md
+ */
+
+namespace Google\Cloud\Samples\Firestore;
+
+use Google\Cloud\Firestore\FirestoreClient;
+
+/**
+ * List subcollections of a document.
+ * ```
+ * list_subcollections('your-project-id');
+ * ```
+ */
+function list_subcollections($projectId)
+{
+    // Create the Cloud Firestore client
+    $db = new FirestoreClient([
+        'projectId' => $projectId,
+    ]);
+    # [START fs_get_collections]
+    $cityRef = $db->collection('cities')->document('SF');
+    $collections = $cityRef->collections();
+    foreach ($collections as $collection) {
+        printf('Found subcollection with id: %s' . PHP_EOL, $collection->id());
+    }
+    # [END fs_get_collections]
+}

firestore/test/firestoreTest.php

@@ -273,6 +273,16 @@ public function testGetAllDocs()
         $this->assertContains('Document data for document LA:', $output);
         $this->assertContains('[name] => Los Angeles', $output);
     }
+    
+    /**
+     * @depends testRetrieveCreateExamples
+     */
+    public function testListSubcollections()
+    {
+        $this->runCommand('add-subcollection');
+        $output = $this->runCommand('list-subcollections');
+        $this->assertContains('Found subcollection with id: neighborhoods', $output);
+    }
 
     /**
      * @depends testRetrieveCreateExamples