Google Places API Library
, (*1)
Extension library to interact with Google Places API, (*2)
Installation
The preferred way to install this extension is through composer., (*3)
Either run, (*4)
$ composer require 2amigos/google-places-library
or add, (*5)
"2amigos/google-places-library": "*"
to the require section of your composer.json file., (*6)
Usage
Using SearchClient class:, (*7)
use Da\Google\Places\Client\SearchClient
$search = new SearchClient('{YOURGOOGLEAPIKEY}');
// $search->forceJsonArrayResponse(); // if you want to get arrays instead of objects
// $search = new SearchClient('{YOURGOOGLEAPIKEY}', 'xml'); // if you wish to handle XML responses (JSON is highly recommended)
// If you setup the format in 'xml', the returned value will be an array.
// The library will decode the response automatically
var_dump($search->text('restaurants in Inca Mallorca'));
Using PlaceClient class:, (*8)
use Da\Google\Places\Client\PlaceClient
$place = new PlaceClient('{YOURGOOGLEAPIKEY}');
// $place = new PlaceClient('{YOURGOOGLEAPIKEY}', 'xml'); // if you wish to handle XML responses (JSON is highly recommended)
$place->details('{REFERENCEIDOFPLACE}'));
For further information regarding the multiple parameters of Google Places please visit
its API reference, (*9)
Contributing
Please see CONTRIBUTING for details., (*10)
Clean code
We have added some development tools for you to contribute to the library with clean code:, (*11)
- PHP mess detector: Takes a given PHP source code base and look for several potential problems within that source.
- PHP code sniffer: Tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.
- PHP code fixer: Analyzes some PHP source code and tries to fix coding standards issues.
And you should use them in that order., (*12)
Using php mess detector
Sample with all options available:, (*13)
./vendor/bin/phpmd ./src text codesize,unusedcode,naming,design,controversial,cleancode
Using code sniffer
./vendor/bin/phpcs -s --report=source --standard=PSR2 ./src
Using code fixer
We have added a PHP code fixer to standardize our code. It includes Symfony, PSR2 and some contributors rules., (*14)
./vendor/bin/php-cs-fixer fix ./src
Testing
bash
$ ./vendor/bin/phpunit, (*15)
Credits
License
The BSD License (BSD). Please see License File for more information., (*16)
Custom Software Development | Web & Mobile Development Software
www.2amigos.us
Wallogit.com
