コンポーネント

コンポーネントはコントローラ間で共有されるロジックのパッケージです。 CakePHP には、様々な共通のタスクを支援するための素晴らしいコアコンポーネントが用意されています。 あなた独自のコンポーネントも作成できます。もしコントローラ間でコピー＆ペーストしたい箇所が あった場合、その機能を含むコンポーネントの作成を検討しましょう。コンポーネントを作成することで、 コントローラのコードを綺麗に保ち、プロジェクト間のコードの再利用につながります。

各コアコンポーネントの詳細はそれぞれの章で説明します。詳しくは、 コンポーネント を参照してください。 ここでは、独自のコンポーネントを作成する方法を紹介します。

コンポーネントの設定

コアコンポーネントの多くは設定を必要としています。コンポーネントが設定を必要としている例は、 認証 や Cookie などにあります。 これらのコンポーネントと普通のコンポーネントの設定は大抵の場合、 $components 配列かコントローラの beforeFilter() メソッドで行われます。

class PostsController extends AppController
{
    public $components = [
        'Auth' => [
            'authorize' => ['controller'],
            'loginAction' => [
                'controller' => 'users',
                'action' => 'login',
            ],
        ],
        'Cookie' => ['name' => 'CookieMonster'],
    ];
}

これは $components 配列でコンポーネントを設定している例です。 すべてのコアコンポーネントはこの方法で設定することができます。 さらに、コントローラの beforeFilter() メソッドで設定することもできます。 これは関数の結果をコンポーネントのプロパティに設定する時に役に立ちます。 上記は、次のように表現することもできます。

public function beforeFilter()
{
    $this->Auth->authorize = ['controller'];
    $this->Auth->loginAction = [
        'controller' => 'users',
        'action' => 'login',
    ];

    $this->Cookie->name = 'CookieMonster';
}

しかし、コンポーネントのオプションをコントローラの beforeFilter() が 実行される前に設定することが可能な場合もあります。 つまり、コンポーネントの中には $components 配列にオプションを設定することが できるものがあります。

public $components = [
    'DebugKit.Toolbar' => ['panels' => ['history', 'session']],
];

各コンポーネントがどのような設定オプションを提供しているかは関連ドキュメントを参照してください。

共通設定の一つに className オプションがあります。このオプションを使うとコンポーネントに 別名をつけられます。この機能は $this->Auth や他のコンポーネントの参照を独自実装に 置き換えたい時に便利です。

// src/Controller/PostsController.php
class PostsController extends AppController
{
    public $components = [
        'Auth' => [
            'className' => 'MyAuth',
        ],
    ];
}

// src/Controller/Component/MyAuthComponent.php
class MyAuthComponent extends AuthComponent
{
    // コア AuthComponent を上書きするコードを追加して
}

上記の例ではコントローラにて MyAuthComponent に $this->Auth という 別名 をつけています。

NOTE

別名を付けられたコンポーネントはコンポーネントが使われるあらゆる場所のインスタンスを置き換えます。 これは、他のコンポーネントの内部を含みます。

コンポーネントの使用

一旦、コンポーネントをコントローラに読込んでしまえば、使うのは非常に簡単です。 使用中の各コンポーネントはコントローラのプロパティのように見えます。 もし、 SessionComponent と CookieComponent を コントローラに読込んだ場合、以下のようにアクセスすることができます。

class PostsController extends AppController
{
    public $components = ['Session', 'Cookie'];

    public function delete()
    {
        if ($this->Post->delete($this->request->data('Post.id'))) {
            $this->Session->setFlash('Post deleted.');

            return $this->redirect(['action' => 'index']);
        }
    }
}

NOTE

モデルとコンポーネントの両方がコントローラにプロパティとして追加されるので、それらは同じ 「名前空間」を共有します。コンポーネントとモデルに同じ名前をつけないように注意して下さい。

コンポーネントの動的ロード

