vaachar/sylius-archivable-products-plugin

A sylius plugin to add archiving to products.

v1.0.2 2021-01-13 22:56 UTC

Requires

• php: ^7.3
• sylius/sylius: ^1.8

Requires (Dev)

• behat/behat: ^3.6.1
• behat/mink-selenium2-driver: ^1.4
• dmore/behat-chrome-extension: ^1.3
• dmore/chrome-mink-driver: ^2.7
• friends-of-behat/mink: ^1.8
• friends-of-behat/mink-browserkit-driver: ^1.4
• friends-of-behat/mink-extension: ^2.4
• friends-of-behat/page-object-extension: ^0.3
• friends-of-behat/suite-settings-extension: ^1.0
• friends-of-behat/symfony-extension: ^2.1
• friends-of-behat/variadic-extension: ^1.3
• lakion/mink-debug-extension: ^1.2.3
• phpspec/phpspec: ^6.1
• phpstan/extension-installer: ^1.0
• phpstan/phpstan: 0.12.25
• phpstan/phpstan-doctrine: 0.12.13
• phpstan/phpstan-strict-rules: ^0.12.0
• phpstan/phpstan-webmozart-assert: 0.12.4
• phpunit/phpunit: ^8.5
• sensiolabs/security-checker: ^6.0
• sylius-labs/coding-standard: ^3.1
• symfony/browser-kit: ^4.4
• symfony/debug-bundle: ^4.4|^5.0
• symfony/dotenv: ^4.4|^5.0
• symfony/intl: ^4.4|^5.0
• symfony/web-profiler-bundle: ^4.4|^5.0
• symfony/web-server-bundle: ^4.4|^5.0
• vimeo/psalm: 3.11.4

MIT

• sylius
• sylius-plugin

README

Plugin to make products archivable when they shouldn't be available anymore. Also includes the option to archive products automatically when they reach a stock of 0 on all variants.

Quickstart Installation

1. Require plugin via Composer

composer require vaachar/sylius-archivable-products-plugin

1. Inlcude config.yaml in _sylius.yaml

- { resource: "@SyliusArchivableProductsPlugin/Resources/config/config.yaml" }

1. Use trait and add interface to src/Entity/Product/Product.php

class Product extends BaseProduct implements IsArchivableProductInterface
{
    use ArchivableProductTrait;

    ...
}

1. Execute migrations

bin/console doctrine:migrations:migrate

Usage

This plugin adds a new menu entry to the side menu when creating or editing a product called Archive.

There you can activate the Archive when out of stock option to let this plugin automatically disable a product and archive it. You can also manually enter a date/time to archive the product there.

On the admin product listing page you can also quickly archive a product via the Archive action button.

Archiving a product will hide it from the admin product listing so that your shop administrators can easily identify if a disabled product is only temporarily disabled or if it is archived and thus discontinued. You can view all archived products by selecting the respective filter.