germania-kg/tracking

1.1.0 2023-01-04 07:39 UTC

Requires

• php: ^7.4|^8.0

Requires (Dev)

• php-coveralls/php-coveralls: ^2.0
• phpspec/prophecy: ^1.16
• phpstan/phpstan: ^1.9
• phpunit/phpunit: ^8.0|^9.0

MIT

• Carsten Witt

README

Classes, interfaces and traits for dealing with shipment tracking information

Installation with Composer

$ composer require germania-kg/tracking

Usage

Interfaces and Traits

TrackingInfoInterface

The TrackingInfoInterface provides two methods, getTrackingID and getTrackingLink.

TrackingInfoProviderInterface

The TrackingInfoProviderInterface provides a getTrackingInfo method which returns TrackingInfoInterface or null.

TrackingInfoProviderTrait

The TrackingInfoProviderTrait introduces a public property $tracking_info and a public method getTrackingInfo which fulfills the TrackingInfoProviderInterface.

TrackingInfoAwareInterface

The TrackingInfoAwareInterface extends TrackingInfoProviderInterface and provides a setTrackingInfo method which accepts TrackingInfoInterface.

TrackingInfoProviderTrait

The TrackingInfoProviderTrait uses TrackingInfoProviderTrait and additionally provides setTrackingInfo a public setTrackingInfo method which fulfills the TrackingInfoAwareInterface.

Classes

TrackingInfo class

The TrackingInfo class extends TrackingInfoAbstract which implements TrackingInfoInterface. It additionally provides setter methods setTrackingID and setTrackingLink:

<?php
use Germania\Tracking\TrackingInfo;

$ti = new TrackingInfo;
$ti->setTrackingID( "123456" );
$ti->setTrackingLink( "https://parcels.test.com?id=123456" );

echo $ti->getTrackingID();   // "123456"
echo $ti->getTrackingLink(); // "https://parcels.test.com?id=123456"

TrackingInfo fulfills also TrackingInfoProviderInterface, since its getTrackingInfo method returns itself. The class also implements JsonSerializable:

$ti = new TrackingInfo;
$ti->setTrackingID( "123456" );
$ti->setTrackingLink( "https://parcels.test.com?id=123456" );

// As array:
$array = $ti->jsonSerialize();
echo $array['id'];   // "123456"
echo $array['href']; // "https://parcels.test.com?id=123456"

// StdClass:
$encoded = json_encode( $ti );
$decoded = json_decode( $encoded );

echo $decoded->id;   // "123456"
echo $decoded->href; // "https://parcels.test.com?id=123456"

Development

$ git clone https://github.com/GermaniaKG/Tracking.git
$ cd Tracking
$ composer install

Unit tests

Either copy phpunit.xml.dist to phpunit.xml and adapt to your needs, or leave as is. Run PhpUnit test or composer scripts like this:

$ composer test
# or
$ vendor/bin/phpunit