【EC-CUBE 4】オリジナルテーブルの保存データ（レコード）を更新する方法

2023年9月20日

この記事では、データベースに新規追加したテーブルに保存されたデータ（レコード）を更新する方法について解説しています。
『dtb_maker』テーブル作成後（詳細はこちら）の手順となります。

レコードの追加 / 削除についてはこちら

【EC-CUBE 4】オリジナルテーブルに新規データ（レコード）を追加する方法

【EC-CUBE 4】オリジナルテーブルの保存データ（レコード）を削除する方法

開発前にデバッグモードの設定をお薦めします

デバッグモードを設定しておくと、エラーが起きたときに詳細情報が表示されるようになります。
エラー箇所を探しやすくなるので、開発前に設定しておくのをオススメします。
デバッグモードの設定方法については以下記事で解説しています。

【EC-CUBE 4】デバッグモードの設定/解除方法

カスタマイズ後は、デバッグモードの解除を忘れないように。

【動作環境】
EC CUBEのバージョン：4.2.1
サーバー：Xserver

実装後の状態

オリジナルテーブル『dtb_maker』に、3つのレコードが格納されています。

このうち、ID = 1のnameとcodeをWebページから変更します。

新規作成したdtb_Makerに、3つのデータを保存しておく — 『dtb_Maker』テーブルの中身

「(ドメイン名)/maker_update/(ID)」にアクセスすると、末尾に指定した数字と同じIDのレコードを更新するページが表示されます。

なお、アクセス時には現在格納されている値が表示されます。

メーカー名とコードを画像の通り変更し、「Register」ボタンをクリックします。

レコード更新の例 — 値の更新は、変更したい項目を入力してRegisterをクリックするだけ

入力通りに更新できているか確認するため、データベースをチェックします。

id = 1 のレコード内容が更新されています。

更新日時（update_date）も同時に更新されていますね。

レコード更新後のデータベース — 『dtb_Maker』テーブルに新規レコードが追加されています。

実装までの手順

新規作成と同様にエンティティ更新のためのフォームを用意し、そこに変更内容を記載して送信するという形で更新します。（前項の通り。）

データ（レコード）を更新するためのページを作成する

まずは更新するためのページを作成します。

新規ページはEC-CUBE管理画面から簡単に作成できますが、あとでControllerを修正する必要があり、Controllerも合わせて用意しなければなりません。

具体的には以下記事で解説していますので、本記事では省きます。

作成したページのControllerを修正する

新しくページを用意できたら、「app/Customize/Controller」に保存してあるControllerを以下の通り修正します。

<?php

namespace Customize\Controller;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Annotation\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
use Eccube\Controller\AbstractController;
use Customize\Entity\Maker;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\Extension\Core\Type\SubmitType;

class MakerUpdateController extends AbstractController
{
  /**
   * @Route("/maker_update/{id}", name="maker_update")
   * @Template("maker_update.twig")
   */
  public function update(Request $request, Maker $maker)
  {
    $form = $this->createFormBuilder($maker)
      ->add('name', TextType::class, array('label' => 'メーカー名'))
      ->add('code', TextType::class, array('label' => 'メーカーコード'))
      ->add('save', SubmitType::class, array('label' => 'Register'))
      ->getForm();

    if ($request->getMethod() == 'POST') {
      $form->handleRequest($request);
      $maker = $form->getData();
      $manager = $this->getDoctrine()->getManager();
      $manager->flush();
      return [
        'message' => 'ID: ' . $maker->getId() . ' のメーカー情報を更新しました！',
        'form' => $form->createView(),
      ];
    } else {
      return [
        'message' => 'ID: ' . $maker->getId() . ' のメーカー情報を更新します。',
        'form' => $form->createView(),
      ];
    }
  }
}

長々としたコードですが、更新したいデータ（レコード）の取得はエンティティの自動フェッチ機能を利用し、フォームの生成や送信内容のデータベース反映はレコードの新規追加（こちらの記事で解説）とほぼ同じです。

エンティティの自動フェッチ

@Route("/maker_update/{id}"

public function update(Request $request, Maker $maker)

URL末尾({id})の数字と同じIDをもつエンティティを、「Maker $maker」として引数に渡すことができます。
これによってURL末尾の数字と同じIDのレコードを抽出でき、レコード別の更新ページが生成されます。

自動フェッチの詳細はこちら

【EC-CUBE 4】ID毎に詳細情報を表示するページの作り方指定IDのエンティティを取得できる『自動フェッチ』機能を使ってID別ページを作成しよう！この記事では、URLの末尾にIDを指定することで、そのIDに対応するエンティテ…

フォームの作成

use Customize\Entity\Maker;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\Extension\Core\Type\SubmitType;

更新したいEntityを宣言します。
今回は、こちらの記事で用意した「Maker.php」を使用します。

また、使いたいフォームのタイプもここで宣言します。
今回用意したTextTypeとSubmitTypeの他、EmailTypeやIntegerTypeなど多数用意されているので、フォームの種類に応じて追加・修正してください。

$form = $this->createFormBuilder($maker)
  ->add('name', TextType::class, array('label' => 'メーカー名'))
  ->add('code', TextType::class, array('label' => 'メーカーコード'))
  ->add('save', SubmitType::class, array('label' => 'Register'))
  ->getForm();

こちらの記述でフォームを作成します。
addメソッドの第一引数はテーブルの項目と一致するようにし、第二引数にフォームタイプを、第三引数にラベル名を配列で指定します。登録したい項目の数だけ「->」でaddメソッドを繋ぎます。

createFormBuilderの引数である$makerには、自動フェッチによって取得したレコードが代入されています。そのため、最終的に表示されるフォームには現在格納されている値が設定された状態で表示されます。

データ（レコード）の更新

if ($request->getMethod() == 'POST')

POST送信時（フォーム送信時）、データ（レコード）を更新する処理をこちらに記載します。

$form->handleRequest($request);
$maker = $form->getData();

フォームから受け取ったデータを取り扱うときの決まり文句。
まずhandleRequest($request)で、送信されたフォーム情報を取り扱えるようにします。続いて、getData()で送信されたフォームの値が$makerに格納されます。

$manager = $this->getDoctrine()->getManager();
$manager->flush();

「マネージャ」というクラスを使うことで、データ（レコード）の追加や更新、削除ができます。
まずgetDoctrine()->getManager()でマネージャを取得し、flush()メソッドで変更内容をデータベースに反映させます。
レコードの新規追加時に記述した$manager->persist($maker)は不要です。

作成したページのTwigを修正する

レコードの新規追加時に作成したTwigと同様に、Controllerから渡された「message」と「form」を表示するだけのシンプルなテンプレートを作成します。
Controllerから渡された情報をTwigで表示する方法についてはこちらの記事にて。

{% extends 'default_frame.twig' %}

{% block main %}

<h1>{{ message }}</h1>
{{ form_start(form) }}
{{ form_widget(form) }}
{{ form_end(form) }}

{% endblock %}

フォームの表示