How to porting a Plugin 3.0.x to 3.n ?

I. Apply new techniques

• Symfony 3.4
• Annotation
• Injection
• Doctrine ^2.6

II. Structure

[plugin code]
    ├── Controller
    ├── Entity
    │     ├── [xxx].php
    │     ├── [none]
    │     ├── [none]
    ├── Form
    │     ├── Type
    │     ├── Extension
    ├── Repository
    ├── Resource
    │     ├── doctrine
    │     ├── migration
    │     ├── [none]
    │     ├── locale/message.[ja,en].yml
    │     ├── template
    ├── ServiceProvider
    ├── [Name]Event.php
    ├── config.yml
    ├── event.yml
    ├── [none]
    ├── [none]
    ├── PluginManager.php

[plugin code]
    ├── Controller
    ├── Entity
    │     ├── [xxx].php
    │     ├── [xxx]Trait.php        [new]
    │     ├── [xxx]Extend.php       [new]
    ├── Form
    │     ├── Type
    │     ├── Extension
    ├── Repository
    ├── Resource
    │     ├──                       [removed]
    │     ├──                       [removed]
    │     ├── config/service.yml    [new]
    │     ├── locale/messages.[ja,en].yml [change name]
    │     ├── template
    ├──                             [removed]
    ├── [Name]Event.php
    ├── config.yml
    ├──                             [removed]
    ├── [xxx]QueryCustomizer.php    [new]
    ├── Nav.php                     [new]
    ├── PluginManager.php

III. Controller

• Extend AbstractController, many available variables are useful for development.
• By eliminating ServiceProvider, routing in the controller is easy to monitor. Using: @Route.
• You can injection multiple services/repositories by construct function.
• Many annotation you can use in controller: @Route, @Template, …

public function index(Application $app, Request $request)

/**
 * @Method("POST")
 * @Route("/%eccube_admin_route%/plugin/ProductPriority/config", name="product_priority_admin_config")
 * @Template("@ProductPriority/admin/config.twig")
 */
public function index(Request $request)

$app['eccube.plugin.xxx']

public function __construct(xxxRepository $xxxRepository)
{
$this->xxxRepository = $xxxRepository;
}
use: $this->configRepository

$app['form.factory']

$this->formFactory (in AbstractController)

$app['eccube.plugin.xxx']

public function __construct(xxxRepository $xxxRepository)
{
$this->xxxRepository = $xxxRepository;
}
use: $this->xxxRepository

$app['orm.em']

$this->entityManager (in AbstractController)

$app->addSuccess

$this->addSuccess

return $app->render(
    'ProductPriority/Resource/template/admin/config.twig',
    [
        'form' => $form->createView(),
    ]
);

// if you use @Template, then
return [
   'form' => $form->createView(),
];
---
// if you don't use it,
return $this->render(
    '@ProductPriority/admin/config.twig',
    [
        'form' => $form->createView(),
    ]
);

$app->redirect($app->url('xxx'));

$this->redirectToRoute('xxx');

• Reference: https://github.com/EC-CUBE/sample-payment-plugin/blob/master/Controller/PaymentController.php

IV. Entity

• By removed Resource/doctrine/xxx.yml, Entity will handle it by annotation (doctrine orm mapping)
• In new version, you can extend a table in core using trait.
• Support by inheritance mapping, you can define difference entity that uses the same table in core by extends.

1. Entity

class Config extends AbstractEntity

use Doctrine\ORM\Mapping as ORM;
/**
 * @ORM\Table(name="plg_sample_payment_config")
 * @ORM\InheritanceType("SINGLE_TABLE")
 * @ORM\DiscriminatorColumn(name="discriminator_type", type="string", length=255)
 * @ORM\HasLifecycleCallbacks()
 * @ORM\Entity(repositoryClass="Plugin\SamplePayment\Repository\ConfigRepository")
 */
class Config extends AbstractEntity

private $id;

/**
 * @var int
 *
 * @ORM\Column(name="id", type="integer", options={"unsigned":true})
 * @ORM\Id
 * @ORM\GeneratedValue(strategy="IDENTITY")
 */
