Download the PHP package flarone/google-places-api without Composer
On this page you can find all versions of the php package flarone/google-places-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download flarone/google-places-api
More information about flarone/google-places-api
Files in flarone/google-places-api
Informations about the package google-places-api
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 This service gives a list of places based on a user's location or search string.
- Place Details This service gives more detailed information about a specific Place, including user reviews.
- Place Autocomplete This service is Used to automatically fill in the name and/or address of a place as you type.
- Query Autocomplete This service is Used to provide a query prediction service for text-based geographic searches, by returning suggested queries as you type.
- Place Photo This gives you access to the millions of photos stored in the Google's Places database
- Custom Headers Set Custom Headers.
- Additional Methods Additional Methods Available.
Installation
Install it with composer
Usage
Laravel user can see the Laravel Usage section
Step 1 - Import the class using namespace
Step 2 - Initiate the object
Note: You can also set the API KEY after initiating the class using setKey('KEY')
method. You can chain this with method with any other methods.
Step 3 - Start Using the Api.
Example:
As mentioned earlier just 2 lines of code to make any request.
Full example:
Use with Laravel
For Laravel 5.5 and up
Auto Discovery added.
For Laravel 5.4 and below
Step 1
Set up the service provider and facade in the config\app.php
Step 2
publish the config file with following artisan command
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
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 Collection 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 ifrankby=distance
(described under Optional parameters below) is specified. - If
rankby=distance
(described under Optional parameters below) is specified, then one or more ofkeyword
,name
, ortypes
is required. params
- Optional Parameters You can refer all the available 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
- Optional Parameters You can refer all the available optional parameters on the Google's Official Webpage
findPlace($input, $inputType, $params = [])
input
— The text input specifying which place to search for (for example, a name, address, or phone number).inputType
— The type of input. This can be one of either textquery or phonenumber. Phone numbers must be in international format (prefixed by a plus sign ("+"), followed by the country code, then the phone number itself).params
- Optional Parameters You can refer all the available optional parameters on the Google's Official Webpage
Place Details
placeDetails($placeId, $params = [])
placeId
— A textual identifier that uniquely identifies a place, returned from a Place Search.params
- Optional Parameters You can refer all the available 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
- Optional Parameters You can refer all the available 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
- Optional Parameters You can refer all the available optional parameters on the Google's Official Webpage
Place Photo
photo($photoReference, $params = [])
params
- The set of key-value parameters necessary to add a place to Google. You can refer to the fields on Google's Official Webpage regarding Place Add
Custom Headers
withHeaders(array $headers)
Call This method before any other methods to set the headers. You can chain this method.
new PlacesApi($key = null, $verifySSL = true, array $headers = [])
To have custom headers set for every call, you can pass 3rd parameter as the headers to class constructor.
Note: For Laravel Users, you can set this in config file with key headers
Additional Methods
getStatus()
This will return the status of the response send by google api. Use it after making any request.
getKey()
This will return the API KEY
been used with the requests.
setKey($key)
This will set the API KEY
.
verifySSL($verifySSL = true)
You can pass false
to disable Verification of SSL Certification.
Note: For Laravel Users, you can set this in config file with key verify_ssl
Or You can Pass the path to the certificate.
Exceptions
Google Places API may throw various exceptions based on the given $params
or response and is located in the Flarone\GoogleApi\Exceptions
namespace.
- A
GooglePlacesApiException
is thrown when noAPI KEY
is provided or$params
is invalid. Note: This is the parent class for the preceding exceptions. - A
InvalidRequestException
is thrown when the responsestatus
isINVALID_REQUEST
- A
OverQueryLimitException
is thrown when the responsestatus
isOVER_QUERY_LIMIT
- A
RequestDeniedException
is thrown when the responsestatus
isREQUEST_DENIED
- A
UnknownErrorException
is thrown when the responsestatus
isUNKNOWN_ERROR
- A
NotImplementedException
is thrown when the response cannot be determined.
If any of these exception has been thrown, you can use the getErrorMessage()
method to get the error_message
field from the response if any is provided.
Note: error_message
field is not guaranteed to be always present, and its content is subject to change.
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
This Google Places Api was forked from skagarwal/google-places-api
.
The Google Places Api is open-sourced software licensed under the MIT license
All versions of google-places-api with dependencies
illuminate/support Version ^6.0|^7.0|^8.0|^9.0|^10.0
illuminate/container Version ^6.0|^7.0|^8.0|^9.0|^10.0
guzzlehttp/guzzle Version ^6.5.7|^7.4.4