Skip to content

Latest commit

 

History

History
217 lines (153 loc) · 7.05 KB

UPGRADE-2.0.md

File metadata and controls

217 lines (153 loc) · 7.05 KB
Raw

UPGRADE PLUGIN

FROM v1.3.X TO v2.0

The first step is upgrading Plugin with Composer

  • composer require loevgaard/sylius-brand-plugin:^2.0

Change or remove Product/Tab/_details.html.twig

In version 2, we injecting form_row(form.brand, ...) automatically to Product form view (it placed at src/Resources/views/Admin/Product/_brand.html.twig) via events into separate tab.

So you should remove that from your template or even remove whole template. Otherwise you will receive Variable "remote_url" does not exists. error.

Choose your option:

  • Remove whole template if you doesn't have any other customizations in this template except ones that was required in 1.3.X version of plugin:

    $ rm templates/bundles/SyliusAdminBundle/views/Product/Tab/_details.html.twig

  • Or remove next line from your templates/bundles/SyliusAdminBundle/views/Product/Tab/_details.html.twig if you still need that template (e.g. you have some other customizations in it):

    {{ form_row(form.brand) }} {# This is the only change made to this file #}

Replace classnames

  • Replace plugin's Entity to Model with your editor's Find & Replace function (in case you used them somewhere in your application):

    Loevgaard\SyliusBrandPlugin\Entity > Loevgaard\SyliusBrandPlugin\Model

Replace imported config

  • Import config/app/config.yaml rather than config/config.yml (which no longer exists)

    - { resource: "@LoevgaardSyliusBrandPlugin/Resources/config/config.yml" } > - { resource: "@LoevgaardSyliusBrandPlugin/Resources/config/app/config.yaml" }

Add new (optional) config

If you wish to display Brand column at Product list grid (sylius_admin_product) at Admin:

# config/services.yaml
imports:
    # ...
    - { resource: "@LoevgaardSyliusBrandPlugin/Resources/config/grids/sylius_admin_product.yaml" }

Extend ProductRepository in your app

<?php
# src/Doctrine/ORM/ProductRepository.php

declare(strict_types=1);

namespace App\Doctrine\ORM;

use Loevgaard\SyliusBrandPlugin\Doctrine\ORM\ProductRepositoryInterface as LoevgaardSyliusBrandPluginProductRepositoryInterface;
use Loevgaard\SyliusBrandPlugin\Doctrine\ORM\ProductRepositoryTrait as LoevgaardSyliusBrandPluginProductRepositoryTrait;
use Sylius\Bundle\CoreBundle\Doctrine\ORM\ProductRepository as BaseProductRepository;

class ProductRepository extends BaseProductRepository implements LoevgaardSyliusBrandPluginProductRepositoryInterface
{
    use LoevgaardSyliusBrandPluginProductRepositoryTrait;

    // ...
}

Update your Product entity

Product now should implement Loevgaard\SyliusBrandPlugin\Model\ProductInterface rather than just Loevgaard\SyliusBrandPlugin\Model\BrandAwareInterface:

  • If you use annotations mapping:

    <?php

declare(strict_types=1);

namespace App\Entity;

use Loevgaard\SyliusBrandPlugin\Model\ProductInterface as LoevgaardSyliusBrandPluginProductInterface;
use Loevgaard\SyliusBrandPlugin\Model\ProductTrait as LoevgaardSyliusBrandPluginProductTrait;
use Sylius\Component\Core\Model\Product as BaseProduct;
use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity
 * @ORM\Table(name="sylius_product")
 */
class Product extends BaseProduct implements LoevgaardSyliusBrandPluginProductInterface
{
    use LoevgaardSyliusBrandPluginProductTrait;
}

  • If you use xml mapping:

    <?php
// src/Model/Product.php

declare(strict_types=1);

namespace App\Model;

use Loevgaard\SyliusBrandPlugin\Model\ProductInterface as LoevgaardSyliusBrandPluginProductInterface;
use Loevgaard\SyliusBrandPlugin\Model\ProductTrait as LoevgaardSyliusBrandPluginProductTrait;
use Sylius\Component\Core\Model\Product as BaseProduct;

class Product extends BaseProduct implements LoevgaardSyliusBrandPluginProductInterface
{
    use LoevgaardSyliusBrandPluginProductTrait;
    
    // ...
}
    <?xml version="1.0" encoding="UTF-8"?>

<!-- config/doctrine/model/Product.orm.xml -->

<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
                                      http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd">

    <mapped-superclass name="App\Model\Product" table="sylius_product">
        <many-to-one field="brand" target-entity="Loevgaard\SyliusBrandPlugin\Model\BrandInterface" inversed-by="products">
            <join-column name="brand_id" on-delete="SET NULL" />
        </many-to-one>
    </mapped-superclass>

</doctrine-mapping>

Migrate

  • Copy migration files to your app's migrations directory:

    cp vendor/loevgaard/sylius-brand-plugin/tests/Application/DoctrineMigrations/*.php src/Migrations/

    Where src/Migrations is your app's migrations directory.

  • Run one or two migrations

    # Define database name at env variable for easier usage
DATABASE_NAME=sylius_brand_plugin_dev

# Check what we have initially
$ mysql $DATABASE_NAME -e "select * from loevgaard_brand"
+----+--------+--------+
| id | slug   | name   |
+----+--------+--------+
|  1 | setono | Setono |
|  2 | sylius | Sylius |
+----+--------+--------+

# Run first migration to 
# add new code field to brand, copy slug to code, make code unique
$ bin/console doctrine:migration:execute 20190311083224 --no-interaction

  ++ migrating 20190311083224

     -> DROP INDEX UNIQ_680CAA08989D9B62 ON loevgaard_brand
     -> ALTER TABLE loevgaard_brand ADD code VARCHAR(255) NOT NULL, CHANGE name name VARCHAR(255) NOT NULL
     -> UPDATE loevgaard_brand SET code = slug
     -> CREATE UNIQUE INDEX UNIQ_680CAA0877153098 ON loevgaard_brand (code)

  ++ migrated (took 224.8ms, used 32.25M memory)

# Check slug copied to code properly
$ mysql $DATABASE_NAME -e "select * from loevgaard_brand"
+----+--------+--------+--------+
| id | slug   | name   | code   |
+----+--------+--------+--------+
|  1 | setono | Setono | setono |
|  2 | sylius | Sylius | sylius |
+----+--------+--------+--------+

# (optional) Run another one to
# remove old slug column from database
# WARNING! Do this only AFTER you sure slug copied to code field properly
$ bin/console doctrine:migration:execute 20190311083313 --no-interaction

  ++ migrating 20190311083313

     -> ALTER TABLE loevgaard_brand DROP slug

  ++ migrated (took 170.3ms, used 32.25M memory)

# Check slug field removed
$ mysql $DATABASE_NAME -e "select * from loevgaard_brand"
+----+--------+--------+
| id | name   | code   |
+----+--------+--------+
|  1 | Setono | setono |
|  2 | Sylius | sylius |
+----+--------+--------+