Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shopsys/read-model
[READ-ONLY] Read model layer for Shopsys Framework
https://github.com/shopsys/read-model
Last synced: about 1 month ago
JSON representation
[READ-ONLY] Read model layer for Shopsys Framework
- Host: GitHub
- URL: https://github.com/shopsys/read-model
- Owner: shopsys
- License: other
- Created: 2019-05-14T08:43:39.000Z (over 5 years ago)
- Default Branch: 12.1
- Last Pushed: 2024-11-07T13:54:17.000Z (about 2 months ago)
- Last Synced: 2024-11-07T14:35:44.368Z (about 2 months ago)
- Language: PHP
- Homepage:
- Size: 47.2 MB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Shopsys Read Model
[](https://packagist.org/packages/shopsys/read-model)
This bundle for [Shopsys Framework](https://www.shopsys.com) separates templates from model using [read model concept](https://docs.shopsys.com/en/latest/model/introduction-to-read-model/).
The bundle is dedicated for projects based on Shopsys Framework (i.e. created from [`shopsys/project-base`](https://github.com/shopsys/project-base)) exclusively.
This repository is maintained by [shopsys/shopsys] monorepo, information about changes is in [monorepo CHANGELOG.md](https://github.com/shopsys/shopsys/blob/master/CHANGELOG.md).
## Installation
The plugin is a Symfony bundle and is installed in the same way:
### Download
First, you download the package using [Composer](https://getcomposer.org/):
```
composer require shopsys/read-model
```
### Register
For the bundle to be loaded in your application you need to register it in `registerBundles()` method in the `app/AppKernel.php` file of your project:
```diff
+ new Shopsys\ReadModelBundle\ShopsysReadModelBundle(),
```
## Usage
If you want to leverage the advantages of read model concept, you need to use the particular implementation of `ListedProductViewFacadeInterface` in your controllers (there is already prepared one implementation in the bundle).
The facade provides you the view objects for product lists that can be then used in the templates.
### Available View Objects
- [`ListedProductView`](src/Product/Listed/ListedProductView.php) - product representation for FE product lists
- [`ActionView`](src/Product/Action/ProductActionView.php) - representation of product action area (i.e. form for adding a product to cart, or link to the product detail in the case of main variant)
- [`ImageView`](src/Image/ImageView.php) - representation of image
### Available Twig functions
- `image` - renders image from given `ImageView`
## Contributing
Thank you for your contributions to Shopsys Read Model package.
Together we are making Shopsys Framework better.
This repository is READ-ONLY.
If you want to [report issues](https://github.com/shopsys/shopsys/issues/new) and/or send [pull requests](https://github.com/shopsys/shopsys/compare),
please use the main [Shopsys repository](https://github.com/shopsys/shopsys).
Please, check our [Contribution Guide](https://github.com/shopsys/shopsys/blob/master/CONTRIBUTING.md) before contributing.
## Support
What to do when you are in troubles or need some help?
The best way is to join our [Slack](https://join.slack.com/t/shopsysframework/shared_invite/zt-11wx9au4g-e5pXei73UJydHRQ7nVApAQ).
If you want to [report issues](https://github.com/shopsys/shopsys/issues/new), please use the main [Shopsys repository](https://github.com/shopsys/shopsys).
[shopsys/shopsys]:(https://github.com/shopsys/shopsys)