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

オリジナルテーブルのレコードを削除する方法

データベースに追加したオリジナルテーブルのデータ(レコード)を削除するには?

この記事では、データベースに新規作成したテーブルのデータ(レコード)を、Web上から削除する方法について解説しています。
こちらの記事 の続き(オリジナルテーブル『dtb_Maker』を新規作成し、いくつかレコードを追加した状態)からの手順となります。)

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

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

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

目次

実装後の状態

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

このうち、ID = 1のレコードを削除します。

レコード削除前のテーブル
『dtb_Maker』テーブルの中身

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

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

レコード削除ページ
メーカー情報を削除する専用ページ

『Delete』ボタンをクリックすると、該当のレコードがテーブルから削除されます。

レコード削除後のデータベース
『dtb_Maker』テーブルから、id = 1 のレコードが消えています。

実装までの手順

新規作成と同様に、エンティティ削除のためのフォームを用意します。フォームには削除したいレコードの中身が表示されており、ボタンをクリックするとそのレコードが削除されます。(前項の通り。)

データ(レコード)を削除するためのページを作成する

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

新規ページは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 MakerDeleteController extends AbstractController
{
  /**
   * @Route("/maker_delete/{id}", name="maker_delete")
   * @Template("maker_delete.twig")
   */
  public function delete(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' => 'Delete'))
      ->getForm();

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

長々としたコードですが、削除したいデータ(レコード)の取得はエンティティの自動フェッチ機能を利用し、フォームの生成やレコードの削除はレコードの追加(こちらの記事で解説)または更新(こちらの記事で解説)とほぼ同じです。

エンティティの自動フェッチ
@Route("/maker_delete/{id}"
public function delete(Request $request, Maker $maker)

URL末尾({id})の数字と同じIDをもつエンティティを、「Maker $maker」として引数に渡すことができます。
これによってURL末尾の数字と同じ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' => 'Delete'))
  ->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->remove($maker);
$manager->flush();

「マネージャ」というクラスを使うことで、データ(レコード)の追加や更新、削除ができます。
まずgetDoctrine()->getManager()でマネージャを取得します。次にマネージャの「remove」メソッドを使って、引数に指定したエンティティを削除します。最後に、flush()メソッドで変更内容をデータベースに反映させます。

作成したページの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 %}
フォームの表示
{{ form_start(form) }}

<form>タグ生成に相当するもので、最初に記述します。


{{ form_widget(form) }}

引数のformに組み込まれている、<input>タグ関係がすべて書き出されます。


{{ form_end(form) }}

</form>タグ生成に相当するもので、最後に記述します。

キャッシュの削除

ここまでで準備完了です。
管理画面からキャッシュを削除して、ページにアクセスしてみましょう。

キャッシュ管理からキャッシュを削除できます。

冒頭でお見せしたような削除ページが表示され、「Delete」ボタンでレコードが削除されればOKです!

レコード削除ページ
ID = 1 のメーカー情報を削除するページ画面

【おまけ】管理ユーザーのみアクセスできるようする

本記事で作成したページは、URLさえ知っていれば誰でもアクセス可能で、レコードの削除も自由にできてしまいます。

以下記事で、管理画面にログインした場合のみアクセスできるよう制限をかける方法を紹介しています。本記事と合わせての実装がお薦めです。

まとめ

以上、Webページからデータベースのデータ(レコード)を削除する方法を紹介しました。

様々なクラスやメソッドが出てきて混乱しそうですが、記述内容はレコードを新規追加する場合や更新する場合と大きく変わりません。ぜひ応用してもらえればと思います!

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

この記事を書いた人

ノベルティグッズのECサイトを運営する中小企業役員。
本ブログを通じ、販促向けの最新/ロングセラー商品紹介やWebサイト制作に役立つ技術情報を発信しています。

目次