【EC-CUBE 4】オリジナルテーブルをデータベースに新規で追加する方法

オリジナルテーブルの追加方法

仕入先リストなど、デフォルトでは用意されていないオリジナルのテーブルを作るには?

この記事では、EC-CUBE 4でデータベースに新規テーブルを追加する方法を、実例を交えつつ解説しています。
なお、既存のテーブルに新しい項目(カラム)を追加する方法は こちらの記事 で解説しています。

なおデータベースの操作には、サーバーにSSH接続してコマンド入力する必要があります。
慣れていないとSSH接続までが大変かと思いますが、データベースをカスタマイズできるとやれることがグンと増えるので、ぜひトライしてほしいと思います。

SSH接続方法(Xserver)

もしレンタルサーバーのXserverを使っていれば、以下記事でSSH接続方法を解説しています。

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

目次

商品のメーカー情報を管理する『dtb_Maker』を作成してみる

実際に新規テーブルを追加する例として、メーカー情報を管理する『dtb_Maker』 という名前のテーブルをデータベースに追加してみます。

新規テーブル作成後のデータベース
データベースに『dtb_Maker』を新規作成した状態。手順は次項にて。
新規テーブルの構造
『dtb_Maker』のテーブル構造。メーカー名(name)やメーカーコード(code)を格納できるシンプルな構造です。

実はちょっと記述ミスをしまして、メーカーコード(code)は短い文字列(8字まで)にするつもりが、4,000字まで格納できるデータ型になってしまいました。
こちらの記事 でテーブルを修正しています。テーブルの修正方法について知りたい方はどうぞ。

新規テーブルの追加手順

  1. 新規テーブルのEntityファイル(Maker.php)を作成し、サーバーにアップ。
  2. サーバーにSSH接続し、PHPのバージョンを7.4に設定。(すでに7.4の場合はスキップ)
  3. コマンドでキャッシュをクリアしてから、SQLを実行。

このうち①は、Controllerなどのファイルをサーバーにアップするとき と同じように操作を行います。
②・③は、サーバーにSSH接続してコマンドラインで行う操作です。

ちょっと難しいですが、順々に説明します。

Entityファイルの作成

新規テーブルを作成するには、そのEntity(エンティティ)ファイルを作成してサーバーにアップする必要があります。
以下コードを記述したファイル(Maker.php)を作成し、「app/Customize/Entity」下にアップします。

<?php

namespace Customize\Entity;

use Eccube\Entity\AbstractEntity;
use Doctrine\ORM\Mapping as ORM;

/**
 * Maker
 *
 * @ORM\Table(name="dtb_Maker")
 * @ORM\InheritanceType("SINGLE_TABLE")
 * @ORM\DiscriminatorColumn(name="discriminator_type", type="string", length=255)
 * @ORM\HasLifecycleCallbacks()
 * @ORM\Entity(repositoryClass="Customize\Repository\MakerRepository")
 */
class Maker extends AbstractEntity
{
    /**
     * @var integer
     *
     * @ORM\Column(name="id", type="integer", options={"unsigned":true})
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="IDENTITY")
     */
    private $id;

    /**
     * @var string
     *
     * @ORM\Column(name="name", type="string", length=255)
     */
    private $name;

    /**
     * @var string|null
     *
     * @ORM\Column(name="code", type="string", length=4000, nullable=true)
     */
    private $code;

    /**
     * @var \DateTime
     *
     * @ORM\Column(name="create_date", type="datetimetz")
     */
    private $create_date;

    /**
     * @var \DateTime
     *
     * @ORM\Column(name="update_date", type="datetimetz")
     */
    private $update_date;

    /**
     * Get id.
     *
     * @return int
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * Set name.
     *
     * @param string $name
     *
     * @return Maker
     */
    public function setName($name)
    {
        $this->name = $name;

        return $this;
    }

    /**
     * Get name.
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Set code.
     *
     * @param string|null $code
     *
     * @return Maker
     */
    public function setCode($code = null)
    {
        $this->code = $code;

        return $this;
    }

    /**
     * Get code.
     *
     * @return string|null
     */
    public function getCode()
    {
        return $this->code;
    }