すべてのコントローラアクションで全コンポーネントを使えるようにする必要はないかもしれません。 このような状況では、実行時に コンポーネントコレクション を 使ってコンポーネントを読込むことができます。コントローラ内部から以下のようにできます。

$this->OneTimer = $this->Components->load('OneTimer');
$this->OneTimer->getTime();

NOTE

コンポーネントを動的にロードした場合、初期化メソッドが実行されないことを覚えておいて下さい。 このメソッドで読込んだ場合、ロード後に手動で実行する必要があります。

コンポーネントのコールバック

コンポーネントはまた、いくつかのリクエストライフサイクルにリクエストライフサイクルが増すような コールバックを提供します。コンポーネントが提供するコンポーネントの詳細については、 Component Api の基本を参照して下さい。

コンポーネントを作成する

アプリケーションの様々な箇所で複雑な数学的処理を必要としているオンラインアプリケーションを仮定して下さい。 これから、コントローラの様々な箇所で使うための共有ロジックを集約するためのコンポーネントを作成します。

はじめに、新しいコンポーネントファイルとクラスを作成します。 src/Controller/Component/MathComponent.php にファイルを作成して下さい (従来の app/ レイアウトでは app/Controller/Component/ に作成します)。 コンポーネントの基本構造は以下のようになります。

// src/Controller/Component/MathComponent.php
class MathComponent extends Component
{
    public function doComplexOperation($amount1, $amount2)
    {
        return $amount1 + $amount2;
    }
}

NOTE

すべてのコンポーネントは Component を継承しなければなりません。 継承されていない場合、例外が発生します。

コントローラの中にコンポーネントを読み込む

一旦コンポーネントが完成してしまえば、コントローラの $components 配列にあるコンポーネント名 (Component の部分を削除する) を置き換えることで使えるようになります。 コントローラはそのコンポーネントに由来する新しいプロパティを自動的に与えられ、 そのプロパティを通してコンポーネントのインスタンスにアクセスできます。

/* 標準の $this->Session と同様に新しいコンポーネントを
   $this->Math で利用できるようにします。*/
public $components = ['Math', 'Session'];

AppController の中で宣言されているコンポーネントは他のコントローラで宣言されているコンポーネントと マージされます。同じコンポーネントを二度宣言する必要はありません。

コントローラの中でコンポーネントを読み込む時、コンポーネントのコンストラクタに渡すバラメータを 宣言することもできます。このパラメータはコンポーネントによって処理することができます。

public $components = [
    'Math' => [
        'precision' => 2,
        'randomGenerator' => 'srand',
    ],
    'Session',
    'Auth',
];

上記の例では precision と randomGenerator を含む配列が MathComponent::__construct() の 第二引数として渡されます。コンポーネントのパブリックプロパティや引数として渡される設定はその配列に 基づいた値になります。

コンポーネントの中で他のコンポーネントを使用する

作成しているコンポーネントから他のコンポーネントを使いたい時がたまにあります。その場合、 作成中のコンポーネントから他のコンポーネントを読み込むことができ、その方法はコントローラから $components 変数を使って読み込む場合と同じです。

// src/Controller/Component/CustomComponent.php
class CustomComponent extends Component
{
    // 実装中のコンポーネントが使っている他のコンポーネント
    public $components = ['Existing'];

    public function initialize(Controller $controller)
    {
        $this->Existing->foo();
    }

    public function bar()
    {
        // ...
    }
}

// src/Controller/Component/ExistingComponent.php
class ExistingComponent extends Component
{
    public function foo()
    {
        // ...
    }
}

NOTE

コントローラから読み込んだコンポーネントと違い、コンポーネントからコンポーネントを読み込んだ場合は、 コールバックが呼ばれないことに注意して下さい。

コンポーネント API

class Component

method Component::__construct(ComponentCollection $collection, $settings = [])

コールバック

method Component::initialize(Controller $controller)

method Component::startup(Controller $controller)

method Component::beforeRender(Controller $controller)

method Component::shutdown(Controller $controller)

method Component::beforeRedirect(Controller $controller, $url, $status=null, $exit=true)