webstack/vroom-php

Vroom PHP

v3.0.0 2024-07-15 19:36 UTC

Requires

• php: ^8.2
• ext-json: *
• phpdocumentor/reflection-docblock: ^5.3
• symfony/debug-bundle: ^6.4|^7.0
• symfony/http-client: ^6.4|^7.0
• symfony/property-access: ^6.4|^7.0
• symfony/property-info: ^6.4|^7.0
• symfony/serializer: ^6.4|^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.15
• phpstan/phpstan: ^1.8.7
• phpunit/phpunit: ^9.5|^10.0
• symfony/var-dumper: ^6.4|^7.0

MIT

• Marco Wansinck

• VROOM

README

This package provides a PHP client for the VROOM API that implements the VROOM API structure while providing a Object Oriented way to communicate with it.

Getting started

Below is a simple example based on one vehicle having one job.

<?php

use Webstack\Vroom\Connection;
use Webstack\Vroom\Resource\Job;
use Webstack\Vroom\Resource\Location;
use Webstack\Vroom\Resource\Options;
use Webstack\Vroom\Resource\Problem;
use Webstack\Vroom\Resource\Vehicle;

$problem = new Problem();

$vehicle = new Vehicle();
$vehicle->setId(1);
$vehicle->setStart(new Location(4.6311356, 52.1284105));
$vehicle->setEnd(new Location(4.6311356, 52.1284105));
$vehicle->setCapacity([500]);
$vehicle->setSkills([1]);

$problem->addVehicle($vehicle);

$job = new Job();
$job->setId(999);
$job->setDescription('Example job');
$job->setLocation(new Location(4.65546, 52.12917));
$job->setSkills([1]);

$problem->addJob($job);

$connection = new Connection('http://vroom:3000');
$solution = $connection->compute($problem);

print '<pre>';
print_r($solution);
print '</pre>';

Tests

composer install
vendor/bin/phpunit

Issues

Feel free to submit any issues or enhancements.