Files
IPB/applications/nexus/sources/Shipping/Rate.php
T
2025-12-19 05:44:59 -08:00

69 lines
1.7 KiB
PHP

<?php
/**
* @brief Shipping Rate Interface
* @author <a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
* @copyright (c) Invision Power Services, Inc.
* @license https://www.invisioncommunity.com/legal/standards/
* @package Invision Community
* @subpackage Nexus
* @since 19 Mar 2014
*/
namespace IPS\nexus\Shipping;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
exit;
}
/**
* Shipping Rate Interface
*/
interface Rate
{
/**
* Is available?
*
* @param \IPS\GeoLocation $destination Desired destination
* @param array $items Items
* @param string $currency Desired currency
* @param \IPS\nexus\Invoice|NULL $invoice The invoice
* @return bool
*/
public function isAvailable( \IPS\GeoLocation $destination, array $items, $currency, \IPS\nexus\Invoice $invoice = NULL );
/**
* Name
*
* @return string
*/
public function getName();
/**
* Price
*
* @param array $items Items
* @param string $currency Desired currency
* @param \IPS\nexus\Invoice|NULL $invoice The invoice
* @return \IPS\nexus\Money
*/
public function getPrice( array $items, $currency, \IPS\nexus\Invoice $invoice = NULL );
/**
* Tax
*
* @return \IPS\nexus\Tax|NULL
*/
public function getTax();
/**
* Estimated delivery date
*
* @param array $items Items
* @param \IPS\nexus\Invoice|NULL $invoice The invoice
* @return string
*/
public function getEstimatedDelivery( array $items, \IPS\nexus\Invoice $invoice = NULL );
}