2021/1/25追記: 本家にマージされました。

Xdebug: Documentation » Xdebug 2 から 3 へのアップグレード

訳の修正は、Github経由でPRを送れますので、誤訳があれば指摘お願いします。xdebug.org/upgrade_guide.html at master · xdebug/xdebug.org

私訳ですがアップグレードガイドを訳しましたので参考にどうぞ。

Gist: Xdebug 3 アップグレードガイド

Symfony のコマンドラインアプリケーションを CakePHP コマンドラインアプリケーションとして動かす方法を解説します。

（余談ここから）昨日（12/16 JST）ついに、CakePHPの次期バージョンである4.0がstableリリースされました！ > CakePHP 4.0.0 Released — Bakery
3.xから色々と整理され、さらに良いフレームワークになったと思います。（余談ここまで）

TL;DR: cakephp/migrations の実装が参考になるよ。

現在開発中のWebアプリケーションで、定時にいくつかのタスクを実行したいという要求がありました。
これまではcrontabへタスクごとに登録していましたが、今後タスク数が増えることと、実行の有無や実行時間をWebアプリ側から制御できるようにしたかったので、良い方法がないか検討していました。

そのような要件を満たすPHPライブラリとして lavary/crunz: A PHP-based job scheduler を使用すればよいのではと考えました。

このライブラリは、Symfonyのコマンドラインアプリケーションとして作られていますが、どうせならCakePHPと統合して実行できるようにしたい。というのが今回のお話です。

実は、cakephp/migrations プラグインも同じように、Symfonyアプリケーションである Phinx をCakePHPのShellでラップして動作するようになっています。

今回の実装にあたり、Migrations\Shell\MigrationsShell の手法を参考にしました。

Symfonyのコマンドラインアプリケーションを、CakePHPコマンドラインアプリケーションとして動かすためには、以下の3つを行います。

• Shell::initializeメソッドで、Symfonyアプリケーションを起動するために必要な定数などの初期化
• Shell::runCommandメソッドをオーバーライドして、Symfonyアプリケーションへコマンドラインの引数をバイパスできるようにする
• Shell::mainメソッドで、Symfonyアプリケーションを生成して実行する

以下、今回作成したラッパーである CrobJobsShell を例示として説明します。

通常、crunzは、vendor/bin/crunz のスクリプトを通じて実行します。ここにcrunzを実行するために必要な定数が定義されています。

// （前略
// @TODO Remove in v2
if (!\defined('CRUNZ_BIN_DIR')) {
    \define('CRUNZ_BIN_DIR', __DIR__);
}
if (!\defined('CRUNZ_BIN')) {
    \define('CRUNZ_BIN', __FILE__);
}
// （後略

crunz/crunz at 1.12.x · lavary/crunz

