shopsys / product-feed-interface
Shopsys Framework plugin interface for product feed generation
Requires
- php: ^7.0
Requires (Dev)
- shopsys/coding-standards: v7.0.0-alpha3
This package is not auto-updated.
Last update: 2020-01-24 16:42:07 UTC
README
Package of interfaces providing compatibility between Shopsys Framework and product feed plugins.
This repository is maintained by shopsys/shopsys monorepo, information about changes are in monorepo CHANGELOG.md.
How to implement a plugin
Product feed plugins are implemented in a form of a Symfony bundle. For tips on how to write a new bundle see Best Practices for Reusable Bundles.
The heart of a product feed plugin is a service implementing FeedConfigInterface
that is tagged in a DI container with shopsys.product_feed
tag.
Optionally, the tag can have a type
attribute:
standard
- if the tag
type
is omitted, thestandard
is used as a default value - feed usually contains most of the product parameters and information (eg. parameters, description, ean)
- items passed to FeedConfigInterface::processItems() are instances of StandardFeedItemInterface
delivery
- feed usually contains only information about stock quantity or time of delivery
- items for feed generation are instances of DeliveryFeedItemInterface
- used for feeds that need a frequent generation
The methods to be implemented are described in the FeedConfigInterface itself.
For general information on plugin creation see the documentation of the General Shopsys Framework Plugin Interface repository.
Example
You can take a look at the package shopsys/product-feed-zbozi for implementation of Zboží.cz product feed plugin.
Contributing
Thank you for your contributions to Shopsys Product Feed Interface package. Together we are making Shopsys Framework better.
This repository is READ-ONLY. If you want to report issues and/or send pull requests, please use the main Shopsys repository.
Please, check our Contribution Guide before contributing.
Support
What to do when you are in troubles or need some help? Best way is to contact us on our Slack http://slack.shopsys-framework.com/
If you want to report issues, please use the main Shopsys repository.