README

作者：Eduardo Sales

创建于：2022年9月14日

此包旨在通过使用市场提供商来标准化路由和地理编码流程。

支持提供商：Google和TomTom。

先决条件

- PHP 7.4 or above;
- Larvel 7.x or above;

安装

- Composer:    
    $ composer require eduardosp6/router-tool
    
- Publish config file:

    $ php artisan vendor:publish --provider=Eduardosp6\RouterTool\RouterToolServiceProvider --tag=config
    
- Insert your API key in config file for the provider do you will use.        

类图

Geocode - Class responsible for transforming address into geographic coordinates.

RouterTool - Class for build the routes.

Providers - Classes of providers. 

Services - Consumption classes of provider APIs.
Adapt the methods according to your project.

Hierarchy:

- RouterTool
    - Provider
        - Client

用例

地理编码

For geocoding just call the static method Geocode::exec() passing the parameters:
Full address (avoid abbreviations), neighborhood and city. 
This method sends a request to TomTom and if the neighborhood 
and city is not compatible, send it to Google. 

The return will be an array containing the latitude and longitude keys 
of the address if successful, otherwise it will be null.

$coords = Geocode::exec(
        "Av. Rio Branco, 15000 Centro, Rio de Janeiro - RJ"
        , "Centro",
        "Rio de Janeiro"
    );

路由

注意！使用Google作为提供商，在生成路线时，点的最大数量为23。

// Create a new instance
$routerTool = new RouterTool();

// Define the provider. Available: TomTomAPI or GoogleAPI
$routerTool->setProvider(new TomTomAPI());

// Routing calc:
// params: route data array, expected exit date (Carbon instance), routing mode
// mode param:
// normal - Normal mode (keeps the given sequence of deliveries)
// optimized - Optimized mode (Edit the sequence of deliveries for better performance, ditance and duration).

// returns: the same array sent as parameter but filled with routing data.

// Example: 

// route array structure
$route = [
    'distance_total' => 0.0,
    'duration_total'=> 0.0,
    'start_point' => [
        'id' => '1',
        'latitude' => 22.3489343,
        'longitude' => 43.998509
    ],
    'steps' => [
        [
            'id' => 112,
            'order' => 1,
            'type' => 'delivery', // accepted values: delivery, collect, deposit
            'latitude' => 22.834783,
            'longitude' => 43.48729,
            'address' => '',
            'number' => null,
            'district' => '',
            'city' => '',
            'uf' => '',
            'date_arrival' => '',
            'time_arrival' => '',
            'time_service' => '',
            'time_course' => '',
            'distance' => 0,
        ]
    ]
]

$result = $routerTool->performRouting($route, $exitDate);
          
dump($result);