Skip to content

Latest commit

 

History

History
218 lines (180 loc) · 5.37 KB

installation.md

File metadata and controls

218 lines (180 loc) · 5.37 KB

Installation

Overview:

GENERAL

BACKEND

FRONTEND

ADDITIONAL

Requirements:

We work on stable, supported and up-to-date versions of packages. We recommend you to do the same.

Package Version
PHP >8.0
sylius/sylius 1.12.x - 1.13.x
MySQL >= 5.7
NodeJS >= 18.x

Composer:

composer require bitbag/blacklist-plugin --no-scripts

Basic configuration:

Add plugin dependencies to your config/bundles.php file:

# config/bundles.php

return [
    ...
    BitBag\SyliusBlacklistPlugin\BitBagSyliusBlacklistPlugin::class => ['all' => true],
];

Import required config in your config/packages/_sylius.yaml file:

# config/packages/_sylius.yaml

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

Add routing to your config/routes.yaml file:

# config/routes.yaml

bitbag_sylius_blacklist_plugin:
    resource: "@BitBagSyliusBlacklistPlugin/Resources/config/routing.yaml"

Override Customer grid in config/packages/_sylius_grid.yml file:

# config/packages/_sylius_grid.yml

sylius_grid:
    grids:
        sylius_admin_customer:
            fields:
                ...
                fraudStatus:
                    type: twig
                    label: bitbag_sylius_blacklist_plugin.ui.fraud_status
                    options:
                        template: "@BitBagSyliusBlacklistPlugin/Customer/Grid/Field/fraudStatus.html.twig"
            filters:
                ...
                fraudStatus:
                    type: select
                    label: bitbag_sylius_blacklist_plugin.ui.fraud_status
                    form_options:
                        choices:
                            bitbag_sylius_blacklist_plugin.ui.neutral: Neutral
                            bitbag_sylius_blacklist_plugin.ui.blacklisted: Blacklisted

Override twig configuration in config/packages/twig.yml file:

# config/packages/twig.yaml
...

twig:
    paths: ['%kernel.project_dir%/templates']
    debug: '%kernel.debug%'
    strict_variables: '%kernel.debug%'
    form_themes:
        - '@BitBagSyliusBlacklistPlugin/Form/theme.html.twig'
        - '@SyliusUi/Form/theme.html.twig'
services:
    _defaults:
        public: false
        autowire: true
        autoconfigure: true

    Twig\Extra\Intl\IntlExtension: ~

when@test_cached:
    twig:
        strict_variables: true

Entities

You can implement entity configuration by using both xml-mapping and attribute-mapping. Depending on your preference, choose either one or the other:

Attribute mapping

XML mapping

Note: If you are running it on production, add the -e prod flag to this command.

Repositories

Add repository with following trait:

<?php
// src/Repository/CustomerRepository.php

declare(strict_types=1);

namespace App\Repository;

use BitBag\SyliusBlacklistPlugin\Repository\CustomerRepositoryTrait;
use Sylius\Bundle\CoreBundle\Doctrine\ORM\CustomerRepository as BaseCustomerRepository;

class CustomerRepository extends BaseCustomerRepository
{
    use CustomerRepositoryTrait;
}

Override config/packages/_sylius.yaml configuration:

# config/packages/_sylius.yaml
...

sylius_customer:
    resources:
        customer:
            classes:
                ...
                repository: App\Repository\CustomerRepository

Update your database

First, please run legacy-versioned migrations by using command:

bin/console doctrine:migrations:migrate

After migration, please create a new diff migration and update database:

bin/console doctrine:migrations:diff
bin/console doctrine:migrations:migrate

Clear application cache by using command:

bin/console cache:clear

Note: If you are running it on production, add the -e prod flag to this command.

Templates

AdminBundle (templates/bundles/SyliusAdminBundle):

Override Customer form template (@SyliusAdminBundle\Customer\_form.html.twig or @SyliusAdminBundle/Customer/Form/_firstColumn.html.twig) by adding lines below:

<div class="ui segment">
    <h4 class="ui dividing header">{{ 'bitbag_sylius_blacklist_plugin.ui.fraud_status'|trans }}</h4>
    {{ form_row(form.fraudStatus) }}
</div>

or copy from the path:

vendor/bitbag/blacklist-plugin/tests/Application/templates/bundles/SyliusAdminBundle/Customer/_form.html.twig

Tests

To run the tests, execute the commands:

composer install
cd tests/Application
yarn install
yarn build
bin/console assets:install public -e test
bin/console doctrine:schema:create -e test
bin/console server:run 127.0.0.1:8080 -d public -e test
open http://localhost:8080
cd ../..
vendor/bin/behat
vendor/bin/phpspec run

Known issues

Translations not displaying correctly

For incorrectly displayed translations, execute the command:

bin/console cache:clear