README

This is a fork of https://github.com/SachinAgarwal1337/google-places-api.

I added model classes for results, API to retrieve photos, and caching.

Google Places APi.

This is a PHP wrapper for Google Places Api Web Service. And is Laravel Framework friendly.

About Package

With just 2 lines of code you can request to any google places api feature. No need to manually perform any curl requests.

The following place requests are available:

Place Search return a list of places based on a user's location or search string.
Place Details requests return more detailed information about a specific Place, including user reviews.
Place Autocomplete can be used to automatically fill in the name and/or address of a place as you type.
Query Autocomplete can be used to provide a query prediction service for text-based geographic searches, by returning suggested queries as you type.

Installation

Install it with composer

composer require vovanmix/google-places-api

Usage

Laravel user can see the Laravel Usage section

Step 1 - Import the class using namespace

use Vovanmix\GoogleApi\PlacesApi;

Step 2 - Initiate the object

$googlePlaces = new PlacesApi('API KEY');

Note: You can also set the API KEY after initaiting the class using setKey('KEY') method. You can chain this with method with anyother methods.

Step 3 - Start Using the Api.

Example:

$response = $googlePlaces->placeAutocomplete('some Place');

As mentioned earlier just 2 lines of code to make any request.

Full example:

use Vovanmix\GoogleApi\PlacesApi;


function () {
  $googlePlaces = new PlacesApi('API_KEY') # line 1
  $response = $googlePlaces->placeAutocomplete('some input'); # line 2
}

Use with Laravel

Step 1

Set up the service provider and facade in the config\app.php

'providers' => [
....
....
Vovanmix\GoogleApi\ServiceProvider::class,
];

'aliases' => [
....
....
'GooglePlaces' => Vovanmix\GoogleApi\Facade::class,
];

Step 2

publish the config file with following artisan command

php artisan vendor:publish --provider="Vovanmix\GoogleApi\ServiceProvider"

This will create google.php file in the config directory.

Set the API KEY in this config file.

Set 3

Start using the package using Facade.

$response = GooglePlaces::placesAutocomplete('some city');

Response

The response returned is a Laravel's Collection so that you can perform any of the available collection methods on it.

If you are not familiar with Laravel's Collecton you can either reference the docs here or you can use response as simple array.

Available Methods

Place Search

nearbySearch($location, $radius = null, $params = [])

location — The latitude/longitude around which to retrieve place information. This must be specified as latitude,longitude.
'radius' — Defines the distance (in meters) within which to return place results. The maximum allowed radius is 50 000 meters. Note that radius must not be included if rankby=distance (described under Optional parameters below) is specified.
If rankby=distance (described under Optional parameters below) is specified, then one or more of keyword, name, or types is required.
params - Optionan Parameters You can refer all the avaiable optional parameters on the Google's Official Webpage

textSearch($query, $params = [])

query — The text string on which to search, for example: "restaurant". The Google Places service will return candidate matches based on this string and order the results based on their perceived relevance.
params - Optionan Parameters You can refer all the avaiable optional parameters on the Google's Official Webpage

radarSearch($location, $radius, array $params)

location — The latitude/longitude around which to retrieve place information. This must be specified as latitude,longitude.
radius — Defines the distance (in meters) within which to return place results. The maximum allowed radius is 50 000 meters.
params - Optionan Parameters You can refer all the avaiable optional parameters on the Google's Official Webpage

Note: A Radar Search request must include at least one of keyword, name, or types.

Place Details

placeDetails($placeId, $params = [])

placeId — A textual identifier that uniquely identifies a place, returned from a Place Search.
params - Optionan Parameters You can refer all the avaiable optional parameters on the Google's Official Webpage

Place Autocomplete

placeAutocomplete($input, $params = [])

input — The text string on which to search. The Place Autocomplete service will return candidate matches based on this string and order results based on their perceived relevance.
params - Optionan Parameters You can refer all the avaiable optional parameters on the Google's Official Webpage

Query Autocomplete

queryAutocomplete($input, $params = [])

input — The text string on which to search. The Places service will return candidate matches based on this string and order results based on their perceived relevance.
params - Optionan Parameters You can refer all the avaiable optional parameters on the Google's Official Webpage

Additional Methods

getStatus()

This will return the status of the response send by google api. Use it after making any reqquest.

getKey()

This will return the API KEY been used with the requests.

setKey($key)

This will set the API KEY.

Contribution

Feel free to report issues or make Pull Requests. If you find this document can be improved in any way, please feel free to open an issue for it.

License

The Google Places Api is open-sourced software licensed under the MIT license

vovanmix / google-places-api

Maintainers

Details