コンポーネント¶

はじめに¶

コンポーネントは複数のコントローラ間で共有されるロジックのパッケージです。もし複数のコントローラ間でコピー＆ペーストしたいものがある場合、コンポーネントに何らかの機能をラッピングするうことを考えるかもしれません。

CakePHP はコアコンポーネントとしていくつかすばらしいものがあります。次のようなことを目的として使用することができます。

• セキュリティ(Security)

• セッション(Sessions)

• 認可(Access control lists)

• メール(Emails)

• クッキー(Cookies)

• 認証(Authentication)

• リクエスト処理(Request handling)

これらのそれぞれのコアコンポーネントは、各章で詳細を説明します。ここでは自分専用のコンポーネントの作成方法を示します。コンポーネントを作成するとコントローラのコードがすっきりし、複数のプロジェクト間で再利用できるコードになります。

コンポーネントの設定¶

コアコンポーネントの多くは、設定が必要です。設定が必要なコンポーネントの例としては、認証、 クッキー、 電子メールが挙げられます。これらのコンポーネントと一般的なコンポーネントの設定は普通、コントローラの beforeFilter() メソッドで行います。

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

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

これは、コンポーネント変数の設定を、コントローラの beforeFilter()> で行う例です。

こうすることは確かに可能なのですが、オプションの設定をbeforeFilter()が実行される前に必要とするコンポーネントがあります。このために、いくつかのコンポーネントは$components配列でオプションの設定をすることができるようになっています。

var $components = array('DebugKit.toolbar' => array('panels' => array('history', 'session'));

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

コンポーネントはbeforeRenderとbeforeRedirectコールバックを持つことができます。これはそれぞれ、ページがレンダリングされる前とリダイレクトする前に実行されます。

コンポーネントのenabledプロパティをfalseに指定することでコールバックの起動を無効化することができます。

Component callbacks¶

While components provide a way to create reusable controller code, that performs a specific task. Components also offer a way to hook into the general application flow. There are 5 built-in hooks, and more can be created dynamically using Component::triggerCallback.

The core callbacks are:

• initialize() is fired before the controller's beforeFilter, but after models have been constructed.

• startup() is fired after the controllers' beforeFilter, but before the controller action.

• beforeRender() is fired before a view is rendered.

• beforeRedirect() is fired before a redirect is done from a controller. You can use the return of the callback to replace the url to be used for the redirect.

• shutdown() is fired after the view is rendered and before the response is returned.

You can add additional methods to your components, and call those methods at any time by using Component::triggerCallback(). If you had added a onAccess callback to your components. You could fire that callback from within the controller by calling $this->Component->triggerCallback('onAccess', $this);

You can disable the callbacks triggering by setting the enabled property of a component to false.

独自のコンポーネントを作成する¶

仮に、作成するオンラインアプリケーションが、いたる所で複雑な数学的処理を実行する必要があるとします。コンポーネントを作成し、これを共有ロジックとしてまとめて、複数のコントローラで使用することができます。

最初のステップは、新規にコンポーネントファイルとクラスを作成することです。/app/controllers/components/math.php にファイルを作成します。コンポーネントの基本構造は次のようになります。

<?php

class MathComponent extends Object {
    function doComplexOperation($amount1, $amount2) {
        return $amount1 + $amount2;
    }
}

?>

/* 標準コンポーネントの $this->Session と同様に
$this->Math でアクセスできる新しいコンポーネントを作成します。 */
var $components = array('Math', 'Session');

var $components = array(
    'Math' => array(
        'precision' => 2,
        'randomGenerator' => 'srand'
    ),
    'Session', 'Auth'
);

<?php
class CheckComponent extends Object {
    //called before Controller::beforeFilter()
    function initialize(&$controller) {
        // saving the controller reference for later use
        $this->controller =& $controller;
    }

    //called after Controller::beforeFilter()
    function startup(&$controller) {
    }

    function redirectSomewhere($value) {
        // utilizing a controller method
        $this->controller->redirect($value);
    }
}
?>

<?php
class MyComponent extends Object {

    // This component uses other components
    var $components = array('Session', 'Math');

    function doStuff() {
        $result = $this->Math->doComplexOperation(1, 2);
        $this->Session->write('stuff', $result);
    }

}
?>

<?php
class MathComponent extends Object {
    function doComplexOperation($amount1, $amount2) {
        return $amount1 + $amount2;
    }

    function doUberComplexOperation ($amount1, $amount2) {
        $userInstance = ClassRegistry::init('User');
        $totalUsers = $userInstance->find('count');
        return ($amount1 + $amount2) / $totalUsers;
    }
}
?>

<?php

class ParentComponent extends Object {
    var $name = "Parent";
    var $components = array( "Child" );

    function initialize(&$controller) {
        $this->Child->foo();
    }

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

<?php
class ChildComponent extends Object {
    var $name = "Child";

    function initialize(&$controller) {
        $this->Parent->bar();
    }

    function foo() {
        // ...
    }
}