puwnz/google-maps-bundle

Bundle Symfony to use Google Maps Lib

1.3.0 2024-09-11 21:02 UTC

Requires

• php: >=7.3
• puwnz/google-maps-lib: ^1.0
• symfony/config: ^4.4|^5.0
• symfony/dependency-injection: ^4.4|^5.0
• symfony/http-kernel: ^4.4|^5.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• phpunit/phpunit: ^9.0

MIT

• Guillaume D.

• symfony
• bundle
• map
• google
• maps
• vendor

README

Overview

The Google Maps Lib project provides a Google Map Lib integration for you Symfony 4+ and PHP 7.3+ project. At this time, just geocode is enable in this lib, because my needs is only on this part, but you can open issues to push your needs.

Installation

To install this lib you can just use composer :

composer require puwnz/google-maps-bundle

Integration

Bundle registration

<?php
// config/bundles.php

return [
    Puwnz\GoogleMapsBundle\GoogleMapsBundle::class => ['all' => true]
];

Config integration

You can just add GOOGLE_API_KEY a var env in you application to set configuration.

Configuration by default :

# config/packages/google_maps.yaml
google_maps:
    api_key: '%env(GOOGLE_API_KEY)%'

Example

To use this package on your symfony project, you can use than the next example :

<?php

namespace App\Controller;

use Puwnz\GoogleMapsBundle\Service\GoogleService;
use Puwnz\GoogleMapsLib\Geocode\DTO\GeocodeResult;

class FooService  {

    /** @var GoogleService */
    private $googleService;

    public function __construct(GoogleService $geocodeService) {
        $this->googleService = $geocodeService;
    }
    
    /**
    * @return GeocodeResult[]
    */
    public function getGeocodeResult(string $address) : array
    {
        return $this->googleService->geocode($address);
    }
}

Use custom cache pool

You can use a specific cache pool for this lib. Just add in your cache framework configuration a new pool like this :

# config/packages/cache.yaml
framework:
  cache:
    pools:
      google_maps:
        adapter: 'cache.adapter.redis' # this example use redis

Testing

The bundle is fully unit tested by PHPUnit with a code coverage close to 100%.

Contribute

We love contributors! This is an open source project. If you'd like to contribute, feel free to propose a PR!

License

The Google Map Lib is under the MIT license. For the full copyright and license information, please read the LICENSE file that was distributed with this source code.