Installation

Using Composer

Installing the plugin via Composer is as straightforward as with any other CakePHP plugin. Run this in your project folder:

composer require dereuromark/cakephp-geo

Details are on Packagist.

Load the plugin

bin/cake plugin load Geo

Optional packages

Depending on which tools you use (for example geocoding), you might need additional packages.

For using Google Maps as a concrete adapter, you might also need:

"geocoder-php/provider-implementation": "^1.0",
"geocoder-php/google-maps-provider": "^4.4.0",

Alternative compatible packages can be found on Packagist.

TIP

Most providers need an API key to work. See the Geocoder behavior and Geocoder class pages for how to select and configure a provider.

Database setup

Some features — such as the GeocodedAddresses cache — rely on a database table. Set it up with the official migrations plugin for CakePHP:

bin/cake migrations migrate -p Geo

Next steps

• Geocoder behavior — geocode entity data on save.
• Map helpers — render maps in your views.
• GeocodedAddresses cache — cache geocoding API calls.