    /**
     * Set createDate.
     *
     * @param \DateTime $createDate
     *
     * @return Maker
     */
    public function setCreateDate($createDate)
    {
        $this->create_date = $createDate;

        return $this;
    }

    /**
     * Get createDate.
     *
     * @return \DateTime
     */
    public function getCreateDate()
    {
        return $this->create_date;
    }

    /**
     * Set updateDate.
     *
     * @param \DateTime $updateDate
     *
     * @return Maker
     */
    public function setUpdateDate($updateDate)
    {
        $this->update_date = $updateDate;

        return $this;
    }

    /**
     * Get updateDate.
     *
     * @return \DateTime
     */
    public function getUpdateDate()
    {
        return $this->update_date;
    }
}

コードが長くて複雑そうに見えますが割と単純で、大きく以下2つの要素から成っています。

3~16行目

エンティティを作成するときの決まり文句。
3行目のnamespaceは、このファイルを格納するディレクトリを指定すること。

17~最後

テーブルに追加したい項目(カラム)と、その項目の値を読み書きするための「set〇〇」「get〇〇」という関数を、それぞれの項目について用意。(この部分の記述がほとんど)

「id」はget関数のみ

idには「@ORM\GeneratedValue(strategy=”IDENTITY”)」という文言(アノテーション)が付いています。これは値が自動生成(自動連番)されることを示しており、値をセットする必要がありません。したがって、「id」にはset関数が不要です。

上記コードを参考にエンティティを作成する場合は、青下線部のMakerをテーブル名に合わせて変更してください。(8ヶ所あります。)

また、項目(カラム)名の変更や追加も自由にしてみてください。(追加する場合は、set関数とget関数の組み合わせも追加するのを忘れないこと。)
なお、nameとcodeに記述された「string」は格納されるデータが文字列であることを示します。もし数値のみを格納したいなら、「integer」などの数値を示す型に変更してください。

Maker.phpをアップするディレクトリ
作成したファイルは「app/Customize/Entity」下にアップ
既存テーブルに新しい項目を追加する方法の記事で作成した「ProductTrait.php」も格納されています。)

コマンドラインの操作

Entityファイルがアップできたら、次はサーバーにSSH接続して以下コマンドを入力していきます。

PHP 7.4が使えるようにする(対応済の場合はスキップ)

php -v

まずPHPのバージョンを確認しておきます。
もし上記コマンドを入力して、PHPのバージョンが7.2以下となるようであれば、PHP7.4が使えるように変更します。

Xserverを使っている場合、2022年3月時点でのPHPのバージョンは5.4になっています。
この状態では、バージョンが低いために実行できないコマンドがでてきます。

変更の仕方は環境によって異なると思いますが、Xserverの場合は こちらの記事 を参考にしてみてください。
記事内では7.2になっているので、7.4に書き換えるのをお忘れなく。

SQLを実行し、データベースに反映する

まずは以下コマンドでキャッシュを削除します。

bin/console cache:clear --no-warmup

実行すると、
[OK] Cache for the ・・・・・・・ was successfully cleared.
というような文言が表示される。

次にデータベースを更新するためのSQLコマンドを入力します。

bin/console doctrine:schema:update --dump-sql

上は確認用のコマンドで、実行する場合は「–force」を付けた以下コマンドを入力します。

bin/console doctrine:schema:update --dump-sql --force

このコマンド実行後、問題がなければ新規テーブル(今回の例では「dtb_Maker」)が追加されています。

ターミナルへ実際に入力した状態
コマンドラインの打ち込み状況

実際にデータベースを開き、「dtb_Maker」テーブルが追加されていればOKです。

新規テーブル作成後のデータベース
コマンド実行、「dtb_Maker」が追加されている

まとめ

以上、新規テーブルの作成方法について紹介しました。

簡単なテーブルであれば、本記事中のコードをベースに編集することでいくらでも作成できます。カスタマイズに挑戦したい方の参考になれば嬉しいです。

また、作成したテーブルにデータを保存したり、保存したデータをページに表示したりといった操作には、Repositoryというファイルが必要になります。本記事ではそちらのファイル作成には触れていませんが、今後記事にする予定ですので、もうしばらくお待ちください。

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

この記事を書いた人

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

目次