PHPで動的にクラス名を指定するとオートロードできない件

PHP で動的にクラス名を指定する場合、現在いる名前空間が修飾されないため、
クラス名のみで名前空間内のクラスを指定して new するとクラスを見つけられず致命的なエラーになります。

エラーになる例

クラスファイルのパス構成

例えば PSR-0 規約に準拠して以下のような構成で Car クラスと CarCreator クラスを配置していたとします。

  • /var/www/sample/Vendor/SampleVendor/Entity
    • Car.php
    • CarCreator.php

Car.php

SampleVendor\Entity の名前空間に Car クラスを定義します。

<?php
namespace SampleVendor\Entity

class Car {}

CarCreator.php

この状態で Car クラスと同じ名前空間の CarCreator クラスから Car クラスのインスタンスを生成してみます。(autoload.php は既に読み込まれている状態とします。)

<?php
namespace SampleVendor\Entity

class CarCreator {
    public function create() {
        // 🙆🏻‍♀️ OKパターン:
        // 暗黙的に現在の名前空間が修飾され、問題なくインスタンスの生成ができる
        $car = new Car();

        // 🙅‍♀️ NGパターン:
        // 名前空間が修飾されずクラスが見つからないためエラー
        // Fatal error: Class 'Car' not found in /var/www/...
        $className = 'Car';
        $car = new $className();
    }
}

このエラーを解決するにはどうすればいいでしょうか?

解決方法

完全修飾形式(名前空間まで含めた完全な指定)でクラスを指定するか、Car クラスを別途 use 句で指定することで解決できます。

以下は完全修飾形式でクラスを指定する場合の例です。

<?php
namespace SampleVendor\Entity

class CarCreator {
    public function create() {
        $className = __NAMESPACE__ . '\\' . 'Car';
        $car = new $className();
    }
}

マジック定数の __NAMESPACE__ で現在の名前空間名の文字列を取得できるので、これを先頭に付けてクラスを指定します。

CakePHP3で現在のパスやURLを取得する

過去にCakePHP2でのURL取得方法をメモしましたが、CakePHP3では取得方法が変更されていましたのでメモしておきます。

View クラス(テンプレート上)で取得する場合

今までは HtmlHelper で取得していましたが、CakePHP3 では UrlHelper で取得できます。

// 絶対パスとして取得 (/controller/action/)
<?= $this->Url->build('/controller/action/') ?>

// フル URL として取得 (http://example.com/controller/action/)
<?= $this->Url->build('/controller/action/', true) ?>

通常は絶対パスで取得され、第二引数を true にすると URL として取得されます。

View 以外のクラスで取得する場合

Router クラスを使用しますが、use 句で使用することを宣言しておく必要があります。
UrlHelper::build() も最終的には同じメソッドが呼び出されるので引数の仕様は同じです。

use Cake\Routing\Router;

class HogeController extends AppController {
    public function index() {
        // フル URL として取得
        // (http://example.com/controller/action/)
        $path = Router::url('/controller/action/', true);
    }
}

Slackへのプルリクエスト通知に対応しました

以前ひそかに Bitbucket 上で Pull Request 作成やコメントをしたとき、任意の Chatwork グループチャットに通知するツール を作ったのですが、Slack チャットへの投稿にも対応しました。

上の画像が実際に Slack に通知されている場面のキャプチャ画像です。

最初は Slack 標準の外部サービス連携(Integration)でやればいいじゃん、と思ったのですが、世の中そんなに甘くなく、現状だと Bitbucket のプルリクエストの通知をサポートしていないようなのでそれを行うための補助ツールになります。

リポジトリは以下になります。

以下、つらつらと概要を書いていきます。
README.md に書いている内容とほぼ同じです。

対応しているチャットサービス

  • Slack
  • Chatwork

サポートしている通知の種類

次のプルリクエストに関するアクションをしたときにチャットへ通知されます。

  • プルリクエストの作成
  • プルリクエストのマージ
  • プルリクエストの更新
  • プルリクエストの取り下げ
  • プルリクエストに対してのコメント

簡単な通知フロー

  1. Bitbucket 上でプルリクエストの作成やマージなどを行う
  2. Bitbucket から指定した任意のサーバに対して hook post が飛ぶ
  3. 任意サーバ上のアプリケーション(今回のツール)が post を受け取り、任意のチャットサービスに通知メッセージをポスト

必要なもの

  • PHP 5.3+ (with cURL & composer)
  • Chatwork の API トークン (Chatwork に通知する場合)
  • Slack の API トークン (Slack に通知する場合)
    • トークンは Slack API のページで発行できます。
  • Bitbucket のリポジトリ (要 Admin 権限)

インストール方法

  1. Github からソース一式ダウンロード
  2. 任意サーバにソースアップロード
  3. パーミッションの修正
    • chmod -R 777 tmp
  4. 設定ファイルの配置と設定
    • Chatwork の場合:
      • cp config/chatwork.json.default config/chatwork.json
      • vim config/chatwork.json
    • Slack の場合:
      • cp config/slack.json.default config/slack.json
      • vim config/slack.json
  5. Composer で必要プラグインインストール
    • composer install
  6. Bitbucket のリポジトリ設定から Pull Request POST の hook url 設定
    • Chatwork の場合の例:
      • http://example.com/bitbucket_event_notification/gateway.php?destination_service=chatwork&room_id=1000000000
    • Slack の場合の例:
      • http://example.com/bitbucket_event_notification/gateway.php?destination_service=slack&room_id=C1234567890

gateway.php が受け付ける GET パラメータ一覧

キー 説明 Chatwork の場合の値の例 Slack の場合の値の例
destination_service 通知先チャットサービス chatwork slack
room_id 通知先のチャットルームID (チャンネル) 1000000000 #bitbucket, C1234567890
  • room_id の指定に # が含まれる場合は URL エンコードが必要
    • 例: #bitbucket -> %23bitbucket

個人的な事情など

普段メインで使うチャットが Chatwork から Slack に変わった関係で Chatwork のほうの動作確認が手薄になってます。もし不具合などあればコメント or PR お待ちしてます。

また、プルリクエストのマージ、更新、取り下げの際に Pull Request へのリンクが無いのは仕様となっています。Approve / UnApprove の hook request に至っては、「どれかのプルリクエストに対して Approve / UnApprove された」という情報しか分からないという謎仕様になっていて、あえて通知の実装をしていません :(

Bitbucket アカウントを持ってる人は是非 issue にアクセスして vote をぽちっとお願いしますw
site / master / issues / #8340 – Pull Request POST hook does not include links to related objects (BB-9535) — Bitbucket

2015/08/19 03:19 – リポジトリの url が変更になったため更新しました。