{"id":19095093,"url":"https://github.com/shopsys/read-model","last_synced_at":"2025-04-30T14:09:30.579Z","repository":{"id":45643035,"uuid":"186581719","full_name":"shopsys/read-model","owner":"shopsys","description":"[READ-ONLY] Read model layer for Shopsys Framework","archived":false,"fork":false,"pushed_at":"2025-03-04T09:24:30.000Z","size":49535,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"12.1","last_synced_at":"2025-04-14T07:06:01.578Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shopsys.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-14T08:43:39.000Z","updated_at":"2022-02-03T15:50:25.000Z","dependencies_parsed_at":"2024-11-07T14:40:57.142Z","dependency_job_id":null,"html_url":"https://github.com/shopsys/read-model","commit_stats":null,"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shopsys%2Fread-model","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shopsys%2Fread-model/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shopsys%2Fread-model/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shopsys%2Fread-model/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shopsys","download_url":"https://codeload.github.com/shopsys/read-model/tar.gz/refs/heads/12.1","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251716914,"owners_count":21632204,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T03:32:44.126Z","updated_at":"2025-04-30T14:09:30.532Z","avatar_url":"https://github.com/shopsys.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shopsys Read Model\n\n[![Downloads](https://img.shields.io/packagist/dt/shopsys/read-model.svg)](https://packagist.org/packages/shopsys/read-model)\n\nThis 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/).\nThe bundle is dedicated for projects based on Shopsys Framework (i.e. created from [`shopsys/project-base`](https://github.com/shopsys/project-base)) exclusively.\n\nThis repository is maintained by [shopsys/shopsys] monorepo, information about changes is in [monorepo CHANGELOG.md](https://github.com/shopsys/shopsys/blob/master/CHANGELOG.md).\n\n## Installation\nThe plugin is a Symfony bundle and is installed in the same way:\n\n### Download\nFirst, you download the package using [Composer](https://getcomposer.org/):\n```\ncomposer require shopsys/read-model\n```\n\n### Register\nFor 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:\n```diff\n+ new Shopsys\\ReadModelBundle\\ShopsysReadModelBundle(),\n```\n\n## Usage\nIf 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).\nThe facade provides you the view objects for product lists that can be then used in the templates.\n\n### Available View Objects\n- [`ListedProductView`](src/Product/Listed/ListedProductView.php) - product representation for FE product lists\n- [`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)\n- [`ImageView`](src/Image/ImageView.php) - representation of image\n\n### Available Twig functions\n- `image` - renders image from given `ImageView`\n\n## Contributing\nThank you for your contributions to Shopsys Read Model package.\nTogether we are making Shopsys Framework better.\n\nThis repository is READ-ONLY.\nIf you want to [report issues](https://github.com/shopsys/shopsys/issues/new) and/or send [pull requests](https://github.com/shopsys/shopsys/compare),\nplease use the main [Shopsys repository](https://github.com/shopsys/shopsys).\n\nPlease, check our [Contribution Guide](https://github.com/shopsys/shopsys/blob/master/CONTRIBUTING.md) before contributing.\n\n## Support\nWhat to do when you are in troubles or need some help?\nThe best way is to join our [Slack](https://join.slack.com/t/shopsysframework/shared_invite/zt-11wx9au4g-e5pXei73UJydHRQ7nVApAQ).\n\nIf you want to [report issues](https://github.com/shopsys/shopsys/issues/new), please use the main [Shopsys repository](https://github.com/shopsys/shopsys).\n\n[shopsys/shopsys]:(https://github.com/shopsys/shopsys)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshopsys%2Fread-model","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshopsys%2Fread-model","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshopsys%2Fread-model/lists"}