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.

Note

For more detailed information go to Sylius API RuleInterface.

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.

For more detailed information go to Sylius API ShipmentInterface.

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.

For more detailed information go to Sylius API ShipmentItemInterface.

ShippableInterface

This interface should be implemented by model representing physical object which can by stored in a shop.

Note

For more detailed information go to Sylius API ShippableInterface.

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.

For more detailed information go to Sylius API ShippingCategoryInterface.

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.

For more detailed information go to Sylius API ShippingMethodInterface.

ShippingMethodTranslationInterface

This interface should be implemented by model responsible for keeping translation for ShippingMethod name.

Note

For more detailed information go to Sylius API ShippingMethodTranslationInterface.

ShippingSubjectInterface

This interface should be implemented by any object, which needs to be evaluated by default shipping calculators and rule checkers.

Note

For more detailed information go to Sylius API ShippingSubjectInterface.

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.

Note

For more detailed information go to Sylius API CalculatorInterface.

DelegatingCalculatorInterface

This interface should be implemented by any object, which will be responsible for delegating the calculation to a correct calculator instance.

Note

For more detailed information go to Sylius API DelegatingCalculatorInterface.

CalculatorRegistryInterface

This interface should be implemented by an object, which will keep all calculators registered inside container.

Note

For more detailed information go to Sylius API CalculatorRegistryInterface.

Checker Interfaces

RuleCheckerRegistryInterface

This interface should be implemented by an service responsible for providing an information about available rule checkers.

Note

For more detailed information go to Sylius API RuleCheckerRegistryInterface.

RuleCheckerInterface

This interface should be implemented by an object, which checks if a shipping subject meets the configured requirements.

Note

For more detailed information go to Sylius API RuleCheckerInterface.

ShippingMethodEligibilityCheckerInterface

This interface should be implemented by an object, which checks if the given shipping subject is eligible for the shipping method rules.

Note

For more detailed information go to Sylius API ShippingMethodEligibilityCheckerInterface.

Processor Interfaces

ShipmentProcessorInterface

This interface should be implemented by an object, which updates shipments and shipment items states.

Note

For more detailed information go to Sylius API ShipmentProcessorInterface.

Resolver Interfaces

ShippingMethodsResolverInterface

This interface should be used to create object, which provides information about all allowed shipping methods for given shipping subject.

Note

For more detailed information go to Sylius API ShippingMethodsResolverInterface.