update php paged map fields with map field snippet (#3325)

googleapis · Jan 7, 2021 · d284392 · d284392
1 parent 7c508c8
commit d284392
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git a/src/main/java/com/google/api/codegen/transformer/PageStreamingTransformer.java b/src/main/java/com/google/api/codegen/transformer/PageStreamingTransformer.java
@@ -56,6 +56,7 @@ public PageStreamingDescriptorView generateDescriptor(
         context.getNamer().getFieldGetFunctionName(pageStreaming.getResourcesField()));
     descriptor.methodName(context.getNamer().getMethodKey(method));
     descriptor.transportMethodName(context.getNamer().getGrpcMethodName(method));
+    descriptor.resourcesFieldIsMap(pageStreaming.getResourcesField().isMap());
     return descriptor.build();
   }
 

diff --git a/src/main/java/com/google/api/codegen/viewmodel/PageStreamingDescriptorView.java b/src/main/java/com/google/api/codegen/viewmodel/PageStreamingDescriptorView.java
@@ -41,6 +41,8 @@ public abstract class PageStreamingDescriptorView {
 
   public abstract String resourcesGetMethodName();
 
+  public abstract Boolean resourcesFieldIsMap();
+
   public abstract String methodName();
 
   public abstract String transportMethodName();
@@ -75,6 +77,8 @@ public abstract static class Builder {
 
     public abstract Builder resourcesGetMethodName(String val);
 
+    public abstract Builder resourcesFieldIsMap(Boolean val);
+
     public abstract Builder methodName(String val);
 
     public abstract Builder transportMethodName(String val);

diff --git a/src/main/resources/com/google/api/codegen/php/method_sample.snip b/src/main/resources/com/google/api/codegen/php/method_sample.snip
@@ -154,7 +154,11 @@
     // Iterate over pages of elements
     $pagedResponse = {@methodCallSampleCode(apiMethod)};
     foreach ($pagedResponse->iteratePages() as $page) {
+        @if apiMethod.pageStreamingView.resourcesFieldIsMap
+        foreach ($page as $key => $element) {
+        @else
         foreach ($page as $element) {
+        @end
             // doSomethingWith($element);
         }
     }
@@ -163,7 +167,11 @@
 @private pagedAllSampleCode(apiMethod)
     // Iterate through all elements
     $pagedResponse = {@methodCallSampleCode(apiMethod)};
+    @if apiMethod.pageStreamingView.resourcesFieldIsMap
+    foreach ($pagedResponse->iterateAllElements() as $key => $element) {
+    @else
     foreach ($pagedResponse->iterateAllElements() as $element) {
+    @end
         // doSomethingWith($element);
     }
 @end

diff --git a/src/test/java/com/google/api/codegen/protoannotations/testdata/php_library_rest.baseline b/src/test/java/com/google/api/codegen/protoannotations/testdata/php_library_rest.baseline
@@ -1019,7 +1019,7 @@ class LibraryServiceGapicClient
      *     // Iterate over pages of elements
      *     $pagedResponse = $libraryServiceClient->listAggregatedShelves();
      *     foreach ($pagedResponse->iteratePages() as $page) {
-     *         foreach ($page as $element) {
+     *         foreach ($page as $key => $element) {
      *             // doSomethingWith($element);
      *         }
      *     }
@@ -1029,7 +1029,7 @@ class LibraryServiceGapicClient
      *
      *     // Iterate through all elements
      *     $pagedResponse = $libraryServiceClient->listAggregatedShelves();
-     *     foreach ($pagedResponse->iterateAllElements() as $element) {
+     *     foreach ($pagedResponse->iterateAllElements() as $key => $element) {
      *         // doSomethingWith($element);
      *     }
      * } finally {