chore: upgrade vision samples to new format (GoogleCloudPlatform#1638)

Author: bshaffer

vision/README.md

@@ -28,52 +28,15 @@ This simple command-line application demonstrates how to invoke
     Run `php composer.phar install` (if composer is installed locally) or `composer install`
     (if composer is installed globally).
 5.  For a basic demonstration of the Cloud Vision API, run `php quickstart.php`.
-6.  Run `php vision.php` or `php product_search.php`. For `vision.php`, the following commands are available:
-```
-  face            Detect faces in an image using Google Cloud Vision API
-  help            Displays help for a command
-  label           Detect labels in an image using Google Cloud Vision API
-  landmark        Detect landmarks in an image using Google Cloud Vision API
-  list            Lists commands
-  localize-object Detect objects in an image using Google Cloud Vision API
-  logo            Detect logos in an image using Google Cloud Vision API
-  property        Detect image properties in an image using Google Cloud Vision API
-  safe-search     Detect adult content in an image using Google Cloud Vision API
-  text            Detect text in an image using Google Cloud Vision API
-  crop-hints      Detect crop hints in an image using Google Cloud Vision API
-  document-text   Detect document text in an image using Google Cloud Vision API
-  pdf             Detect text in a PDF/TIFF using Google Cloud Vision API
-  web             Detect web entities in an image using Google Cloud Vision API
-  web-geo         Detect web entities in an image with geo metadata using
-                  Google Cloud Vision API
-```
-   For `product_search.php`, the following commands are available:
-```
-  product-create                        Create a product
-  product-delete                        Delete a product
-  product-get                           Get information of a product
-  product-list                          List information for all products
-  product-update                        Update information for a product
-  product-image-create                  Create reference image
-  product-image-delete                  Delete reference image
-  product-image-get                     Get reference image information for a product
-  product-image-list                    List all reference image information for a product
-  product-search-similar                Search for similar products to local image
-  product-search-similar-gcs            Search for similar products to GCS image
-  product-set-create                    Create a product set
-  product-set-delete                    Delete a product set
-  product-set-get                       Get information for a product set
-  product-set-import                    Import a product set
-  product-set-list                      List information for all product sets
-  product-set-add-product               Add product to a product set
-  product-set-list-products             List products in a product set
-  product-set-remove-product            Remove product from a product set
-  product-purge-orphan                  Delete all products not in any product sets
-  product-purge-products-in-product-set Delete all products not in any product set
-```
-
-7. Run `php vision.php COMMAND --help` or `php product_search.php COMMAND --help` to print information about the usage of each command.
-
+6.  Execute the snippets in the [src/](src/) directory by running
+    `php src/SNIPPET_NAME.php`. The usage will print for each if no arguments
+    are provided:
+    ```sh
+    $ php src/detext_face.php
+    Usage: php src/detext_face.php <PATH>
+
+    $ php src/detect_face.php 'path/to/your/image.jpg'
+    ```
 ## The client library
 
 This sample uses the [Google Cloud Client Library for PHP][google-cloud-php].

vision/composer.json

@@ -3,37 +3,6 @@
     "type": "project",
     "require": {
         "google/cloud-vision": "^1.0.0",
-        "google/cloud-storage": "^1.20.1",
-        "symfony/console": "^5.0"
-    },
-    "autoload": {
-        "psr-4": {
-            "Google\\Cloud\\Samples\\Vision\\": "src/"
-        },
-        "files": [
-            "src/detect_label.php",
-            "src/detect_label_gcs.php",
-            "src/detect_text.php",
-            "src/detect_text_gcs.php",
-            "src/detect_face.php",
-            "src/detect_face_gcs.php",
-            "src/detect_landmark.php",
-            "src/detect_landmark_gcs.php",
-            "src/detect_logo.php",
-            "src/detect_logo_gcs.php",
-            "src/detect_safe_search.php",
-            "src/detect_safe_search_gcs.php",
-            "src/detect_image_property.php",
-            "src/detect_image_property_gcs.php",
-            "src/detect_document_text.php",
-            "src/detect_document_text_gcs.php",
-            "src/detect_web.php",
-            "src/detect_web_gcs.php",
-            "src/detect_object.php",
-            "src/detect_object_gcs.php",
-            "src/detect_web_with_geo_metadata.php",
-            "src/detect_web_with_geo_metadata_gcs.php",
-            "src/detect_pdf_gcs.php"
-        ]
+        "google/cloud-storage": "^1.20.1"
     }
 }

vision/src/detect_document_text.php

@@ -20,9 +20,10 @@
 
 use Google\Cloud\Vision\V1\ImageAnnotatorClient;
 
