Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/setono/syliusitemssoldplugin
https://github.com/setono/syliusitemssoldplugin
php sylius sylius-plugin symfony
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/setono/syliusitemssoldplugin
- Owner: Setono
- Created: 2018-09-02T11:33:26.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T02:19:13.000Z (about 1 year ago)
- Last Synced: 2024-11-24T16:02:14.935Z (2 months ago)
- Topics: php, sylius, sylius-plugin, symfony
- Language: PHP
- Size: 137 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SetonoSyliusItemsSoldPlugin
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE)
[![Build Status][ico-travis]][link-travis]
[![Quality Score][ico-code-quality]][link-code-quality]
Sylius Plugin to display items sold on every Product/ProductVariant details admin page
## Install
### Add plugin to composer.json
```bash
composer require setono/sylius-items-sold-plugin
```
### Register plugin at AppKernel.php
```php
# app/AppKernel.php
final class AppKernel extends Kernel
{
public function registerBundles(): array
{
return array_merge(parent::registerBundles(), [
// ...
new \Setono\SyliusItemsSoldPlugin\SetonoSyliusItemsSoldPlugin(),
]);
}
}
```
### Add routing
```yaml
# app/config/routing.yml
setono_sylius_items_sold_plugin_admin:
resource: "@SetonoSyliusItemsSoldPlugin/Resources/config/admin_routing.yml"
prefix: /admin
```
### Configure plugin (optional)
You can omit this step as far as plugin works even without configuration.
In that case result will count carts/orders in any (checkout/payment/shipment) states
without any interval limitation and will not be cached.
But lets suppose we need to:
- See how much times every item was sold last 14 days
- Cache that values for 30 mins (1800 seconds) to decrease server load a bit
- We don't want to count orders in states other than in *payed* and *shipped*
```yaml
# app/config/config.yml
services:
app.setono_sylius_items_sold.cache:
class: Symfony\Component\Cache\Simple\FilesystemCache
arguments:
- ''
- 0
- "%kernel.cache_dir%/items-sold"
setono_sylius_items_sold:
cache:
service: 'app.setono_sylius_items_sold.cache'
ttl: 1800
interval: 14
payment_states:
- paid
shipping_states:
- shipped
```
Tips:
- Don't forget to clean cache after changing `interval` parameter.
- Don't specify `interval` if you wish to count even items added to carts
(as far as cart doesn't have order date at `checkoutCompletedAt` field)
- Discover `Setono\SyliusItemsSoldPlugin\DependencyInjection\Configuration`
for more info about config options
# (Manually) Test plugin
- Run application:
(by default application have default config at `dev` environment
and example config from `Configure plugin` step at `prod` environment)
```bash
SYMFONY_ENV=dev
cd tests/Application && \
yarn install && \
yarn run gulp && \
bin/console assets:install web -e $SYMFONY_ENV && \
bin/console doctrine:database:create -e $SYMFONY_ENV && \
bin/console doctrine:schema:create -e $SYMFONY_ENV && \
bin/console sylius:fixtures:load -e $SYMFONY_ENV && \
bin/console server:run -d web -e $SYMFONY_ENV
```
- Log in at `http://localhost:8000/admin`
with Sylius demo credentials:
```
Login: [email protected]
Password: sylius
```
- Go to any product edit page like
`http://localhost:8000/admin/products/1`
- Or to product variant page like
`http://localhost:8000/admin/products/1/variants/1/edit`
- See how much that item was ordered (or even added to cart depending on config)
[ico-version]: https://img.shields.io/packagist/v/setono/sylius-items-sold-plugin.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/Setono/SyliusItemsSoldPlugin/master.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/Setono/SyliusItemsSoldPlugin.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/setono/sylius-items-sold-plugin
[link-travis]: https://travis-ci.org/Setono/SyliusItemsSoldPlugin
[link-code-quality]: https://scrutinizer-ci.com/g/Setono/SyliusItemsSoldPlugin