Interfaces¶
Danger
We’re sorry but this documentation section is outdated. Please have that in mind when trying to use it. You can help us making documentation up to date via Sylius Github. Thank you!
Model Interfaces¶
RuleInterface¶
This interface should be implemented by class which will provide additional restriction for ShippingMethod.
ShipmentInterface¶
This interface should be implemented by class which will provide information about shipment like: state, shipping method and so on. It also has a method for shipment tracking.
Note
This interface extends the ShippingSubjectInterface.
ShipmentItemInterface¶
This interface is implemented by class responsible for connecting shippable object with proper shipment. It also provides information about shipment state.
Note
This interface extends the ShippingSubjectInterface.
ShippableInterface¶
This interface should be implemented by model representing physical object which can by stored in a shop.
ShippingCategoryInterface¶
This interface should be implemented by model representing a shipping category and it is required if you want to classify shipments and connect it with right shipment method.
Note
This interface extends the CodeAwareInterface and TimestampableInterface.
ShippingMethodInterface¶
This interface provides default requirements for system of matching shipping methods with shipments based on ShippingCategory and allows to add a new restriction to a basic shipping method.
Note
This interface extends the CodeAwareInterface, TimestampableInterface and ShippingMethodTranslationInterface.
ShippingMethodTranslationInterface¶
This interface should be implemented by model responsible for keeping translation for ShippingMethod name.
ShippingSubjectInterface¶
This interface should be implemented by any object, which needs to be evaluated by default shipping calculators and rule checkers.
Calculator interfaces¶
CalculatorInterface¶
This interface provides basic methods for calculators. Every custom calculator should implement CalculatorInterface or extends class Calculator, which has a basic implementation of methods from this interface.
DelegatingCalculatorInterface¶
This interface should be implemented by any object, which will be responsible for delegating the calculation to a correct calculator instance.
CalculatorRegistryInterface¶
This interface should be implemented by an object, which will keep all calculators registered inside container.
Checker Interfaces¶
RuleCheckerRegistryInterface¶
This interface should be implemented by an service responsible for providing an information about available rule checkers.
RuleCheckerInterface¶
This interface should be implemented by an object, which checks if a shipping subject meets the configured requirements.
ShippingMethodEligibilityCheckerInterface¶
This interface should be implemented by an object, which checks if the given shipping subject is eligible for the shipping method rules.