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

OrderInterface

This interface should be implemented by model representing a single Order.

Hint

It also contains the default State Machine.

Note

This interface extends TimestampableInterface, TimestampableInterface, AdjustableInterface and CommentAwareInterface

OrderAwareInterface

This interface provides basic operations for order management. If you want to have orders in your model just implement this interface.

OrderItemInterface

This interface should be implemented by model representing a single OrderItem.

Note

This interface extends the OrderAwareInterface and the AdjustableInterface,

OrderItemUnitInterface

This interface should be implemented by model representing a single OrderItemUnit.

Note

This interface extends the AdjustableInterface,

AdjustmentInterface

This interface should be implemented by model representing a single Adjustment.

Note

This interface extends the TimestampableInterface.

AdjustableInterface

This interface provides basic operations for adjustment management. Use this interface if you want to make a model adjustable.

For example following models implement this interface:

• Order
• OrderItem

CommentInterface

This interface should be implemented by model representing a single Comment.

Note

This interface extends the TimestampableInterface

CommentAwareInterface

This interface provides basic operations for comments management. If you want to have comments in your model just implement this interface.

IdentityInterface

This interface should be implemented by model representing a single Identity. It can be used for storing external identifications.

Services Interfaces

OrderRepositoryInterface

In order to decouple from storage that provides recently completed orders or check if given order’s number is already used, you should create repository class which implements this interface.

Note

This interface extends the RepositoryInterface.