CakePHP4.0 時代への展望とこれまでの振り返り

2015年に CakePHP3.0 がリリースされたことは記憶に新しいですが、先日 CakePHP の Core Developer の @mark_story 氏により CakePHP4.0 時代への展望とこれまでの歩みの振り返りがスライドとして公開されていた ので、内容を要約してみたいと思います。

※ 以下の内容は自分が CakePHP を触っていて感じたことを元に補足している内容も含まれますのでニュアンスが異なる部分もあるかもしれません。

2.x – 3.00 アップデートの振り返り

  • 3.0.0 はとても大規模で困難なアップデートだった
  • PHP7 対応に伴うモダン化
    • フレームワークのインストール方法が composer になった
    • コアコード・モデル周りの大幅な改修
      • 連想配列地獄からの脱却・オブジェクト化
      • モデルクラスが Table と Entity クラスに分離された
  • 2.x もまだメンテンナンスされている
    • CakePHP2.7 で PHP7 にも対応した

現行版の 3.2.x – 3.3.x について

  • getter / setter 分離のため移行中の段階 (詳細は後述)
  • Middleware 対応 (PSR-7互換)
    • Request / Response の構築処理に任意の処理を挟み込める
    • PSR-7 対応に伴う Request & Response オブジェクトの不変化
      • with から始まるメソッド名のメソッドは新しいインスタンスを返す
<?php
// $response オブジェクトの内容は変わらない
$response->withHeader('X-yes', 'yes');

// 戻り値に変更が反映された状態で clone instance が返ってくるので
// もし変更したい場合は代入する。
$response = $response->withHeader('X-yes', 'yes');

3.5 で提供される新機能

  • 新しいミドルウェアの提供
    • CSRF
    • Cookies
    • Authentication
  • ルーティング設定とミドルウェアの紐付けが可能に

3.6 について

  • 4.0 リリースに向けたバージョンになる
  • 3.6 未満と下位互換性は保たれる

4.0 はどんな感じになる?

  • ベースはあくまで 3.x のまま
  • PHP7.1 以上の環境が必須に ( ! )
  • 全ての非推奨メソッドの削除
    • getter と setter の両方を兼ねたメソッドも削除される

進められている getter / setter 分離対応について

より簡単なインターフェースにしてコードの複雑さを軽減することが目的。

これまで:

  • Entity::errors()

これから:

  • Entity::getErrors()
  • Entity::setErrors()

リリース予定日は?

まだ未定だが 2017年末 〜 2018年初頭になりそう。

所感

CakePHP3 はかなり大掛かりなアップデートでしたが、CakePHP4 は PHP7.1 以上が要求されること以外は比較的シンプルなアップデートになるのではないでしょうか。

近年のモダン PHP の流れを汲みつつ堅実に進化していっているなという印象を受けました。

最近の PHP フレームワークのトレンドを見ていると Laravel に押され気味な感はありますが、CakePHP も古株のフレームワークとして安心感のあるフレームワークであることは今後も変わらないと思います。がんばれ CakePHP。

CakePHP3のMigrationsでDB接続先を切り替える方法

CakePHP3 の Migrations コマンドを使ってマイグレーションする際、DB 接続先を明示的に指定することが出来ます。

この記事の内容は、以下のように CakePHP の設定ファイルに複数の Datasource が設定されていることが前提になります。

config/app.php:

    /**
     * Connection information used by the ORM to connect
     * to your application's datastores.
     * Do not use periods in database name - it may lead to error.
     * See https://github.com/cakephp/cakephp/issues/6471 for details.
     * Drivers include Mysql Postgres Sqlite Sqlserver
     * See vendor\cakephp\cakephp\src\Database\Driver for complete list
     */
    'Datasources' => [
        'default' => [
            // 省略
        ],
        'my_other_connection' => [
            // 省略
        ]
    ],

Datasource を指定するオプション

例えば config/app.php で設定した my_other_connection の Datasource に接続する場合、以下のように -c オプションにデータソース名を指定します。

./bin/cake migrations migrate -c my_other_connection

また、以下のように接続先を指定しないとデフォルトの Datasource が使用されます。

./bin/cake migrations migrate

ただし、この方法は全てのマイグレーションファイルで指定した接続先が使用されます。マイグレーションファイルごとに接続先を切り替えたい場合は以下を参照してください。

マイグレーションファイルごとに接続先を切り替える方法

少しアナログな方法にはなりますが、少し手を加えることで実現できます。

まず、以下のように接続先ごとにフォルダを分けて、その中にマイグレーションファイルを入れておきます。

  • config/Migrations/default (default コネクション用フォルダ)
  • config/Migrations/other (my_other_connection コネクション用フォルダ)

この状態でマイグレーションをするときに -s (–source=SOURCE) オプションで上記のディレクトリを指定してマイグレーションします。

./bin/cake migrations migrate -c default -s Migrations/default

./bin/cake migrations migrate -c my_other_connection -s Migrations/other

マイグレーションの実行履歴はコネクションごとの phinxlog テーブル上で管理されるため、バッティングせずにマイグレーション出来ます。

コマンドオプション指定の組み合わせは間違えないよう注意する必要があります。

CakePHP3のBakeコマンドで生成されるファイルをカスタマイズする

TL;DR

CakePHP3 の bake コマンドで生成されるファイルの内容をカスタマイズしたい場合、対応するテンプレートファイルを src 以下にコピーして追加して内容を書き換えるだけでカスタマイズできます。

Model ファイルを bake する例

まずは通常通り Model 関連ファイルを作成するコマンドです。
テーブル名が users の場合は以下のようなコマンドを実行すると焼き上がります。

bin/cake bake model Users

実行すると以下4ファイルが生成されます。

  • src/Model/Table/UsersTable.php (Table)
  • src/Model/Entity/User.php (Entity)
  • tests/Fixture/UsersFixture.php (Fixture)
  • tests/TestCase/Model/Table/UsersTableTest.php (TestCase)

生成されるファイルの内容を一部カスタマイズする方法

上記のコマンドで生成されるファイルのコード内容を一部書き換えたい場合どうすればいいでしょうか?
例えば Table クラスファイルの内容を書き換えたい場合、以下の手順で出来ます。

  1. vendor/cakephp/bake/src/Template/Bake/Model/table.ctp にあるファイルをコピーする(通常はこのファイルを元に生成が行われる)
  2. コピーしたファイルを src/Template/Bake/Model/table.ctp に貼り付ける
  3. 貼り付けたファイルの内容の書き換えたい箇所を書き換える

この状態で bake コマンドを実行するとコピーした ctp ファイルを元にクラスファイルの生成が行われます。
Entity クラスや Controller クラスなどを書き換えたい場合も同様の方法で可能です。

ctp ファイルの書き方やその他詳しい情報は CakePHP 公式ドキュメントの Extending Bake — CakePHP Cookbook 3.x documentation を参照してください。

更にカスタマイズをしたい場合

更なるカスタマイズをしたい場合、ここでは詳しく説明しませんが bake 用の Theme Plugin を作成してそれを bake 時に有効にして適用する方法や、新しい bake コマンドオプションを作ってしまう方法などがあります。

例えば Bake\Shell\Task\SimpleBakeTask クラスを継承して FooBakeTask クラスを作成することで、以下のようなコマンドを実行できるようになります。

bin/cake bake foo

やろうと思えば専用のコマンドラインオプションの追加実装なども出来るため、かなり自由度の高いカスタマイズが出来そうです。