appengine/php72/getting-started: update region tags & index.php comments (GoogleCloudPlatform#828)

Author: grayside

appengine/php72/getting-started/index.php

@@ -16,15 +16,25 @@
  */
 
 /**
- * This front controller is called by the App Engine web server to handle all
- * incoming requests. To change this, you will need to modify the "entrypoint"
- * directive in `app.yaml`.
+ * This front controller is called by the App Engine web server to handle
+ * incoming requests.
+ *
+ * To use another file, modify the "entrypoint" directive in `app.yaml`.
+ *
  * @see https://cloud.google.com/appengine/docs/standard/php/config/appref
  */
+
+// [START gae_php_app_bootstrap]
+
+// Use the composer autoloader to load dependencies.
 require_once __DIR__ . '/vendor/autoload.php';
 
+//  Load the application code.
 /** @var Slim\App $app */
 $app = require __DIR__ . '/src/app.php';
 require __DIR__ . '/src/controllers.php';
 
+// Bootstrap the slim framework to handle the request.
 $app->run();
+
+// [END gae_php_app_bootstrap]

appengine/php72/getting-started/src/CloudSqlDataModel.php

@@ -74,7 +74,6 @@ private function verifyBook($book)
     public function listBooks($limit = 10, $cursor = 0)
     {
         $pdo = $this->pdo;
-        // [START run_cloudsql_query_multiple_rows]
         $query = 'SELECT * FROM books WHERE id > :cursor ORDER BY id LIMIT :limit';
         $statement = $pdo->prepare($query);
         $statement->bindValue(':cursor', $cursor, PDO::PARAM_INT);
@@ -84,7 +83,6 @@ public function listBooks($limit = 10, $cursor = 0)
         // while ($row = $statement->fetch(PDO::FETCH_ASSOC)) {
         //     var_dump($row);
         // }
-        // [END run_cloudsql_query_multiple_rows]
         $rows = array();
         $nextCursor = null;
         while ($row = $statement->fetch(PDO::FETCH_ASSOC)) {
@@ -109,27 +107,25 @@ public function create($book, $id = null)
             return ":$key";
         }, $names);
         $pdo = $this->pdo;
-        // [START cloudsql_write]
         $sql = sprintf(
             'INSERT INTO books (%s) VALUES (%s)',
             implode(', ', $names),
             implode(', ', $placeHolders)
         );
         $statement = $pdo->prepare($sql);
         $statement->execute($book);
-        // [END cloudsql_write]
         return $this->pdo->lastInsertId();
     }
 
     public function read($id)
     {
         $pdo = $this->pdo;
-        // [START run_cloudsql_query]
+        // [START gae_php_app_cloudsql_query]
         $statement = $pdo->prepare('SELECT * FROM books WHERE id = :id');
         $statement->bindValue('id', $id, PDO::PARAM_INT);
         $statement->execute();
         $result = $statement->fetch(PDO::FETCH_ASSOC);
-        // [END run_cloudsql_query]
+        // [END gae_php_app_cloudsql_query]
         return $result;
     }
 

appengine/php72/getting-started/src/app.php

@@ -21,10 +21,10 @@
  * Follows Silex Skeleton pattern.
  */
 use Google\Cloud\Samples\AppEngine\GettingStarted\CloudSqlDataModel;
-// [START storage_client_import]
+// [START gae_php_app_storage_client_import]
 use Google\Cloud\Storage\StorageClient;
 
-// [END storage_client_import]
+// [END gae_php_app_storage_client_import]
 
 $app = new Slim\App([
     'settings' => [
@@ -43,7 +43,7 @@
 // Cloud Storage bucket
 $container['bucket'] = function ($container) {
     $bucketName = getenv('GOOGLE_STORAGE_BUCKET');
-    // [START setup_storage_client]
+    // [START gae_php_app_storage_client_setup]
     // Your Google Cloud Storage bucket name and Project ID can be configured
     // however fits your application best.
     // $projectId = 'YOUR_PROJECT_ID';
@@ -52,7 +52,7 @@
         'projectId' => $projectId,
     ]);
     $bucket = $storage->bucket($bucketName);
-    // [END setup_storage_client]
+    // [END gae_php_app_storage_client_setup]
     return $bucket;
 };
 
@@ -63,15 +63,15 @@
     $dbConn = getenv('CLOUDSQL_CONNECTION_NAME');
     $dbUser = getenv('CLOUDSQL_USER');
     $dbPass = getenv('CLOUDSQL_PASSWORD');
-    // [START setup_cloudsql_client]
+    // [START gae_php_app_cloudsql_client_setup]
     // Fill the variables below to match your Cloud SQL configuration.
     // $dbConn = 'YOUR_CLOUDSQL_CONNECTION_NAME';
     // $dbName = 'YOUR_CLOUDSQL_DATABASE_NAME';
     // $dbUser = 'YOUR_CLOUDSQL_USER';
     // $dbPass = 'YOUR_CLOUDSQL_PASSWORD';
     $dsn = "mysql:unix_socket=/cloudsql/${dbConn};dbname=${dbName}";
     $pdo = new PDO($dsn, $dbUser, $dbPass);
-    // [END setup_cloudsql_client]
+    // [END gae_php_app_cloudsql_client_setup]
     $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
     return new CloudSqlDataModel($pdo);
 };

appengine/php72/getting-started/src/controllers.php

@@ -95,7 +95,7 @@
         $bucket = $this->bucket;
         $imageStream = $image->getStream();
         $imageContentType = $image->getClientMediaType();
-        // [START upload_image]
+        // [START gae_php_app_upload_image]
         // Set your own image file path and content type below to upload an
         // image to Cloud Storage.
         // $imageStream = fopen('/path/to/your_image.jpg', 'r');
@@ -105,7 +105,7 @@
             'predefinedAcl' => 'publicRead',
         ]);
         $imageUrl = $object->info()['mediaLink'];
-        // [END upload_image]
+        // [END gae_php_app_upload_image]
         $book['image_url'] = $imageUrl;
     }
     if ($this->cloudsql->update($book)) {
@@ -123,10 +123,10 @@
             $objectName = parse_url(basename($book['image_url']), PHP_URL_PATH);
             $bucket = $this->bucket;
             // get bucket name from image
-            // [START delete_image]
+            // [START gae_php_app_delete_image]
             $object = $bucket->object($objectName);
             $object->delete();
-            // [END delete_image]
+            // [END gae_php_app_delete_image]
         }
         return $response->withRedirect('/books');
     }