Shipment Method Plugins

For each availability plugin linked to a shipment method, a class with the same name must exist on the project side in the Shipment module(Pyz/Zed/Shipment/Communication/Plugin/Availability).

The class must implement ShipmentMethodAvailabilityPluginInterface and must extend AbstractPlugin class, as in the example below :

<?php
namespace Pyz\Zed\Shipment\Communication\Plugin\Availability;
						
use Generated\Shared\Transfer\QuoteTransfer;
use Generated\Shared\Transfer\ShipmentGroupTransfer;
use Spryker\Zed\Kernel\Communication\AbstractPlugin;
use Spryker\Zed\ShipmentExtension\Dependency\Plugin\ShipmentMethodAvailabilityPluginInterface;
class DHLExpressPlugin extends AbstractPlugin implements ShipmentMethodAvailabilityPluginInterface
{
	/**
	* Specification:
	*  - Checks shipment method availability for shipment group.
	*
	* @api
	*
	* @param \Generated\Shared\Transfer\ShipmentGroupTransfer $shipmentGroupTransfer
	* @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer
	*
	* @return bool
	*/
	public function isAvailable(ShipmentGroupTransfer $shipmentGroupTransfer, QuoteTransfer $quoteTransfer): bool
	{
		return true;
	}
}

For each price calculation plugin linked to a shipment method, a class with the same name must exist on the project side in the Shipment module (Pyz/Zed/Shipment/Communication/Plugin/PriceCalculation). The class must implement ShipmentMethodPricePluginInterface and must extend AbstractPlugin class, as in the example below :

<?php
namespace Pyz\Zed\Shipment\Communication\Plugin\PriceCalculation;
						
use Generated\Shared\Transfer\QuoteTransfer;
use Generated\Shared\Transfer\ShipmentGroupTransfer;
use Spryker\Zed\Kernel\Communication\AbstractPlugin;
use Spryker\Zed\ShipmentExtension\Dependency\Plugin\ShipmentMethodPricePluginInterface;
class DHLExpressPlugin extends AbstractPlugin implements ShipmentMethodPricePluginInterface
{
	/**
	* Specification:
	*  - Returns shipment method price for shipment group.
	*
	* @api
	*
	* @param \Generated\Shared\Transfer\ShipmentGroupTransfer $shipmentGroupTransfer
	* @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer
	*
	* @return int
	*/
	public function getPrice(ShipmentGroupTransfer $shipmentGroupTransfer, QuoteTransfer $quoteTransfer): int
	{
		return 0;
	}
}

For each availability plugin linked to a shipment method, a class with the same name must exist on the project side in the Shipment module (Pyz/Zed/Shipment/Communication/Plugin/DeliveryTime). The class must implement ShipmentMethodDeliveryTimePluginInterface and must extend AbstractPlugin class, as in the example below :

<?php
namespace Pyz\Zed\Shipment\Communication\Plugin\DeliveryTime;
						
use Generated\Shared\Transfer\QuoteTransfer;
use Generated\Shared\Transfer\ShipmentGroupTransfer;
use Spryker\Zed\Kernel\Communication\AbstractPlugin;
use Spryker\Zed\ShipmentExtension\Dependency\Plugin\ShipmentMethodDeliveryTimePluginInterface;
class DHLExpressPlugin extends AbstractPlugin implements ShipmentMethodDeliveryTimePluginInterface
{
	/**
	* Specification:
	*  - Returns delivery time for shipment group.
	*
	* @param \Generated\Shared\Transfer\ShipmentGroupTransfer $shipmentGroupTransfer
	* @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer
	*
	* @return int
	* @api
	*
	*/
	public function getTime(ShipmentGroupTransfer $shipmentGroupTransfer, QuoteTransfer $quoteTransfer): int
	{
		return 0;
	}
}

The plugins must be registered in ShipmentDependencyProvider, by overriding the following 3 operations :

<?php
/**
 * @param Container $container
 *
 * @return array
 */
protected function getAvailabilityPlugins(Container $container)
{
    return [
        'Plugin name visible in form' => new YourAvailabilityPlugin(),
    ];
}
 
/**
 * @param Container $container
 *
 * @return array
 */
protected function getPricePlugins(Container $container)
{
    return [
        'Plugin name visible in form' => new YourPricePlugin(),
    ];
}
 
/**
 * @param Container $container
 *
 * @return array
 */
protected function getDeliveryTimePlugins(Container $container)
{
    return [
        'Plugin name visible in form' => new YourDeliveryTimePlugin(),
    ];
}