-// $path = 'path/to/your/image.jpg'
-
-function detect_document_text($path)
+/**
+ * @param string $path Path to the image, e.g. "path/to/your/image.jpg"
+ */
+function detect_document_text(string $path)
 {
     $imageAnnotator = new ImageAnnotatorClient();
 
@@ -67,3 +68,7 @@ function detect_document_text($path)
     $imageAnnotator->close();
 }
 // [END vision_fulltext_detection]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

vision/src/detect_document_text_gcs.php

@@ -20,9 +20,10 @@
 
 use Google\Cloud\Vision\V1\ImageAnnotatorClient;
 
-// $path = 'gs://path/to/your/image.jpg'
-
-function detect_document_text_gcs($path)
+/**
+ * @param string $path GCS path to the image, e.g. "gs://path/to/your/image.jpg"
+ */
+function detect_document_text_gcs(string $path)
 {
     $imageAnnotator = new ImageAnnotatorClient();
 
@@ -67,3 +68,7 @@ function detect_document_text_gcs($path)
     $imageAnnotator->close();
 }
 // [END vision_fulltext_detection_gcs]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

vision/src/detect_face.php

@@ -21,8 +21,12 @@
 use Google\Cloud\Vision\V1\ImageAnnotatorClient;
 
 // [END vision_face_detection_tutorial_imports]
-
-function detect_face($path, $outFile = null)
+/**
+ * @param string $path    Path to the image, e.g. "path/to/your/image.jpg"
+ * @param string $outFile Saves a copy of the image supplied in $path with a
+ *                        rectangle drawn around the detected faces.
+ */
+function detect_face(string $path, string $outFile = null)
 {
     // [START vision_face_detection_tutorial_client]
     $imageAnnotator = new ImageAnnotatorClient();
@@ -108,3 +112,7 @@ function detect_face($path, $outFile = null)
     // [START vision_face_detection]
 }
 // [END vision_face_detection]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

vision/src/detect_face_gcs.php

@@ -20,9 +20,10 @@
 
 use Google\Cloud\Vision\V1\ImageAnnotatorClient;
 
-// $path = 'gs://path/to/your/image.jpg'
-
-function detect_face_gcs($path)
+/**
+ * @param string $path GCS path to the image, e.g. "gs://path/to/your/image.jpg"
+ */
+function detect_face_gcs(string $path)
 {
     $imageAnnotator = new ImageAnnotatorClient();
 
@@ -58,3 +59,7 @@ function detect_face_gcs($path)
     $imageAnnotator->close();
 }
 // [END vision_face_detection_gcs]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

vision/src/detect_image_property.php

@@ -20,9 +20,10 @@
 
 use Google\Cloud\Vision\V1\ImageAnnotatorClient;
 
-// $path = 'path/to/your/image.jpg'
-
-function detect_image_property($path)
+/**
+ * @param string $path Path to the image, e.g. "path/to/your/image.jpg"
+ */
+function detect_image_property(string $path)
 {
     $imageAnnotator = new ImageAnnotatorClient();
 
@@ -44,3 +45,7 @@ function detect_image_property($path)
     $imageAnnotator->close();
 }
 // [END vision_image_property_detection]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

vision/src/detect_image_property_gcs.php

@@ -20,9 +20,10 @@
 
 use Google\Cloud\Vision\V1\ImageAnnotatorClient;
 
-// $path = 'gs://path/to/your/image.jpg'
-
-function detect_image_property_gcs($path)
+/**
+ * @param string $path GCS path to the image, e.g. "gs://path/to/your/image.jpg"
+ */
+function detect_image_property_gcs(string $path)
 {
     $imageAnnotator = new ImageAnnotatorClient();
 
@@ -47,3 +48,7 @@ function detect_image_property_gcs($path)
     $imageAnnotator->close();
 }
 // [END vision_image_property_detection_gcs]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

vision/src/detect_label.php

@@ -20,9 +20,10 @@
 
 use Google\Cloud\Vision\V1\ImageAnnotatorClient;
 
-// $path = 'path/to/your/image.jpg'
-
-function detect_label($path)
+/**
+ * @param string $path Path to the image, e.g. "path/to/your/image.jpg"
+ */
+function detect_label(string $path)
 {
     $imageAnnotator = new ImageAnnotatorClient();
 
@@ -43,3 +44,7 @@ function detect_label($path)
     $imageAnnotator->close();
 }
 // [END vision_label_detection]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

vision/src/detect_label_gcs.php

@@ -20,9 +20,10 @@
 
 use Google\Cloud\Vision\V1\ImageAnnotatorClient;
 
-// $path = 'gs://path/to/your/image.jpg'
-
-function detect_label_gcs($path)
+/**
+ * @param string $path GCS path to the image, e.g. "gs://path/to/your/image.jpg"
+ */
+function detect_label_gcs(string $path)
 {
     $imageAnnotator = new ImageAnnotatorClient();
 
@@ -42,3 +43,7 @@ function detect_label_gcs($path)
     $imageAnnotator->close();
 }
 // [END vision_label_detection_gcs]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);