damienharper/navigation-bundle

Provides routing, distance matrix features etc from different providers

Installs: 5 053

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 1

Forks: 1

Open Issues: 0

Type:symfony-bundle

0.5.0 2020-11-09 09:31 UTC

This package is auto-updated.

Last update: 2021-10-09 11:32:56 UTC


README

Latest Stable Version Latest Unstable Version Build Status License Maintainability Test Coverage Scrutinizer Code Quality
Total Downloads Monthly Downloads Daily Downloads

This bundle provides navigation features such as routing, distance matrix etc. It relies on providers to provide such features. Included providers are:

Installation

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

composer require damienharper/navigation-bundle

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

composer require damienharper/navigation-bundle

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the app/AppKernel.php file of your project:

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new DH\NavigationBundle\DHNavigationBundle(),
        );

        // ...
    }

    // ...
}

Configuration

Providers

Credentials for providers (API tokens/keys) have to be defined in the dh_navigation.yaml configuration file.

// config/packages/dh_navigation.yaml
dh_navigation:
    providers:
        here:
            factory: DH\NavigationBundle\Provider\Here\HereFactory
            options:
                app_id: "HERE_APP_ID"
                app_code: "HERE_APP_CODE"
                use_cit: false
        google_maps:
            factory: DH\NavigationBundle\Provider\GoogleMaps\GoogleMapsFactory
            options:
                api_key: "GOOGLE_MAPS_TOKEN"

Usage

sample code here

Contributing

NavigationBundle is an open source project. Contributions made by the community are welcome. Send us your ideas, code reviews, pull requests and feature requests to help us improve this project.

Do not forget to provide unit tests when contributing to this project. To do so, follow instructions in this dedicated README

License

NavigationBundle is free to use and is licensed under the MIT license