private $id;

1. Trait ```php use Eccube\Annotation\EntityExtension; use Doctrine\ORM\Mapping as ORM; /**
   • @EntityExtension(“Eccube\Entity\Customer”) */ trait CustomerTrait { /**
   • カードの記憶用カラム. *
   • @var string
   • @ORM\Column(type=”smallint”, nullable=true) */ public $sample_payment_cards; } ```
2. Extend

   use Eccube\Entity\Category;
   use Doctrine\ORM\Mapping as ORM;
   /**
    *
    * @ORM\Entity(repositoryClass="Plugin\ExtendCategory\Repository\ExtendCategoryRepository")
    */
   class ExtendCategory extends Category
   

V. Form

• For form extension, you can use form theme for new attribute.

  class [ProductType]Extension extends AbstractTypeExtension
  {
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder->add('description', TextType::class, [
            // ...
                'eccube_form_options' => [
                    'auto_render' => true,
                    'form_theme' => "@ExamplePlugin/admin/description.twig",
                ],
        ]);
    }
    // ...
  }
  

VI. Repository

• Just change a little in construct function. ```php use Eccube\Repository\AbstractRepository; use Plugin\xxx\Entity\Config; use Symfony\Bridge\Doctrine\RegistryInterface;

class ConfigRepository extends AbstractRepository { public function __construct(RegistryInterface $registry) { // please pass the entity to construct parent::__construct($registry, Config::class); } }

## VII. Resource
- By deleting doctrine directory, they change into entities (see IV Entity).
- By deleting migration directory, you can create data in PluginManager, please see below.
- In now, you can define new services/parameter/constant in config/services.yml
- locale/`message`.[ja,en].yml change to locale/`messages`.[ja,en].yml. And you can use locale/messages.[ja,en].php

1. config/services.yml
```yml
# パラメータ定義
parameters:
   sample_payment.xxx: 1

# コンテナ定義
services:

1. template: You change extend from:

VIII. ServiceProvider

• Removed on new version:
  • Routing will move to controller’s annotation.
  • Service will move to Resouce/config/services.yml
  • Translator will move to Resouce/config/messages.[ja,en].yml
  • Navi of admin will move to Nav.php (see below)

IX. Event

• By deleting event.yml, all hookpoint will defined in same [xxx]Event.php file.
• Remove some event: route, controller, …
• New event: query customizer (see below)
• [xxx]Event.php with implements Symfony\Component\EventDispatcher\EventSubscriberInterface;
• In Template event, 2 new functions added. (addAsset and addSnippet)

X. config.yml

• Remove some attributes:
  • Remove service provider
  • Service: declare in Resource/config/services.yml (see in Resource)
  • orm.path: removed migration so remove it.
  • const: move to Resource/config/services.yml (see in Resource)

XI. QueryCustomizer

• You can change some query builder

class AdminProductListCustomizer extends OrderByCustomizer
{
    protected function createStatements($params, $queryKey)
    {
        return [new OrderByClause('p.id')];
    }

    public function getQueryKey()
    {
        return QueryKey::PRODUCT_SEARCH_ADMIN;
    }
}

• Reference: http://doc3n.ec-cube.net/customize_repository

XII. Nav

• You can add to navi of admin by create Nav.php

class SamplePaymentNav implements \Eccube\Common\EccubeNav
{
    public static function getNav()
    {
        return [
            'order' => [
                'children' => [
                    'sample_payment_admin_payment_status' => [
                        'name' => 'sample_payment.admin.nav.payment_list',
                        'url' => 'sample_payment_admin_payment_status',
                    ]
                ]
            ],
        ];
    }
}

XIII. Plugin manager

• You can migration data in here.

public function enable($config, $app)

public function enable($config, ContainerInterface $container)

$entityManager = $app['orm.em'];

$entityManager = $container->get('doctrine.orm.entity_manager');

// repository/service
$app['eccube.plugin.xxxx'];

$container->get([Repository,Service]::class);

XIV. Reference plugin

https://github.com/EC-CUBE/sample-payment-plugin