ShippingMethodInterface.php in Commerce Shipping 8.2
Same filename in this branch
Namespace
Drupal\commerce_shipping\EntityFile
src/Entity/ShippingMethodInterface.phpView source
<?php
namespace Drupal\commerce_shipping\Entity;
use Drupal\commerce_store\Entity\EntityStoresInterface;
use Drupal\Core\Entity\ContentEntityInterface;
/**
* Defines the interface for shipping methods.
*
* Stores configuration for shipping method plugins.
* Implemented as a content entity type to allow each store to have its own
* shipping methods.
*/
interface ShippingMethodInterface extends ContentEntityInterface, EntityStoresInterface {
/**
* Gets the shipping method plugin.
*
* @return \Drupal\commerce_shipping\Plugin\Commerce\ShippingMethod\ShippingMethodInterface
* The shipping method plugin.
*/
public function getPlugin();
/**
* Gets the shipping method name.
*
* @return string
* The shipping method name.
*/
public function getName();
/**
* Sets the shipping method name.
*
* @param string $name
* The shipping method name.
*
* @return $this
*/
public function setName($name);
/**
* Gets the shipping method conditions.
*
* @return \Drupal\commerce\Plugin\Commerce\Condition\ConditionInterface[]
* The shipping method conditions.
*/
public function getConditions();
/**
* Sets the shipping method conditions.
*
* @param \Drupal\commerce\Plugin\Commerce\Condition\ConditionInterface[] $conditions
* The conditions.
*
* @return $this
*/
public function setConditions(array $conditions);
/**
* Gets the shipping method condition operator.
*
* @return string
* The condition operator. Possible values: AND, OR.
*/
public function getConditionOperator();
/**
* Sets the shipping method condition operator.
*
* @param string $condition_operator
* The condition operator.
*
* @return $this
*/
public function setConditionOperator($condition_operator);
/**
* Gets the shipping method weight.
*
* @return string
* The shipping method weight.
*/
public function getWeight();
/**
* Sets the shipping method weight.
*
* @param int $weight
* The shipping method weight.
*
* @return $this
*/
public function setWeight($weight);
/**
* Gets whether the shipping method is enabled.
*
* @return bool
* TRUE if the shipping method is enabled, FALSE otherwise.
*/
public function isEnabled();
/**
* Sets whether the shipping method is enabled.
*
* @param bool $enabled
* Whether the shipping method is enabled.
*
* @return $this
*/
public function setEnabled($enabled);
/**
* Checks whether the shipping method applies to the given shipment.
*
* Ensures that the conditions pass.
*
* @param \Drupal\commerce_shipping\Entity\ShipmentInterface $shipment
* The shipment.
*
* @return bool
* TRUE if shipping method applies, FALSE otherwise.
*/
public function applies(ShipmentInterface $shipment);
}
Interfaces
Name![]() |
Description |
---|---|
ShippingMethodInterface | Defines the interface for shipping methods. |