markenwerk/google-places-suite

A PHP library to query Google's Places service for querying locations and addresses and getting details by Places ID.

Monday, August 8, 2016
by bonscho
Repository
1 Watchers
0 Stars
11 Installations

PHP
0 Dependents
1 Suggesters
0 Forks
1 Open issues
10 Versions
22 % Grown

The README.md

PHP Google Places Suite

, _(*1)

A PHP library to query Google's Places service for querying locations and addresses and getting details by Places ID., _(*2)

Installation

```{json} { "require": { "markenwerk/google-places-suite": "~3.0" } }, _(*3)


## Usage

### Autoloading and namesapce

```{php}  
require_once('path/to/vendor/autoload.php');

Performing a Google Places Query

Getting detail information about a known Google Places ID

```{php}, _(*4)

use Markenwerk\CommonException;, _(*5)

try{ // Perform query $googlePlacesDetailQuery = new GooglePlacesDetailQuery(); $googlePlacesDetailQuery ->setApiKey($this->googlePlacesApiKey) ->query('GOOGLE_PLACES_ID');, _(*6)

// Retrieving the query result as Markenwerk\GooglePlacesSuite\GooglePlacesDetailResult instance
$queryResult = $googlePlacesDetailQuery->getResult();

} catch (CommonException\NetworkException\CurlException) { // Google Places service is not reachable or curl failed } catch (CommonException\ApiException\InvalidResponseException $exception) { // Google Places service invalid response } catch (CommonException\ApiException\RequestQuotaException $exception) { // Google Places service requests over the allowed limit } catch (Markenwerk\CommonException\ApiException\AuthenticationException $exception) { // Google Places service API key invalid } catch (CommonException\ApiException\NoResultException $exception) { // Google places service query had no result }, _(*7)


---

### Reading from a GooglePlacesDetailResult

**Attention:** Plaese note that all getter methods on the `GeoLocationAddress` return a `GeoLocationAddressComponent` instance or `null`. For preventing calls on non-objects the `GeoLocationAddress` class provides methods to check whether the address components exists. 

```{php}
// Retrieving the query result as Markenwerk\GooglePlacesSuite\GooglePlacesDetailResult instance
$queryResult = $googlePlacesDetailQuery->getResult();

// Retieving address information as Markenwerk\GoogleDataStructure\GeoLocation\GeoLocationAddress
if($queryResult->hasAddress()) {

    if ($queryResult->getAddress()->hasStreetName()) {
        // Returns 'Lornsenstraße'
        $addressStreetShort = $queryResult->getAddress()->getStreetName()->getShortName();
        // Returns 'Lornsenstraße'
        $addressStreetLong = $queryResult->getAddress()->getStreetName()->getLongName();
    }

    if ($queryResult->getAddress()->hasStreetNumber()) {
        // Returns '43'
        $addressStreetNumberShort = $queryResult->getAddress()->getStreetNumber()->getShortName();
        // Returns '43'
        $addressStreetNumberLong = $queryResult->getAddress()->getStreetNumber()->getLongName();
    }

    if ($queryResult->getAddress()->hasPostalCode()) {
        // Returns '24105'
        $addressPostalCodeShort = $queryResult->getAddress()->getPostalCode()->getShortName();
        // Returns '24105'
        $addressPostalCodeLong = $queryResult->getAddress()->getPostalCode()->getLongName();
    }

    if ($queryResult->getAddress()->hasCity()) {
        // Returns 'KI'
        $addressCityShort = $queryResult->getAddress()->getCity()->getShortName();
        // Returns 'Kiel'
        $addressCityLong = $queryResult->getAddress()->getCity()->getLongName();
    }

    if ($queryResult->getAddress()->hasArea()) {
        // Returns 'Ravensberg - Brunswik - Düsternbrook'
        $addressAreaShort = $queryResult->getAddress()->getArea()->getShortName();
        // Returns 'Ravensberg - Brunswik - Düsternbrook'
        $addressAreaLong = $queryResult->getAddress()->getArea()->getLongName();
    }

    if ($queryResult->getAddress()->hasProvince()) {
        // Returns 'SH'
        $addressProvinceShort = $queryResult->getAddress()->getProvince()->getShortName();
        // Returns 'Schleswig-Holstein'
        $addressProvinceLong = $queryResult->getAddress()->getProvince()->getLongName();
    }

    if ($queryResult->getAddress()->hasCountry()) {
        // Returns 'DE'
        $addressCountryShort = $queryResult->getAddress()->getCountry()->getShortName();
        // Returns 'Germany'
        $addressCountryLong = $queryResult->getAddress()->getCountry()->getLongName();
    }

}

// Retieving address information as Markenwerk\GoogleDataStructure\GeoLocation\GeoLocationGeometry
if ($queryResult->hasGeometry()) {

    if ($queryResult->getGeometry()->hasLocation()) {
        // Returns 54.334123
        $geometryLocationLatitude = $queryResult->getGeometry()->getLocation()->getLatitude();
        // Returns 10.1364007
        $geometryLocationLatitude = $queryResult->getGeometry()->getLocation()->getLongitude();
    }

    if ($queryResult->getGeometry()->hasViewport()) {
        // Returns 54.335471980291
        $geometryLocationLatitude = $queryResult->getGeometry()->getViewport()->getNortheast()->getLatitude();
        // Returns 10.137749680292
        $geometryLocationLatitude = $queryResult->getGeometry()->getViewport()->getNortheast()->getLongitude();
        // Returns 54.332774019708
        $geometryLocationLatitude = $queryResult->getGeometry()->getViewport()->getSouthwest()->getLatitude();
        // Returns 10.135051719708
        $geometryLocationLatitude = $queryResult->getGeometry()->getViewport()->getSouthwest()->getLongitude();
    }

    if ($queryResult->getGeometry()->hasAccessPoints()) {
        for ($i = 0; $i < $queryResult->getGeometry()->countAccessPoints(); $i++) {
            // Returns 54.335471980291
            $geometryAccessPointLatitude = $queryResult->getGeometry()->getAccessPointAt($i)->getLatitude();
            // Returns 10.137749680292
            $geometryAccessPointLatitude = $queryResult->getGeometry()->getAccessPointAt($i)->getLongitude();
        }
    }

}

if ($queryResult->hasGooglePlacesId()) {
    // Retrieving the Google Places information from the query result
    // Returns 'ChIJ_zNzWmpWskcRP8DWT5eX5jQ'
    $googlePlacesId = $queryResult->getGooglePlacesId();
}

Exception handling

PHP Google Places Suite provides different exceptions provided by the PHP Common Exceptions project for proper handling.
You can find more information about PHP Common Exceptions at Github., _(*8)

Contribution

Contributing to our projects is always very appreciated.
But: please follow the contribution guidelines written down in the CONTRIBUTING.md document., _(*9)