{"id":22434598,"url":"https://github.com/gewebe/syliusproductdepositplugin","last_synced_at":"2025-03-27T08:15:29.117Z","repository":{"id":62510518,"uuid":"138048688","full_name":"gewebe/SyliusProductDepositPlugin","owner":"gewebe","description":"A Sylius plugin that allows products with deposit price","archived":false,"fork":false,"pushed_at":"2022-02-15T22:49:26.000Z","size":1313,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-01T20:46:38.742Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gewebe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2018-06-20T15:03:47.000Z","updated_at":"2022-02-15T22:20:33.000Z","dependencies_parsed_at":"2022-11-02T10:30:52.120Z","dependency_job_id":null,"html_url":"https://github.com/gewebe/SyliusProductDepositPlugin","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gewebe%2FSyliusProductDepositPlugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gewebe%2FSyliusProductDepositPlugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gewebe%2FSyliusProductDepositPlugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gewebe%2FSyliusProductDepositPlugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gewebe","download_url":"https://codeload.github.com/gewebe/SyliusProductDepositPlugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245806460,"owners_count":20675298,"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-12-05T23:09:38.360Z","updated_at":"2025-03-27T08:15:29.096Z","avatar_url":"https://github.com/gewebe.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sylius Product Deposit Plugin\n\n[![Latest Version on Packagist][ico-version]][link-packagist]\n[![Software License][ico-license]](LICENSE)\n[![Build][ico-build]][link-build]\n[![Quality Score][ico-code-quality]][link-code-quality]\n\n\u003ca href=\"https://sylius.com/plugins/\" target=\"_blank\"\u003e\u003cimg src=\"https://sylius.com/assets/badge-approved-by-sylius.png\" width=\"100\"\u003e\u003c/a\u003e\n\nThe product deposit plugin in Sylius allows you to set an amount of refundable deposit price for any product. \nFor example: deposit for bottles, cans, pallets, batteries or car replacement parts.\n\n## Features\n * Store individual deposit prices for each product variant and channel\n * The deposit price is displayed on the product detail page\n * At shopping cart / checkout / order the total unit price inclusive deposit is displayed.\n\n## Installation\n\n### Download the plugin via composer\n```bash\ncomposer require gewebe/sylius-product-deposit-plugin\n```\n\n### Enable the plugin\nRegister the plugin by adding it to your `config/bundles.php` file\n\n```php\n\u003c?php\n\nreturn [\n    // ...\n    Gewebe\\SyliusProductDepositPlugin\\GewebeSyliusProductDepositPlugin::class =\u003e ['all' =\u003e true],\n];\n```\n\n### Configure the plugin\n\n```yaml\n# config/packages/gewebe_sylius_product_deposit.yaml\n\nimports:\n    - { resource: '@GewebeSyliusProductDepositPlugin/Resources/config/app/config.yml'}\n```\n\n### Copy the template overrides from the plugin directory\n```\nFrom: [shop_dir]/vendor/gewebe/sylius-product-deposit-plugin/test/Application/templates\nTo: [shop_dir]/templates\n```\n\n### Extend `ProductVariant` entity\n\n- If you use `annotations` mapping:\n\n```php\n# src/Entity/Product/ProductVariant.php\n\nnamespace App\\Entity\\Product;\n\nuse Doctrine\\ORM\\Mapping as ORM;\nuse Gewebe\\SyliusProductDepositPlugin\\Entity\\ProductVariantInterface as ProductVariantDepositInterface;\nuse Gewebe\\SyliusProductDepositPlugin\\Entity\\ProductVariantDepositTrait;\nuse Sylius\\Component\\Core\\Model\\ProductVariant as BaseProductVariant;\n\n/**\n * @ORM\\Entity\n * @ORM\\Table(name=\"sylius_product_variant\")\n */\nclass ProductVariant extends BaseProductVariant implements ProductVariantDepositInterface\n{\n    use ProductVariantDepositTrait;\n\n    public function __construct()\n    {\n        parent::__construct();\n\n        $this-\u003einitProductVariantDepositTrait();\n    }\n\n    // ...\n}\n```\n\n- If you use `yaml` mapping add also:\n\n```yaml\nApp\\Entity\\Product\\ProductVariant:\n    type: entity\n    table: sylius_product_variant\n    manyToOne:\n        depositTaxCategory:\n            targetEntity: Sylius\\Component\\Taxation\\Model\\TaxCategoryInterface\n            joinColumn:\n                name: deposit_tax_category_id\n                referencedColumnName: id\n                onDelete: SET NULL\n    oneToMany:\n        channelDeposits:\n            targetEntity: Gewebe\\SyliusProductDepositPlugin\\Entity\\ChannelDepositInterface\n            mappedBy: productVariant\n            orphanRemoval: true\n            indexBy: channelCode\n            cascade:\n                - all\n```\n\n### Update your database schema\n\n```bash\nbin/console doctrine:migrations:diff\nbin/console doctrine:migrations:migrate\n```\n\n## Usage\n\n##### 1. Add a deposit price to a product variant\n![Screenshot manage product variant deposit price](docs/images/manage_product_variant_deposit.png)\n\n##### 2. Browse a product variant with deposit price\n![Screenshot product details with deposit](docs/images/product_details.png)\n\n##### 3. Buy a product with deposit price included in final product price\n![Screenshot shopping cart with deposit](docs/images/shopping_cart.png)\n\n## Testing\n\nSetup\n```bash\n$ composer install\n$ cd tests/Application\n$ yarn install\n$ yarn run gulp\n$ bin/console assets:install public -e test\n$ bin/console doctrine:schema:create -e test\n\n$ export APP_ENV=test\n$ symfony server:start --port=8080 --dir=public\n```\n\nRun Tests\n```bash\n$ vendor/bin/behat\n$ vendor/bin/phpspec run\n$ vendor/bin/phpstan analyse -c phpstan.neon -l max src/\n$ vendor/bin/psalm\n```\n\n[ico-version]: https://img.shields.io/packagist/v/gewebe/sylius-product-deposit-plugin.svg?style=flat-square\n[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square\n[ico-code-quality]: https://img.shields.io/scrutinizer/g/gewebe/SyliusProductDepositPlugin.svg?style=flat-square\n[ico-build]: https://github.com/gewebe/SyliusProductDepositPlugin/actions/workflows/build.yml/badge.svg\n\n[link-packagist]: https://packagist.org/packages/gewebe/sylius-product-deposit-plugin\n[link-code-quality]: https://scrutinizer-ci.com/g/gewebe/SyliusProductDepositPlugin\n[link-build]: https://github.com/gewebe/SyliusProductDepositPlugin/actions/workflows/build.yml\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgewebe%2Fsyliusproductdepositplugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgewebe%2Fsyliusproductdepositplugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgewebe%2Fsyliusproductdepositplugin/lists"}