CakePHP3でテーブルにカラム（項目）を追加したときに変更するポイントのまとめ

2019/04/30 2019/06/08

CakePHP3でテーブルにカラムを追加したときに変更するポイント

システム開発途中でカラムの追加はよくある話

　
CakePHP3でシステムを開発するとき、Bakeを使ってベースとなる処理を作成しておくと作業を効率化することができます。
　
　
ですが、システム開発においては、途中でテーブルにカラムを追加する必要性が生まれることは日常茶飯事です。
　
開発があまり進んでいないときならば、テーブルにカラムを追加して Bakeからやり直す、という方法もありですが、相応に開発が進んでいたら、Bakeからやり直すのは非効率的ですし、バグが混入することにもなりかねません。
　
　
というわけで、テーブルにカラムを追加する前と後とで、Bakeして生成される Controller、Model、Templateファイルがどう変わるのか、を確認して、カラムを追加したときは何を変更すべきなのか、を明確にしていきます。
　
これを見て変更点をチェックすれば、カラムを追加しても抜けもれなく対応できます！
（処理の内容を理解していれば、修正すべき個所は分かるハズではあるんですが．．．）
　
　

作成するテーブルのサンプル

　
まず、最初に作成したテーブルは下記のとおりです。
　

CREATE TABLE `tests` (
 `id`          int(11) unsigned NOT NULL AUTO_INCREMENT,
 `user_id`     char(36)         NOT NULL,
 `url`         varchar(100)     NOT NULL,
 `new_url`     varchar(100)     NOT NULL,
 `created`     datetime         NOT NULL,
 `modified`    datetime         NOT NULL,
 PRIMARY KEY (`id`),
 UNIQUE KEY `new_url_text` (`new_url`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8

CREATE TABLE `tests` (

`id` int(11) unsigned NOT NULL AUTO_INCREMENT,

`user_id` char(36) NOT NULL,

`url` varchar(100) NOT NULL,

`new_url` varchar(100) NOT NULL,

`created` datetime NOT NULL,

`modified` datetime NOT NULL,

PRIMARY KEY (`id`),

UNIQUE KEY `new_url_text` (`new_url`)

) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8

　
これに対して、下記の ALTER TABLEで削除フラグのカラム「deleted」を追加します。
　

ALTER TABLE tests ADD deleted tinyint default null AFTER new_url;

1	ALTER TABLE tests ADD deleted tinyint default null AFTER new_url;

Bakeで作成されるファイル

　
Bakeを実行して作成されるファイルは、以下となります。
Bakeを再実行する際に「Do you want to overwrite? (y/n/a/q)」との確認があるファイルでもあります。
　
/src/Model/Table/TestsTable.php
/src/Model/Entity/Test.php
/tests/Fixture/TestsFixture.php
/tests/TestCase/Model/Table/TestsTableTest.php
/src/Controller/TestsController.php
/tests/TestCase/Controller/TestsControllerTest.php
/src/Template/Tests/index.ctp
/src/Template/Tests/view.ctp
/src/Template/Tests/add.ctp
/src/Template/Tests/edit.ctp
　
　
更新された内容は以下の通りとなります。
　

/src/Model/Entity/Test.php

　
13行目のコメント行が追加になっています。

 * @property int|null $deleted

1	* @property int\|null $deleted

　
34行目が追加になっています。

        'deleted' => true,

1	'deleted' => true,

/src/Model/Table/TestsTable.php

　
74、75行目が追加になっています。

        $validator
            ->allowEmptyString('deleted');

1 2	$validator ->allowEmptyString('deleted');

/src/Template/Tests/index.ctp

　
24行目が追加になっています。

                <th scope="col"><?= $this->Paginator->sort('deleted') ?></th>

1	<th scope="col"><?= $this->Paginator->sort('deleted') ?></th>

　
37行目が追加になっています。

                <td><?= $this->Number->format($test->deleted) ?></td>

1	<td><?= $this->Number->format($test->deleted) ?></td>

/src/Template/Tests/view.ctp

　
38～41行目が追加になっています。

            <th scope="row"><?= __('Deleted') ?></th>
            <td><?= $this->Number->format($test->deleted) ?></td>
        </tr>
        <tr>

<td><?= $this->Number->format($test->deleted) ?></td>

</tr>

<tr>

/src/Template/Tests/add.ctp

　
23行目が追加になっています。

            echo $this->Form->control('deleted');

1	echo $this->Form->control('deleted');

/src/Template/Tests/edit.ctp

　
29行目が追加になっています。

            echo $this->Form->control('deleted');

1	echo $this->Form->control('deleted');

/tests/Fixture/TestsFixture.php

　
22行目が追加になっています。

        'deleted' => ['type' => 'tinyinteger', 'length' => 4, 'unsigned' => false, 'null' => true, 'default' => null, 'comment' => '', 'precision' => null],

1	'deleted' => ['type' => 'tinyinteger', 'length' => 4, 'unsigned' => false, 'null' => true, 'default' => null, 'comment' => '', 'precision' => null],

　
42～52行目の、48行目が追加、45、49、50行目が変更になっています。

        $this->records = [
            [
                'id' => 1,
                'user_id' => 'bc984858-445f-4cc1-adff-65441c360e2e',
                'url' => 'Lorem ipsum dolor sit amet',
                'new_url' => 'Lorem ipsum dolor ',
                'deleted' => 1,
                'created' => '2019-04-11 22:37:23',
                'modified' => '2019-04-11 22:37:23'
            ],
        ];

$this->records = [

[

'id' => 1,

'user_id' => 'bc984858-445f-4cc1-adff-65441c360e2e',

'url' => 'Lorem ipsum dolor sit amet',

'new_url' => 'Lorem ipsum dolor ',

'deleted' => 1,

'created' => '2019-04-11 22:37:23',

'modified' => '2019-04-11 22:37:23'

];

　
　
テーブルの構造を変更しても、Controllerは変更されていません。
テーブル構造を変更した場合の対応は、Modelの Entityと Tableのファイルでした。
　
Templateも変更がありますが、こちらは、必要に応じて項目を追加するといいでしょう。
　
　

テーブル構造を変更した場合はキャッシュをクリアする

　
テーブルの構造を変更した場合は、キャッシュをクリアしましょう。
　
キャッシュのクリア方法は、CakePHP 3.3以降であれば、下記のコマンドが便利です。

$ bin/cake cache clear_all

1	$ bin/cake cache clear_all

　
詳しくは、「CakePHP3、CakePHP4のキャッシュをクリアする方法「bin/cake cache clear_all」を使う」に記事を書いていますので、参考にしてください。
　
　

関連テーブルがある時、ない時とでの記述内容の違い

　
アソシエーションしたテーブル（関連付けされたテーブル）がある場合は、関連テーブルを createする前に bakeする場合と、createしてから bakeした場合とでも作成されるファイルがやや違うことも確認しました。
　
　
差異があるファイルの内容は、以下の通りです。
　

/src/Template/Tests/add.ctp

    <ul class="side-nav">
        <li class="heading"><?= __('Actions') ?></li>
        <li><?= $this->Html->link(__('List Tests'), ['action' => 'index']) ?></li>
        <li><?= $this->Html->link(__('List Users'), ['controller' => 'Users', 'action' => 'index']) ?></li>
        <li><?= $this->Html->link(__('New User'), ['controller' => 'Users', 'action' => 'add']) ?></li>
    </ul>

<li><?= $this->Html->link(__('List Tests'), ['action' => 'index']) ?></li>

<li><?= $this->Html->link(__('List Users'), ['controller' => 'Users', 'action' => 'index']) ?></li>

<li><?= $this->Html->link(__('New User'), ['controller' => 'Users', 'action' => 'add']) ?></li>

</ul>

　
上記の 4、5行目が追加になっています。
これは、「add.ctp」の 17行目、18行目ですが、「Tests」の画面でも「Users」への関連リンクが追加されています。
　
　

            echo $this->Form->control('user_id', ['options' => $users]);
            echo $this->Form->control('url');
            echo $this->Form->control('new_url');

echo $this->Form->control('user_id', ['options' => $users]);

echo $this->Form->control('url');

echo $this->Form->control('new_url');

　
また、上記の 1行目も下記のように変更されています。
　

            // 変更前
            echo $this->Form->control('user_id');

            // 変更後
            echo $this->Form->control('user_id', ['options' => $users]);

// 変更前

echo $this->Form->control('user_id');

// 変更後

echo $this->Form->control('user_id', ['options' => $users]);

　
画面を表示させると分かるのですが、変更前はテキスト形式の入力ボックスなのですが、変更後はプルダウン形式に変更されています。
　
add.ctpと同じ様に、edit.ctp、index.ctp、view.ctpも同じような趣旨の変更が加わっています。
　
　

/src/Model/Entity/Test.php

　
16行目のコメントが下記のように変更になっています。

// 変更前
 * @property \App\Model\Entity\User $user

// 変更後
 * @property \CakeDC\Users\Model\Entity\User $user

// 変更前

* @property \App\Model\Entity\User $user

// 変更後

* @property \CakeDC\Users\Model\Entity\User $user

/src/Model/Table/TestsTable.php

　
12行目のコメントが下記のように変更になっています。

// 変更前
 * @property \App\Model\Table\UsersTable|\Cake\ORM\Association\BelongsTo $Users

// 変更後
 * @property \CakeDC\Users\Model\Table\UsersTable|\Cake\ORM\Association\BelongsTo $Users

// 変更前

* @property \App\Model\Table\UsersTable|\Cake\ORM\Association\BelongsTo $Users

// 変更後

* @property \CakeDC\Users\Model\Table\UsersTable|\Cake\ORM\Association\BelongsTo $Users

/tests/Fixture/TestsFixture.php

　
/tests/Fixture/TestsFixture.php も更新されていましたが、44、47、48行目のデータの値でしたので、ここでの説明は割愛します。
　
　
関連テーブルを作成する前後での違いを検証するつもりはありませんでした。
ですが、「tests」に CakeDC/Usersの user_idと連携させるためのカラムがあることを忘れていて、「tests」だけで Bakeをしてしまったため、「『user_id』に関連するテーブルがない」というエラーが表示されてしまいました。
　
そのため、ついでに確認をしてみることにした次第です。
　
　