class USPSInternational in Commerce USPS 8

Provides the USPS international shipping method.

Plugin annotation


@CommerceShippingMethod(
 id = "usps_international",
 label = @Translation("USPS International"),
 services = {
   "_1" = @translation("Priority Mail Express International"),
   "_2" = @translation("Priority Mail International"),
   "_4" = @translation("Global Express Guaranteed (GXG)"),
   "_5" = @translation("Global Express Guaranteed Document"),
   "_6" = @translation("Global Express Guaranteed Non-Document Rectangular"),
   "_7" = @translation("Global Express Guaranteed Non-Document Non-Rectangular"),
   "_8" = @translation("Priority Mail International Flat Rate Envelope"),
   "_9" = @translation("Priority Mail International Medium Flat Rate Box"),
   "_10" = @translation("Priority Mail Express International Flat Rate Envelope"),
   "_11" = @translation("Priority Mail International Large Flat Rate Box"),
   "_12" = @translation("USPS GXG Envelopes"),
   "_13" = @translation("First-Class Mail International Letter"),
   "_14" = @translation("First-Class Mail International Large Envelope"),
   "_15" = @translation("First-Class Package International Service"),
   "_16" = @translation("Priority Mail International Small Flat Rate Box"),
   "_17" = @translation("Priority Mail Express International Legal Flat Rate Envelope"),
   "_18" = @translation("Priority Mail International Gift Card Flat Rate Envelope"),
   "_19" = @translation("Priority Mail International Window Flat Rate Envelope"),
   "_20" = @translation("Priority Mail International Small Flat Rate Envelope"),
   "_21" = @translation("First-Class Mail International Postcard"),
   "_22" = @translation("Priority Mail International Legal Flat Rate Envelope"),
   "_23" = @translation("Priority Mail International Padded Flat Rate Envelope"),
   "_24" = @translation("Priority Mail International DVD Flat Rate priced box"),
   "_25" = @translation("Priority Mail International Large Video Flat Rate priced box"),
   "_26" = @translation("Priority Mail Express International Flat Rate Boxes"),
   "_27" = @translation("Priority Mail Express International Padded Flat Rate Envelope"),
 }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\commerce_shipping\Plugin\Commerce\ShippingMethod\ShippingMethodBase implements ShippingMethodInterface, ContainerFactoryPluginInterface
    class \Drupal\commerce_usps\Plugin\Commerce\ShippingMethod\USPSBase implements SupportsTrackingInterface
    class \Drupal\commerce_usps\Plugin\Commerce\ShippingMethod\USPSInternational

Expanded class hierarchy of USPSInternational

File

src/Plugin/Commerce/ShippingMethod/USPSInternational.php, line 44

Namespace

Drupal\commerce_usps\Plugin\Commerce\ShippingMethod

View source

class USPSInternational extends USPSBase {

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('plugin.manager.commerce_package_type'), $container
      ->get('plugin.manager.workflow'), $container
      ->get('commerce_usps.usps_rate_request_international'));
  }

  /**
   * {@inheritdoc}
   */
  public function calculateRates(ShipmentInterface $shipment) {

    // Only attempt to collect rates if an address exists on the shipment.
    if ($shipment
      ->getShippingProfile()
      ->get('address')
      ->isEmpty()) {
      return [];
    }

    // Do not attempt to collect rates for US addresses.
    if ($shipment
      ->getShippingProfile()
      ->get('address')->country_code == 'US') {
      return [];
    }

    // Make sure a package type is set on the shipment.
    $this
      ->setPackageType($shipment);
    return $this->uspsRateService
      ->getRates($shipment, $this->parentEntity);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
ShippingMethodBase::$packageTypeManager	protected	property	The package type manager.
ShippingMethodBase::$parentEntity	protected	property	The parent config entity.
ShippingMethodBase::$services	protected	property	The shipping services.
ShippingMethodBase::$workflowManager	protected	property	The workflow manager.
ShippingMethodBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ShippingMethodBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ShippingMethodBase::getDefaultPackageType	public	function	Gets the default package type. Overrides ShippingMethodInterface::getDefaultPackageType
ShippingMethodBase::getLabel	public	function	Gets the shipping method label. Overrides ShippingMethodInterface::getLabel
ShippingMethodBase::getServices	public	function	Gets the shipping services. Overrides ShippingMethodInterface::getServices
ShippingMethodBase::getWorkflowId	public	function	Gets the shipment workflow ID. Overrides ShippingMethodInterface::getWorkflowId
ShippingMethodBase::selectRate	public	function	Selects the given shipping rate for the given shipment. Overrides ShippingMethodInterface::selectRate
ShippingMethodBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ShippingMethodBase::setParentEntity	public	function	Sets the parent entity. Overrides ParentEntityAwareInterface::setParentEntity
ShippingMethodBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
USPSBase::$uspsRateService	protected	property	The USPSRateRequest class.
USPSBase::buildConfigurationForm	public	function	Form constructor. Overrides ShippingMethodBase::buildConfigurationForm
USPSBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ShippingMethodBase::defaultConfiguration
USPSBase::getTrackingUrl	public	function	Returns a tracking URL for USPS shipments. Overrides SupportsTrackingInterface::getTrackingUrl
USPSBase::isConfigured	protected	function	Determine if we have the minimum information to connect to USPS.
USPSBase::preparePluginDefinition	private	function	Prepares the service array keys to support integer values.
USPSBase::setPackageType	protected	function	Ensure a package type exists on the shipment.
USPSBase::submitConfigurationForm	public	function	Form submission handler. Overrides ShippingMethodBase::submitConfigurationForm
USPSBase::__construct	public	function	Constructs a new ShippingMethodBase object. Overrides ShippingMethodBase::__construct
USPSInternational::calculateRates	public	function	Calculates rates for the given shipment. Overrides ShippingMethodInterface::calculateRates
USPSInternational::create	public static	function	Creates an instance of the plugin. Overrides USPSBase::create

You are here

class USPSInternational in Commerce USPS 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation