Skip to content

Headoo/GoogleVisionApiBundle

Repository files navigation

GoogleVisionApiBundle

Build Status Code Climate Latest Stable Version codecov

GoogleVisionApiBundle is a Symfony2/3 Bundle for use the API Google Vision simply (https://cloud.google.com/vision/)

Installation

Via Composer

$ composer require headoo/google-vision-api-bundle

or in composer.json file

"headoo/google-vision-api-bundle": "dev-master"

Register the bundle in app/AppKernel.php:

public function registerBundles()
{
    return array(
        // ...
        new Headoo\GoogleVisionApiBundle\HeadooGoogleVisionApiBundle(),
        // ...
    );
}

Configuration

Configure the google api key in your config.yml :

headoo_google_vision_api:
    api_key: '%apikey%'

Usage

It works like a service. On a Controller you can call like this:

	$google_vision = $this->container->get('headoo_google_vision_api.helper');

You can use all detections functionality with 1 endpoint:

	$google_vision->vision($image, $type);

Your $image must be base64 encoded, or via an URL , or an absolute path.

Available $type are :

  • TYPE_UNSPECIFIED
  • FACE_DETECTION
  • LANDMARK_DETECTION
  • LOGO_DETECTION
  • LABEL_DETECTION
  • TEXT_DETECTION
  • SAFE_SEARCH_DETECTION
  • IMAGE_PROPERTIES
  • WEB_DETECTION

Return

You will receive an array with http_code, raw_response and a parsed_response.

  • http_code : Google Http Code Response (often 200 for OK, and 400 for error)
  • raw_response : Google Vision Api Response Raw, without manipulation
  • parsed_response : Parsed response with objects, easier to use for a PHP user.

Security

If you discover a security vulnerability , please email instead of using the issue tracker. All security vulnerabilities will be promptly addressed.

Standalone Test

How to test

  1. clone repo : $ sudo git clone https://github.com/Headoo/GoogleVisionApiBundle.git
  2. go into directory : $ cd GoogleVisionApiBundle/
  3. install composer as explained here : https://getcomposer.org/download/
  4. launch composer update : $ ./composer.phar update
  5. modify headoo_google_vision_api.api_key in Tests/App/config.yml
  6. launch test : $ ./vendor/phpunit/phpunit/phpunit

License

This Bundle is open-sourced software licensed under the MIT license