CRUNZ_BIN, CRUNZ_BIN_DIR がcrunz実行に必要な定数です。これをShellの initialize にて初期化するよう記述します。(CRUNZ_VERSIONは、このShell独自の定数です。

    public function initialize()
    {
        if (!defined('CRUNZ_BIN')) {
            define('CRUNZ_BIN', ROOT . '/vendor/bin/crunz');
        }
        // NOTE: Remove in crunz v2
        if (!defined('CRUNZ_BIN_DIR')) {
            define('CRUNZ_BIN_DIR', dirname(CRUNZ_BIN));
        }
        if (!defined('CRUNZ_VERSION')) {
            define('CRUNZ_VERSION', '1.12.2');
        }
        parent::initialize();
    }

Shell/CronJobsShell.php#L30-L44

Symfonyのコンソールアプリケーションもコマンドラインから引数を与えて実行することができます。例えばcrunzでは、

# スケジュールされたタスクの実行
vendor/bin/crunz schedule:run
# スケジュールされたタスクの表示
vendor/bin/crunz schedule:list

といったサブコマンドがあります。これをCakePHPのシェルを通しても同じように扱えるようにします。

# これで動くようにしたい
bin/cake CronJobs schedule:run
bin/cake CronJobs schedule:list

そのままですと、CakePHPのShellでは第2引数(schedule:run の部分)はサブコマンドとして解釈され、同名のメソッドが実行されてしまいます。

今回は、Symfonyアプリケーションに全てを任せたいので、CakePHPのコマンドライン引数のパースを回避し、Symfonyアプリケーションへ引数を渡してやる必要があります。

CakePHPのShellでは、runCommand メソッドにより引数のパースと実行するメソッドの決定が行われています。(Web側でいうルーティング処理)
この runCommand を書き換えることで、ルーティング処理をスキップして、Symfonyアプリケーションへ引数を渡すことができるようになります。

    public function runCommand($argv, $autoMethod = false, $extra = [])
    {
        array_unshift($argv, 'crunz');
        $this->argv = $argv;
        return parent::runCommand($argv, $autoMethod, $extra);
    }

Shell/CronJobsShell.php#L52-L61

上記のように、コマンドライン引数 $argv に、サブコマンドとして存在しない任意の文字列(今回は “crunz”)を先頭に付与することで、ルーティング処理をスキップします。

また、後で引数をSymfonyアプリケーションへ渡すために、一時的にオブジェクトプロパティに格納します。

上記の2点で、Symfonyアプリケーションを実行するための下準備が整いました。
最後に、mainメソッドでSymfonyアプリケーションの起動を行います。

    public function main()
    {
        $app = $this->getApp(); // 起動したいSymfonyアプリケーションインスタンスを取得
        $input = new ArgvInput($this->argv); // コマンドライン引数を渡す
        $app->setAutoExit(false); // 終了コードを取得するためAutoExitはoff
        $exitCode = $app->run($input, $this->getOutput()); // アプリケーションを実行
        return $exitCode === 0; // 終了コード判定
    }
    /**
     * @return \Crunz\Application
     */
    protected function getApp()
    {
        return new Application('CakePHP Cron Scheduler via Crunz', CRUNZ_VERSION);
    }
    /**
     * @return \Symfony\Component\Console\Output\ConsoleOutput
     */
    protected function getOutput()
    {
        return new ConsoleOutput();
    }

Shell/CronJobsShell.php#L69-L99

mainメソッドでは、起動したいSymfonyアプリケーションを取得して、コマンドライン引数とコンソール出力をセットして実行するだけです。
（アプリケーションインスタンス取得とコンソール出力メソッドを別メソッドにわけているのはテスト時のモック注入のためです。

また、実行結果の判定を行うためにSymfonyアプリケーションの終了ステータスコードを取得できるよう、autoExitを無効化しています。

以上のようにして作成したのが、 elstc/cakephp-cron-jobs となります。

このプラグインはCrunzの単純なラッパーですので、Crunzの機能はそのまま使えます。
また、プラグイン独自の機能として、タスクの登録はイベントを通じて行えるようになっています。

Symfonyで作成された便利なライブラリはたくさんありますので、皆さんもCakePHPと統合するプラグインを書いてみましょう。

それではクリスマスまであと1週間、今年もあと2週間。ちょっと早いですがみなさまよいお年を。

公式にヘルプがあるよ。

• Live templates – Help | PhpStorm
• ライブ・テンプレート – 公式ヘルプ | PhpStorm

CakePHPのテンプレートは素のPHPです。こんな感じですね。

<h1 class="post-title"><?= h($post->title) ?></h1>
<div class="post-content">
    <?= nl2br(h($post->body)) ?>
</div>
<?php if ($post->tags) : ?>
    <ul class="post-tags">
    <?php foreach ($post->tags as $tag) : ?>
        <li><?= h($tag->name) ?></li>
    <?php endforeach; ?>
    </ul>
<?php endif; ?>

テンプレートを書くとき、 <?= やら、 <?php if やら <?php foreach をよく書いていると思います。
毎回毎回、これを書くのだるいですよね。閉じタグまで含めると特に。

そんなときは、PhpStormのLive Templatesを使って楽をしましょう。

Preferences > Editor > Live Templates でライブテンプレートを追加します。

追加の仕方はヘルプを読んでね。

• Creating live templates – Help | PhpStorm
• ライブテンプレートを作成する – 公式ヘルプ | PhpStorm

ポイントはHTMLコンテキストでの適用にすること。ダイアログの下の方のここをクリックして設定するんだ。

pe<tabキー> で、 <?= になるように設定するよ。

Abbreviation: pe
Description: php short echo (これは説明文なので適当でいい

Template text:

<?= $END$ ?>

$END$ は、変換後にキャレットがその位置に移動するんだ。

pif<tabキー> で、 ifブロックを生成できるようにするよ。

Abbreviation: pif
Description: php if (これは説明文なので適当でいい

Template text:

<?php if ($CONDITIONS$) : ?>
    $END$
<?php endif; ?>

pfore<tabキー> で、foreachブロックを生成できるようにするよ。
これは、ライブテンプレートのPHPの中に、fore, forek があるからそれをコピーして作成するといいよ。

Abbreviation: pfore
Description: php foreach(iterable_expr as $value) {...} (これは説明文なので適当でいい

Template text:

<?php foreach ($ITERABLE$ as $VAR_VALUE$) : ?>
    $END$
<?php endforeach; ?>

Abbreviation: pforek
Description: php foreach(iterable_expr as $key => $value) {...} (これは説明文なので適当でいい

Template text:

<?php foreach ($ITERABLE$ as $VAR_KEY$ => $VAR_VALUE$) : ?>
    $END$
<?php endforeach; ?>

PhpStorm 2019.3 で、<? って入力すると <?php に展開するようになったけど、<?= を入力したいときにとても困る。
無効にするオプションは検討されているみたいだけど、実装されるまでの間は次のLive Templateを設定しておくといいかも。

Abbreviation: <?php=
Description: php short echo open (これは説明文なので適当でいい

Template text:

<?= $END$ ?>

コンテキストはPHPで。

CakePHP あんまり関係なかった。

1日目の記事は、hgsgtkさんの「来たるCakePHP 4.0 を知ろう – Qiita」でした。

TL;DR: PHP 5.6 を使っている人は paragonie/random_compat を入れましょう。

先月に、UUIDの衝突に関する話題が盛り上がりました。

10秒で衝突するUUIDの作り方 – Speaker Deck

この話のキモは、UUIDの生成に擬似乱数関数の mt_rand を使用しているとシードにより乱数が固定化するので、同じUUIDが生成されてしまうということです。

特にプログラムコード中で不用意に mt_srand を呼び出していると、衝突しやすくなります。

CakePHP にも Cake\Utility\Text::uuid というメソッドがあり、UUIDv4が生成できるようになっています。データベーステーブルでidフィールドをchar(36)で定義すると、レコード追加時にこのメソッドが呼ばれてUUIDがセットされるようになっています。

Cake\Utility\Text::uuid は、

    public static function uuid()
    {
        $random = function_exists('random_int') ? 'random_int' : 'mt_rand';
        return sprintf(
            '%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
            // 32 bits for "time_low"
            $random(0, 65535),
            $random(0, 65535),
            // 16 bits for "time_mid"
            $random(0, 65535),
            // 12 bits before the 0100 of (version) 4 for "time_hi_and_version"
            $random(0, 4095) | 0x4000,
            // 16 bits, 8 bits for "clk_seq_hi_res",
            // 8 bits for "clk_seq_low",
            // two most significant bits holds zero and one for variant DCE1.1
            $random(0, 0x3fff) | 0x8000,
            // 48 bits for "node"
            $random(0, 65535),
            $random(0, 65535),
            $random(0, 65535)
        );
    }

src/Utility/Text.php L61-83

と実装されており、random_int関数のない環境（< PHP 7.1）では、mt_rand関数が使用されます。

というわけで、Cake\Utility\Text::uuid() を使用した 衝突のサンプルコード を書いてみました。

サンプルコード抜粋

use Cake\Utility\Text;
function make_seed()
{
    list($usec, $sec) = explode(' ', microtime());
    return $sec + $usec * 1000000;
}
$repeats = isset($argv[1]) ? (int)$argv[1] : 1;
for ($i = 0; $i < $repeats; $i++) {
    mt_srand(make_seed()); // !! HAHAHAHAHHHAHA !!
    echo Text::uuid() . "\n";
}

サンプルコードでは不用意な mt_srand の使用例として、ありがちなマイクロ秒をシードとして与えています。
なお、シードとしてマイクロ秒を与えなくても mt_srand が受け取るのは32bit整数の範囲なので、「10秒で衝突するUUIDの作り方」にあるように mt_srand を呼び出している時点で65,536回試行すればだいたい衝突します。

この問題は、CakePHP 3.x を PHP5.6環境で利用している時に発生します。PHP 7.1以降では、random_int 関数が使用されるため mt_rand に起因する問題は起こりません。
（CakePHP 4では、PHP 7.2以降のためこの問題は発生しません。）

Cake\Utility\Text::uuid() の呼び出し前に、 mt_srand が存在しない場合は衝突しにくくなりますが、分散環境でPID、時間が一致する場合は同じ乱数シードとなるので同じUUIDが生成されることがあります。
（参考: https://twitter.com/zeriyoshi/status/1199639847457046529）

というわけで、UUIDv4の生成にはmt_randを使わないようにする必要があります。そのためには、PHP 5.6でも random_int 等の関数を使うことができるようになる paragonie/random_compat パッケージを入れましょう。

以下のように、

composer require "paragonie/random_compat":"^2.0|9.99.99"

としてrandom_compatをインストールすれば、PHP7以降の環境では、何もしないバージョンである v9.99.99 が入りますので、将来的にPHPをバージョンアップする場合でも安心です。

いちおう、この問題については Issue を上げていますので、将来のバージョン（3.9以降）では何らかの対策がされると思います。

Collision uuid in PHP 5.6 · Issue #13944 · cakephp/cakephp
Deprecation of mt_rand in uuid generation by nojimage · Pull Request #13958 · cakephp/cakephp

3.9以降、paragonie/random_compatが必須となり、uuid生成でmt_randは使用されなくなります。

Deprecation of mt_rand in uuid generation by nojimage · Pull Request #13958 · cakephp/cakephp

マネクラからの挑戦状 Webサイトコードゴルフ pepabo/lolipop-mc-codegolf-challenge

私の戦闘力スコアは、58655です。開催後なので非公認スコアですね。↓↓↓↓↓↓↓↓↓↓↓

phpconfuk2019-codegolf https://github.com/pepabo/lolipop-mc-codegolf-challenge

ロリポップ！マネージクラウド上に、指定のソースコードから生成されるWebサイトを設置して、それのレンダリング結果を変えずにコードを修正していき、公開ディレクトリ内のファイルサイズを小さくしていくというルールです。詳しいレギュレーションはソースコードのREADMEに書いてあってこんな感じ

## レギュレーション
- PHPで作成されたサイト https://phpconfuk-codegolf-php.lolipop.io/ （正解サイト）のソースコードをお渡しします（このリポジトリです）。
- サイトの **表示を一切変えずに** Webサイトを構成する全コード全ファイルの合計ファイルサイズを小さくして、あなたの[ロリポップ！マネージドクラウド](https://mc.lolipop.jp/)の `PHPプロジェクト` にデプロイしてください。
- 最も小さいファイルサイズになった人が優勝です
- コンテナ内の `/var/www/html` 内にWebサイトを表示するのに必要な全てのコード、およびファイルを設置してください
    - `/var/www` 等への設置は禁止です
- Makefile内の `check` タスク内のコマンドの変更は禁止です
-

pepabo/lolipop-mc-codegolf-challenge#レギュレーション

私はこんなふうにコードを小さくしていきました。

• とりあえずそのままデプロイして表示確認
• チェックスクリプトを確認
• コードを追って表示に使っているファイルを確認
• composer依存を排除
• テンプレートを圧縮
• DB依存を排除
• 画像ファイルを最適化
• HTMLから不要CSSスタイルを除去
• HTMLを短縮化

まずはスコア算出はどのようにしているのか確認します。スコア算出に使用されるコマンド make check で実行されるのはこんなコマンドでした。

check:
    @ssh -p ${SSH_PORT} ${SSH_USER}@${SSH_HOST} 'find /var/www/html -type f -not -iwholename "*/.git/*" -not -name "Makefile" -not -name ".env" | xargs cat | wc -c'

サーバー上の /var/www/html ディレクトリから、.git/ Makefile .env を除外してそのファイルサイズ合計を求めています。

※ここで.git/に表示ファイル全部入れればいいじゃないって気付いた勘のいいお子様はキライだよ

表示開始ファイルである index.php から順に読んでいって使用しているファイルを確認しました。
初期状態で表示に使用しているファイルは

• .htaccess
• index.php
• vendor/* (依存composer ライブラリ一式)
• model/token.php
• view/home.liquid
• mc.png

ということがわかりました。
それ以外で /var/ww/html にデプロイされているファイルは不要なので make deploy コマンドを修正してデプロイ時に削除するようにします。
.htaccessファイルについても中身はdisplay_errorsをonにしているだけなので表示には不要と判断しました。

インストール手順で、composer.phar をカレントディレクトリに配置する手順が書いてあり、composer.pharもデプロイされていたのでこれだけで結構減らせますね。

composer.jsonを見るとこのスクリプトは以下のライブラリに依存していることがわかりました。

    "morris/lessql": "^0.4.1",
    "vlucas/phpdotenv": "^3.4",
    "league/route": "^4.2",
    "zendframework/zend-diactoros": "^2.1",
    "zendframework/zend-httphandlerrunner": "^1.1",
    "liquid/liquid": "^1.4"

それぞれ、以下のようなライブラリです。

• vlucas/phpdotenv .envファイルのパース
• league/route, zendframework/zend-diactoros, zendframework/zend-httphandlerrunner HTTP/ルーティング関連ライブラリ
• morris/lessql SQLライブラリ
• liquid/liquid テンプレートエンジン

morris/lessqlは素のPDOを利用した書き方に変更して依存を外します。

liquid/liquid もテンプレートファイル（view/home.liquid）の {{ reversed }} という文字列を置き換えているだけなので、プレーンなPHPで置換可能です。

リクエスト周りで使用している league/route, zendframework/zend-diactoros, zendframework/zend-httphandlerrunnerは、レギュレーションのチェッカーからのリクエストを見たところ、単純にGETリクエストが送られて来ていただけのようでしたので、依存を排除しました。

vlucas/phpdotenvは、.envファイルをパースして環境変数に入れてくれるものですが、ロリポップ！マネージクラウドのコントロールパネルにはインスタンスに環境変数を設定できる機能があったので、そちらから環境変数を指定するようにして、依存を排除しました。

表示テンプレートである view/home.liquid を見ると結構なファイルサイズと無駄なCSSスタイルが仕込まれていることがわかりました。

CSSスタイルを除外していくのは時間がかかると判断し、テンプレートを圧縮した状態でアップし、実行時に展開して使用すればいいと考えました。

マネージクラウドのインスタンス上で、php -mコマンドを叩いて使える拡張モジュールを確認したところbzip2拡張が使えるようだったのでbzip2で圧縮するようにしました。

PHP: Bzip2 – Manual

bzip2コマンドで圧縮したファイルを伸張するのは bzdecompress と file_get_contents で簡単にできます。

bzdecompress(file_get_contents('v.bz2'));

ここではたと気付きます。この表示ロジックにDBは必要ないんじゃねと。
元々のロジックは以下のようなものでした。

1. tokensテーブルの全レコードを削除
2. クエリストリングとして入力されたキーと値をtokensテーブルに格納
3. 値降順、キー降順でソートしてDBからレコードを全件取得
4. 取得したレコードから3番目の値があればその値を逆から表示する、3番目の値がなければ空文字を表示する

要は、クエリストリングをキーと値でソートして、3番目の値を返せばよいのです。
というわけでこんな感じのコードになりました。

$p=$_GET;
krsort($p);
arsort($p);
$v=array_values($p);
strrev($v[2] ?? '');

もとのSQLのソートがvalue DESC, key DESC でしたので、キー→値の順にソートを掛けることで値のソート順が優先されるようにします。
krsortが与えられた連想配列をキーの逆順で並べ替える関数、arsortが与えられた連想配列を値の逆順で並べ替える関数ですね。

array_valuesで値だけの配列を取り出して、最後にPHP7から使えるnull合体演算子 ?? で、クエリストリングに2つ以下の値しか与えられなかった場合の対処をしてから、文字列を反転する関数 strrev に与えます。

Null 合体演算子

上記の最適化でコードが減り、画像ファイルのサイズがかなりのウェイトを占めるようになったので画像の最適化をしてみました。

ImageAlpha — image minifier (like JPEG with transparency!) とかを利用して画像を最適化しようとしましたが、アルファチャンネルを無くしたり色数を減らすとチェックに通らなくなったため画像の修正は断念しました。

それでも、なんやらかんやらで 59750 → 57990 に減らせました。

テンプレートファイルをみると明らかに使用していないスタイルが記述されていたので適用されているスタイルだけにクリーンアップしました。

htmlとかheadとかbodyとか属性の"などブラウザが補完してくれるタグを取っていきます。どんどん壊れていくHTMLを見てソウルジェムが黒く濁っていく気分を味わえました。

以上のような感じでコードを半日ちょっと掛けて最適化した結果が↓になります。

このチャレンジをやってみて、わりとモダンなコードをどんどんクソコードプレーンなPHPコードにしていく感じが溜まりませんでした。（汚れきった大人になった感）
また、ロリポップ！マネージクラウドを使うのは初めてだったので、これを通してコントロールパネルの感じや実行の感じを体感できてよかったです。よい問題をありがとうございました。

参考に @tenkomaさんの解答例もどうぞ PHPカンファレンス福岡2019 マネクラからの挑戦状 Webサイトコードゴルフ スコア60230(非公認)の解説 – Engineer as a Lifestyle @tenkoma

他の人の解答例ももっと見たいので、やった方はTwitterなどで晒してもらえると嬉しいです。

ネタ元: php – Composer – run scripts only in dev environment – Stack Overflow の 回答

例: phpcsの installed_paths に cakephp/cakephp-codesniffer を追加する

// (composer.json)
    "require-dev": {
        "cakephp/cakephp-codesniffer": "^3.0"
    },
    "scripts": {
        "post-install-cmd": {
            "[ $COMPOSER_DEV_MODE -eq 0 ] || phpcs --config-set installed_paths $(composer config vendor-dir)/cakephp/cakephp-codesniffer"
        }
    }

# 実行
composer install --no-dev # -> cakephp/cakephp-codesniffer はインストールされず、post-install-cmdのphpcs --config-setも実行されない
composer install # -> cakephp/cakephp-codesniffer がインストールされ、post-install-cmdのphpcs --config-setが実行される

composer のスクリプト実行時にセットされる環境変数 $COMPOSER_DEV_MODE は、--no-dev フラグがついているときに 0 それ以外は 1 がセットされるようになっています。 Defining scripts – composer

--no-dev 時は、[ $COMPOSER_DEV_MODE -eq 0 ] が真となるので、以降のスクリプトが実行されないという仕組みです。

ide-helper等をpost-*-cmdで実行するときにも使えますね。

前日の記事は chinpei215 さんの CakePHP2 のデバッグツールバーをプリチーにする – Qiita でした。

TL;DR: ControllerResolver.php – gist

CakePHP 3.4以降の話。

権限コントロールまわりのアレコレのために、URL情報からコントローラークラスを取得したかったのでやってみました。

ここで言う URL情報 とは、CakePHPの Router::url() や HtmlHelper::link() などに渡される配列や文字列のデータです。

$url = [
    'controller' => 'Users',
    'action' => 'index',
];
$url = '/users/add';

CakePHPにおいて配列形式のURL指定の場合、現在のリクエストのコンテキストが影響します。

// `/users/index` へのリクエストを扱っているとき (UsersController::add() での処理中)
$url = ['action' => 'add']; // -> controller='Users', action='add' と解釈
// `/posts/edit/1` へのリクエストを扱っているとき (PostsController::edit() での処理中)
$url = ['action' => 'add']; // -> controller='Posts', action='add' と解釈

このあたりは、 Router::url() がよろしくやってくれます。

さて、URLからコントローラーの取得ですが、CakePHPのコアでもディスパッチャー部分でURLをパースしてコントローラークラスを取得しているので、どのようにやっているか見てみましょう。

CakePHPではリクエストは以下のような流れでやってきます。

1. webroot/index.php
2. \App\Application 等で登録したmiddleware
   • RoutingMiddleware で requestオブジェクトにURLをパースした結果(controllerとかactionとか)をセット。
3. \Cake\Http\ActionDispatcher::dispatch()
4. \Cake\Http\ActionDispatcher::_invoke()
   • ここでコントローラークラスの実行

リクエストからコントローラーの生成は \Cake\Http\ActionDispatcher::dispatch() で、 \Cake\Http\ContorllerFacotry を利用して行われています。

cakephp/ActionDispatcher.php at 3.7.0 · cakephp/cakephp

\Cake\Http\ContorllerFacotry には、2つの公開メソッド、

• リクエストからコントローラーオブジェクトを生成する create(ServerRequest $request, Response $response): Controller
• リクエストからコントローラークラス名を取得する getControllerClass(ServerRequest $request): string

があります。

この \Cake\Http\ContorllerFacotry を使えば、URLからコントローラークラスを取得できそうなので、あとはメソッドに渡す ServerRequest をURLから生成できればよさそうです。

ServerRequestは、コンストラクタにURLの文字列を与えれば生成できますが、RouterクラスによるURLのパース情報を別途与える必要があります。

なので、

1. URL情報(配列/文字列)を文字列のURLに変換
2. ServerRequest オブジェクトを生成
3. Router::parseRequest() でリクエストからルーティング情報取得してリクエストに付与
4. ContorllerFacotry のメソッドにリクエストオブジェクトを渡してコントローラー取得

のようにしたら、コントローラーを取得できそうです。

コードは以下のようになります。

use Cake\Http\ControllerFactory;
use Cake\Http\Response;
use Cake\Http\ServerRequest;
use Cake\Routing\Router;
// $url は URL情報(配列/文字列)
// URL情報(配列/文字列)を文字列のURLに変換
$urlString = Router::url($url);
// `ServerRequest` オブジェクトを生成
$request = (new ServerRequest($urlString));
// `Router::parseRequest()` でリクエストからルーティング情報取得してリクエストに付与
$params = Router::parseRequest($request);
$request = $request->withAttribute('params', $params);
// コントローラー取得(オブジェクト)
$controller = (new ContorllerFacotry())->create($request, new Response());
// コントローラー取得(コントローラークラス名)
$controller = (new ContorllerFacotry())->getControllerClass($request);

以上のものをクラス化したコードを以下に上げています。

ControllerResolver.php – gist

(自分のユースケースでは、コントローラーオブジェクトが欲しかったので ContorllerFacotry::create() を使用しています。
(本当は、URLからコントローラークラスが取得したいのではなく、そのURLのコントローラーで扱っているモデルクラスが取得したかったマン。
(cakephp/authorization で、権限チェックを行っているところで、権限のない場合はリンクを表示させないとかやりたかったマン。

PHPUnit 5.7

\Awesome\GeartInterface というインターフェースから \Awesome\MockClass という名前でモッククラスを作成したい。

setMockClassNameで\Awesome\MockClassを指定すると名前空間付のクラスは作成できないと怒られる。

$mock = $this->getMockBuilder(\Awesome\GeartInterface::class)
    ->setMockClassName('\Awesome\MockClass')
    ->getMock(); // => Error!

setMockClassNameには名前空間を指定できないので class_alias で指定してやる。

$this->getMockBuilder(\Awesome\GeartInterface::class)
    ->getMock();
class_alias(get_class($mock), '\Awesome\MockClass');
$this->assertInstanceOf('\Awesome\MockClass', $mock); // => OK!

これ、CakePHP3のObjectRegistryを継承したクラスのテストで、任意のクラスがロードできることを保証するテストを書いたときに使ったです。

Authors hasMany Posts hasMany Comments のリレーションがあるとする。

Authorsから、Posts、Commentsをまとめてsaveしたい場合、通常のsaveであればassociatedに指定してやればよい。

$this->Authors->save($author, [
    'associated' => ['Posts.Comments'],
]);

通常はこれでよいとして、特殊な要件により通常はPostsまでの保存で、あるときだけCommentsも保存すると言った場合、Model.beforeSaveイベントにフックしてassociatedを書き換えることを検討する。

単純に以下のコードでは動かない。

// Listenerクラスで
public function beforeSave(Event $event, EntityInterface $entity, ArrayObject $options)
{
    $table = $event->getSubject();
    if ($table instanceof AuthorsTable) {
        $options['associated'][] = 'Posts.Comments';
    }
    return true;
}

上記だと InvalidArgumentException : Cannot save Posts.Comments, it is not associated to Authors と怒られる。

なぜならば associated オプションはbeforeSaveに入る前に正規化されているため、ドット記法ではなく以下のように配列化しておく必要がある。

public function beforeSave(Event $event, EntityInterface $entity, ArrayObject $options)
{
    $table = $event->getSubject();
    if ($table instanceof AuthorsTable) {
        $options['associated']['Posts'][] = 'Comments';
    }
    return true;
}

• setTestNow()メソッドがクラスを横断して時刻セットできるようなった！

CakePHP 3.2以降、時刻操作クラスとして cakephp/chronos が採用されています。
CakePHP内ではChronosを継承した \Cake\I18n\FrozenTime, \Cake\I18n\Time, \Cake\I18n\FrozenDate, \Cake\I18n\Date を使用でき、データベースの時刻系のフィールドはこれらのクラスへマッピングされます。

また、Chronosにはテストを容易にするためにsetTestNow()というメソッドがあり、各クラスの現在時刻を指定の時間へ固定することができます。

use \Cake\I18n\FrozenTime;
FrozenTime::setTestNow('1975-08-08 11:22:33');
$time = new FrozenTime('1 hour ago'); // 1975-08-08 12:22:33
$now = FrozenTime::now();
FrozenTime::setTestNow($now);
sleep(10); // 10秒待つ
$currentTime = FrozenTime::now(); // 固定されているので $currentTime == $now

しかし、Chronos 1.1 までは、setTestNow()は各クラスごとにセットしなければなりませんでした。
以下のようにFrozenTime::setTestNowはTimeクラスへ影響しません。

use \Cake\I18n\FrozenTime;
use \Cake\I18n\Time;
FrozenTime::setTestNow('1975-08-08 11:22:33');
$time = new FrozenTime('1 hour ago'); // 1975-08-08 12:22:33
$time = new Time('1 hour ago'); // 現在時刻の1時間後

CakePHP 3.2以降のデフォルトでは、時刻系のフィールドは FrozenTime で処理されるようになっています。
通常は FrozenTime::setTestNow で時刻セットを行えばよいのですが、1ヶ所だけ Time が使われる部分があります。

TimestampBehavior の内部では、Timeが使用されています。ですので、テスト時に FrozenTime のみ時刻を固定した状態で created などの TimestampBehavior によりセットされる時刻フィールドをみると、固定した時刻ではなく実行時の時刻が入っていることになります。

これに対処するには、FrozenTime, Time の双方にテスト時刻をセットすればよいのですが、冗長な記述となっていました。

Chronos 1.2以降、setTestNowでの設定はすべてのChronosのサブクラスへ伝播するようになりました。

use \Cake\I18n\FrozenTime;
use \Cake\I18n\Time;
FrozenTime::setTestNow('1975-08-08 11:22:33');
$time = new FrozenTime('1 hour ago'); // 1975-08-08 12:22:33
$time = new Time('1 hour ago'); // 1975-08-08 12:22:33

これにより、各時刻クラスへのsetTestNowの漏れがなくなり重複した記述を減らせるので、今すぐChronos 1.2以降へバージョンアップすることをお勧めします。