shopsys / read-model
[experimental] Read model layer for Shopsys Framework
Requires
- php: ^8.1
- shopsys/form-types-bundle: 13.0.0
- shopsys/framework: 13.0.0
- shopsys/migrations: 13.0.0
- shopsys/plugin-interface: 13.0.0
- symfony/config: ^5.4
- symfony/dependency-injection: ^5.4
- symfony/http-kernel: ^5.4
- webmozart/assert: ^1.4
Requires (Dev)
- phpunit/phpunit: ^9.5.20
- shopsys/coding-standards: 13.0.0
- 15.0.x-dev
- 14.0.x-dev
- 13.0.x-dev
- v13.0.0
- 12.1.x-dev
- 12.0.x-dev
- v12.0.0
- v11.1.0
- dev-master / 11.0.x-dev
- v11.0.0
- 10.0.x-dev
- v10.0.5
- v10.0.4
- v10.0.3
- v10.0.2
- v10.0.1
- v10.0.0
- 9.1.x-dev
- v9.1.3
- v9.1.2
- v9.1.1
- v9.1.0
- 9.0.x-dev
- v9.0.4
- v9.0.3
- v9.0.2
- v9.0.1
- v9.0.0
- 8.1.x-dev
- v8.1.2
- v8.1.1
- v8.1.0
- 8.0.x-dev
- v8.0.0
- 7.3.x-dev
- v7.3.7
- v7.3.6
- v7.3.5
- v7.3.4
- v7.3.3
- v7.3.2
- v7.3.1
- v7.3.0
- dev-rv-ecs-fix
- dev-rc-12-0-0
- dev-tl-fix-failing-12-0-builds
- dev-mg-js-translations-fix
- dev-mg-split-repo
- dev-rc-11-1-0
- dev-mg-deployment
- dev-mg-project-cold-fusion
- dev-mg-remove-manifests
- dev-tl-fix-project-base
- dev-rc-11-0-0
- dev-rc-10-0-5
- dev-rk-fw-uprage-from-10-to-11-part-3
- dev-rc-v9-1-3
- dev-rk-fw-1019-api-query-name-in-symfony-profiler
- dev-rk-fw-uprage-from-10-to-11-part-2
- dev-rc-10-0-4
- dev-rc-10-0-3
- dev-rc-10-0-2
- dev-rc-10-0-1
- dev-mg-fw-933-remove-rootdir
- dev-mg-release-lock
- dev-mg-remove-twig-extension
- dev-rk-fw-uprage-from-10-to-11-part-1
- dev-rc-10-0-0
- dev-mg-upgrade-php8
- dev-mg-remove-be-api-integration
- dev-rv-fw-837-doctrine-upgrade
- dev-rv-fw-847-migrations-tests
- dev-mg-improve-entity-extension
- dev-rv-fw-810-fix-actions
- dev-rc-v9-1-2
- dev-mg-fix-phpstan-packages
- dev-mg-force-proxy-manager-version
- dev-mg-update-node
- dev-rc-v7-3-7
- dev-mg-allow-dependency
- dev-origin/tl-phpstan-all-packages
- dev-tl-release-9-1-1
- dev-ds-coding-standards-allow-symfony-5-higher
- dev-tl-remove-package-builder
- dev-tl-github-actions-for-packages
- dev-mg-update-helios-elfinder
- dev-ds-fix-ecs
- dev-tp-allow-coding-standards-for-symfony5
- dev-rc-v9-1-0
- dev-tl-fix-docker-limits
- dev-rc-v7-3-6
- dev-rc-v9-0-4
- dev-mg-php74-only
- dev-rc-v9-0-3
- dev-ds-more-coding-standards
- dev-rc-v7-3-5
- dev-ds-ecs-path-fix
- dev-rc-v9-0-2
- dev-ds-eof-new-line
- dev-tl-fix-phpstan
- dev-ds-phpstan-lvl-5
- dev-rc-v9-0-1
- dev-ds-fixed-framework-standaards
- dev-tl-add-psr-14
- dev-rc-v7-3-4
- dev-rc-v8-1-2
- dev-rc-v9-0-0
- dev-tl-fix-current-customer-user
- dev-tp-js-fixes
- dev-vitek-rostislav-patch-3
- dev-tg-grunt-webpack
- dev-tp-symfony4
- dev-rv-eur-on-first-domain
- dev-rc-v7-3-3
- dev-tp-update-composer
- dev-ds-easier-elastic-extensebility
- dev-rc-v8-1-1
- dev-rc-v8-1-0
- dev-tp-npm-link
- dev-mg-weird-flex-but-ok
- dev-ds-fix-project-base-dependency
- dev-ds-fix-sed-macos
- dev-mg-graphql-categories
- dev-ds-kubernetes-simplify
- dev-tl-rv-datafixtures-refactoring
- dev-ds-kubernetes-simplify-test
- dev-rv-extended-classes-fixer
- dev-rv-phpstan-lvl4
- dev-ds-test-install-script-automatically
- dev-rc-8-0-0
- dev-ss-api-import-products
- dev-do-version-lock
- dev-rc-v7-3-0
- dev-ss-api-separated-from-default-project-base
- dev-ss-tl-api-products
- dev-bb-multidomain-sitemap
- dev-do-elastic-structure-deploy
- dev-mg-fix-k8s-https
- dev-ph-price-calculation
- dev-ph-redis-clients
- dev-tl-fix-tests-bc-break
- dev-tl-removed-tests-bc-break
- dev-tl-united-non-bc-break-service-injections
- dev-ph-phing-test
- dev-tl-end-support-php-71
- dev-do-mg-mail-attachments
- dev-bb-flysystem-volume-driver
- dev-do-phpstan-upgrade
- dev-rv-read-model-bck
This package is auto-updated.
Last update: 2024-11-07 13:54:22 UTC
README
This bundle for Shopsys Framework separates templates from model using read model concept.
The bundle is dedicated for projects based on Shopsys Framework (i.e. created from shopsys/project-base
) exclusively.
This repository is maintained by shopsys/shopsys monorepo, information about changes is in monorepo CHANGELOG.md.
Installation
The plugin is a Symfony bundle and is installed in the same way:
Download
First, you download the package using Composer:
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:
+ 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
- product representation for FE product listsActionView
- 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
- representation of image
Available Twig functions
image
- renders image from givenImageView
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 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? The best way is to join our Slack.
If you want to report issues, please use the main Shopsys repository.