https://github.com/gewebe/syliusproductdepositplugin

A Sylius plugin that allows products with deposit price
https://github.com/gewebe/syliusproductdepositplugin

Last synced: 22 days ago
JSON representation

A Sylius plugin that allows products with deposit price

• Host: GitHub
• URL: https://github.com/gewebe/syliusproductdepositplugin
• Owner: gewebe
• License: mit
• Created: 2018-06-20T15:03:47.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-02-15T22:49:26.000Z (almost 3 years ago)
• Last Synced: 2024-12-02T11:56:56.903Z (26 days ago)
• Language: PHP
• Homepage:
• Size: 1.25 MB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Sylius Product Deposit Plugin

[![Latest Version on Packagist][ico-version]][link-packagist]

[![Software License][ico-license]](LICENSE)

[![Build][ico-build]][link-build]

[![Quality Score][ico-code-quality]][link-code-quality]



The product deposit plugin in Sylius allows you to set an amount of refundable deposit price for any product. 

For example: deposit for bottles, cans, pallets, batteries or car replacement parts.

## Features

 * Store individual deposit prices for each product variant and channel

 * The deposit price is displayed on the product detail page

 * At shopping cart / checkout / order the total unit price inclusive deposit is displayed.

## Installation

### Download the plugin via composer

```bash

composer require gewebe/sylius-product-deposit-plugin

```

### Enable the plugin

Register the plugin by adding it to your `config/bundles.php` file

```php

 ['all' => true],

];

```

### Configure the plugin

```yaml

# config/packages/gewebe_sylius_product_deposit.yaml

imports:

    - { resource: '@GewebeSyliusProductDepositPlugin/Resources/config/app/config.yml'}

```

### Copy the template overrides from the plugin directory

```

From: [shop_dir]/vendor/gewebe/sylius-product-deposit-plugin/test/Application/templates

To: [shop_dir]/templates

```

### Extend `ProductVariant` entity

- If you use `annotations` mapping:

```php

# src/Entity/Product/ProductVariant.php

namespace App\Entity\Product;

use Doctrine\ORM\Mapping as ORM;

use Gewebe\SyliusProductDepositPlugin\Entity\ProductVariantInterface as ProductVariantDepositInterface;

use Gewebe\SyliusProductDepositPlugin\Entity\ProductVariantDepositTrait;

use Sylius\Component\Core\Model\ProductVariant as BaseProductVariant;

/**

 * @ORM\Entity

 * @ORM\Table(name="sylius_product_variant")

 */

class ProductVariant extends BaseProductVariant implements ProductVariantDepositInterface

{

    use ProductVariantDepositTrait;

    public function __construct()

    {

        parent::__construct();

        $this->initProductVariantDepositTrait();

    }

    // ...

}

```

- If you use `yaml` mapping add also:

```yaml

App\Entity\Product\ProductVariant:

    type: entity

    table: sylius_product_variant

    manyToOne:

        depositTaxCategory:

            targetEntity: Sylius\Component\Taxation\Model\TaxCategoryInterface

            joinColumn:

                name: deposit_tax_category_id

                referencedColumnName: id

                onDelete: SET NULL

    oneToMany:

        channelDeposits:

            targetEntity: Gewebe\SyliusProductDepositPlugin\Entity\ChannelDepositInterface

            mappedBy: productVariant

            orphanRemoval: true

            indexBy: channelCode

            cascade:

                - all

```

### Update your database schema

```bash

bin/console doctrine:migrations:diff

bin/console doctrine:migrations:migrate

```

## Usage

##### 1. Add a deposit price to a product variant

![Screenshot manage product variant deposit price](docs/images/manage_product_variant_deposit.png)

##### 2. Browse a product variant with deposit price

![Screenshot product details with deposit](docs/images/product_details.png)

##### 3. Buy a product with deposit price included in final product price

![Screenshot shopping cart with deposit](docs/images/shopping_cart.png)

## Testing

Setup

```bash

$ composer install

$ cd tests/Application

$ yarn install

$ yarn run gulp

$ bin/console assets:install public -e test

$ bin/console doctrine:schema:create -e test

$ export APP_ENV=test

$ symfony server:start --port=8080 --dir=public

```

Run Tests

```bash

$ vendor/bin/behat

$ vendor/bin/phpspec run

$ vendor/bin/phpstan analyse -c phpstan.neon -l max src/

$ vendor/bin/psalm

```

[ico-version]: https://img.shields.io/packagist/v/gewebe/sylius-product-deposit-plugin.svg?style=flat-square

[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square

[ico-code-quality]: https://img.shields.io/scrutinizer/g/gewebe/SyliusProductDepositPlugin.svg?style=flat-square

[ico-build]: https://github.com/gewebe/SyliusProductDepositPlugin/actions/workflows/build.yml/badge.svg

[link-packagist]: https://packagist.org/packages/gewebe/sylius-product-deposit-plugin

[link-code-quality]: https://scrutinizer-ci.com/g/gewebe/SyliusProductDepositPlugin

[link-build]: https://github.com/gewebe/SyliusProductDepositPlugin/actions/workflows/build.yml