PHPackages                             shopsys/read-model - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. shopsys/read-model

ActiveLibrary[Framework](/categories/framework)

shopsys/read-model
==================

\[experimental\] Read model layer for Shopsys Framework

v13.0.0(2y ago)0104.2k↓10.1%proprietaryPHPPHP ^8.1

Since May 20Pushed 1y ago4 watchersCompare

[ Source](https://github.com/shopsys/read-model)[ Packagist](https://packagist.org/packages/shopsys/read-model)[ RSS](/packages/shopsys-read-model/feed)WikiDiscussions 12.1 Synced 1mo ago

READMEChangelogDependencies (10)Versions (149)Used By (0)

Shopsys Read Model
==================

[](#shopsys-read-model)

[![Downloads](https://camo.githubusercontent.com/7485a1d9f2f0975fc9b55f34833987467d6917968ef957a4076e23ec062be94b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f73686f707379732f726561642d6d6f64656c2e737667)](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
------------

[](#installation)

The plugin is a Symfony bundle and is installed in the same way:

### Download

[](#download)

First, you download the package using [Composer](https://getcomposer.org/):

```
composer require shopsys/read-model

```

### Register

[](#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
-----

[](#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

[](#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

[](#available-twig-functions)

- `image` - renders image from given `ImageView`

Contributing
------------

[](#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
-------

[](#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).

###  Health Score

47

—

FairBetter than 94% of packages

Maintenance34

Infrequent updates — may be unmaintained

Popularity31

Limited adoption so far

Community21

Small or concentrated contributor base

Maturity86

Battle-tested with a long release history

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~50 days

Recently: every ~131 days

Total

42

Last Release

440d ago

Major Versions

10.0.x-dev → v11.0.02023-03-01

v11.1.0 → 12.0.x-dev2023-09-22

12.1.x-dev → v13.0.02023-10-11

13.0.x-dev → 14.0.x-dev2023-12-07

14.0.x-dev → 15.0.x-dev2025-03-04

PHP version history (4 changes)v7.3.0PHP ^7.1

v8.0.0PHP ^7.2

v9.1.0PHP ^7.4.1

v10.0.0PHP ^8.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/0e3409c555d1e101617340d2ba982d26d5c28a2b1dbf10e7e19b8a07e6a7eed5?d=identicon)[TomasLudvik](/maintainers/TomasLudvik)

![](https://www.gravatar.com/avatar/7b125b646ceaeb5a2a859613c9dcc82d18493c9071c32ca2991543067c6bdc66?d=identicon)[grossmannmartin](/maintainers/grossmannmartin)

![](https://www.gravatar.com/avatar/8aee0045853dd983a2a4f291d2e21e7492e2d8c19d84cdb7a76dd16c3eb499f9?d=identicon)[rostislav.vitek@shopsys.com](/maintainers/rostislav.vitek@shopsys.com)

![](https://www.gravatar.com/avatar/0a44b48b2c3e7114fdf1cbdf9170494591abad48f5fc416d93b134abd771635f?d=identicon)[Miroslav Stopka](/maintainers/Miroslav%20Stopka)

---

Top Contributors

[![grossmannmartin](https://avatars.githubusercontent.com/u/1177414?v=4)](https://github.com/grossmannmartin "grossmannmartin (73 commits)")[![TomasLudvik](https://avatars.githubusercontent.com/u/5638367?v=4)](https://github.com/TomasLudvik "TomasLudvik (38 commits)")[![vitek-rostislav](https://avatars.githubusercontent.com/u/10401898?v=4)](https://github.com/vitek-rostislav "vitek-rostislav (20 commits)")[![s3tezsky](https://avatars.githubusercontent.com/u/53976269?v=4)](https://github.com/s3tezsky "s3tezsky (15 commits)")[![PetrHeinz](https://avatars.githubusercontent.com/u/10008612?v=4)](https://github.com/PetrHeinz "PetrHeinz (11 commits)")[![pesektomas](https://avatars.githubusercontent.com/u/1737966?v=4)](https://github.com/pesektomas "pesektomas (11 commits)")[![DavidOstrozlik](https://avatars.githubusercontent.com/u/44843673?v=4)](https://github.com/DavidOstrozlik "DavidOstrozlik (7 commits)")[![RobinDvorak](https://avatars.githubusercontent.com/u/7197178?v=4)](https://github.com/RobinDvorak "RobinDvorak (4 commits)")[![sspooky13](https://avatars.githubusercontent.com/u/25614491?v=4)](https://github.com/sspooky13 "sspooky13 (2 commits)")[![henzigo](https://avatars.githubusercontent.com/u/1482966?v=4)](https://github.com/henzigo "henzigo (2 commits)")[![LukasHeinz](https://avatars.githubusercontent.com/u/33071107?v=4)](https://github.com/LukasHeinz "LukasHeinz (2 commits)")[![pk16011990](https://avatars.githubusercontent.com/u/5857836?v=4)](https://github.com/pk16011990 "pk16011990 (2 commits)")[![boris-brtan](https://avatars.githubusercontent.com/u/39240194?v=4)](https://github.com/boris-brtan "boris-brtan (1 commits)")

---

Tags

SSFWShopsys Platformread model

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/shopsys-read-model/health.svg)

```
[![Health](https://phpackages.com/badges/shopsys-read-model/health.svg)](https://phpackages.com/packages/shopsys-read-model)
```

###  Alternatives

[symfony/framework-bundle

Provides a tight integration between Symfony components and the Symfony full-stack framework

3.6k235.4M9.7k](/packages/symfony-framework-bundle)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.3M152](/packages/sulu-sulu)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[prestashop/prestashop

PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers.

9.0k15.4k](/packages/prestashop-prestashop)[shopware/storefront

Storefront for Shopware

684.2M148](/packages/shopware-storefront)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

595.2M386](/packages/shopware-core)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
