更新日: 2015年10月14日
PHP & CakePHP

CakePHP3でコントローラーの共通処理(コンポーネント)

CakePHP3 で Controller の Component（コントローラーで共通して使うコンポーネント）を作成していたところ、以下のエラーに遭遇しました。


Fatal error: Class 'Component' not found

Fatal error: Class 'Component' not found

CakePHP 3 についてはまだウェブ上の情報が少ないこともあって、解決するのに苦労したのでメモ。Rails でもそうですけど、名前空間の解決とかロードパスとか、その辺りはウェブアプリケーションフレームワークのはまりやすい箇所のように感じます。

【お知らせ】英単語を画像イメージで楽に暗記できる辞書サイトを作りました。英語学習中の方は、ぜひご利用ください！

画像付き英語辞書 Imagict | 英単語をイメージで暗記
【開発記録】
英単語を画像イメージで暗記できる英語辞書サービスを作って公開しました

— 環境 —
CakePHP 3.1.1
PHP 5.5.19

コントローラーのコンポーネント作成

CakePHP でコントローラーで使いまわしたいような共通の処理は、src/Controller/Component 以下に作成する。例として、挨拶のコンポーネント（GreetingComponent）を作成してみます。

src/Controller/Component/GreetingComponent.php

<?php
namespace App\Controller\Component;

use Cake\Controller\Component;

class GreetingComponent extends Component {
     public function hello() {
          return "hello world!";
     }
}

<?php

namespace App\Controller\Component;

use Cake\Controller\Component;

class GreetingComponent extends Component {

public function hello() {

return "hello world!";

}

hello world! を返す hello() メソッドを持つコンポーネントです。実は、この GreetingComponent での namespace と use の設定が当初上手くいかず、それが冒頭のエラー発生の原因でした。上記のように正しく書くとエラーが消えます。

コンポーネントを使うコントローラーを作成

UsersController から GreetingComponent を使います。

src/Controller/UsersController.php

<?php
namespace App\Controller;

use App\Controller\AppController;

class UsersController extends AppController
{
    public $components = ['Greeting'];

    public function hello() {
        $hello = $this->Greeting->hello();     
        $this->set('hello', $hello);
    }
}

<?php

namespace App\Controller;

use App\Controller\AppController;

class UsersController extends AppController

{

public $components = ['Greeting'];

public function hello() {

$hello = $this->Greeting->hello();

$this->set('hello', $hello);

}

$components に使うコンポーネントを配列で指定する。クラス名から Component を除いた名前で指定します。その後は、$this->Greeting でコンポーネントにアクセスできる。

ビューとルーティング

続いて、以下のビューファイルとルーティングを作成。

src/Template/Users/hello.ctp

<?= h($hello) ?>

1	<?= h($hello) ?>

config/routes.php

// Users#hello
Router::scope('/users', ['controller' => 'Users'], function ($routes) {
        $routes->connect('/hello', ['action' => 'hello']);
    }
);

// Users#hello

Router::scope('/users', ['controller' => 'Users'], function ($routes) {

$routes->connect('/hello', ['action' => 'hello']);

}

);

サーバーを起動して動作確認

CakePHP 開発環境のサーバー起動。


$ bin/cake server

$ bin/cake server

localhost:8765/users/hello にアクセスして、「hello world!」が表示されればOKです。

最初冒頭のエラーが発生した後に、色々といじって試していたら、以下のメッセージがブラウザのエラー画面で表示されました。このメッセージのおかげで、正しい namespace と use の設定の書き方が分かった。


GreetingComponent could not be found.

Error: Create the class GreetingComponent below in file: src/Controller/Component/GreetingComponent.php

<?php
namespace App\Controller\Component;

use Cake\Controller\Component;

class GreetingComponent extends Component
{

}