parceltrap/parceltrap

A driver-based parcel tracking library for PHP

v1.3.1 2023-04-27 13:38 UTC

This package is auto-updated.

Last update: 2024-04-27 15:37:17 UTC


README

Latest Version on Packagist Software License Build Status Static Analysis Total Downloads Buy us a tree

A driver-based parcel tracking library for PHP

Install

Via Composer

composer require parceltrap/parceltrap

Usage

You will need to configure a default driver, along with your ParcelTrap drivers in the config/parceltrap.php file.

use ParcelTrap\ParcelTrap;

/** @var ParcelTrap $parcelTrap */
$parcelTrap = $this->app->make(ParcelTrap::class);

// Add additional drivers
$parcelTrap->extend('my_driver', function () {
    return new MyDriver();
});

// Retrieve a specific driver
$parcelTrap->driver('name');

// Call `find()` on a driver
$parcelTrap->driver('name')->find('abcdefg');

// Call `find()` on the default driver
$parcelTrap->find('abcdefg');

Using the Facade

use ParcelTrap\Facades\ParcelTrap;

// Using the default driver with the facade
ParcelTrap::find('ABCDEFG12345');

// Using a specific driver with the facade
ParcelTrap::driver('royal_mail')->find('ABCDEFG12345');

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email security@voke.dev instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

Treeware

You're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees here.

Read more about Treeware at treeware.earth.