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

For more detailed information go to Sylius API OrderInterface.

OrderAwareInterface

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

Note

For more detailed information go to Sylius API OrderAwareInterface.

OrderItemInterface

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

Note

This interface extends the OrderAwareInterface and the AdjustableInterface,

For more detailed information go to Sylius API OrderItemInterface.

OrderItemUnitInterface

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

Note

This interface extends the AdjustableInterface,

For more detailed information go to Sylius API OrderItemUnitInterface.

AdjustmentInterface

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

Note

This interface extends the TimestampableInterface.

For more detailed information go to Sylius API AdjustmentInterface.

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

Note

For more detailed information go to Sylius API AdjustableInterface.

CommentInterface

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

Note

This interface extends the TimestampableInterface

For more detailed information go to Sylius API CommentInterface.

CommentAwareInterface

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

Note

For more detailed information go to Sylius API CommentAwareInterface.

IdentityInterface

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

Note

For more detailed information go to Sylius API IdentityInterface.

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.

For more detailed information about the interface go to Sylius API OrderRepositoryInterface.