コンポーネント¶

コンポーネントの設定¶

コアコンポーネントの多くは設定を必要としています。コンポーネントが設定を 必要としている例は、 AuthComponent や などにあります。これらのコンポーネントや 一般的なコンポーネントの設定は、通常、お使いのコントローラーの initialize() メソッド内で loadComponent() を使用するか、 $components 配列を介して行われます。

class PostsController extends AppController
{
    public function initialize(): void
    {
        parent::initialize();
        $this->loadComponent('RequestHandler', [
            'viewClassMap' => ['json' => 'AppJsonView'],
        ]);
        $this->loadComponent('Security', ['blackholeCallback' => 'blackhole']);
    }

}

config() メソッドを使用して、実行時にコンポーネントを設定することができます。 しばしば、コントローラーの beforeFilter() メソッドで行われます。 上記は、次のように表現することもできます。

public function beforeFilter(EventInterface $event)
{
    $this->RequestHandler->setConfig('viewClassMap', ['rss' => 'MyRssView']);
}

コンポーネントは、ヘルパーと同じように、設定データを取得および設定するために使用されている getConfig() と setConfig() メソッドを実装しています。

// 設定データの読み込み
$this->RequestHandler->getConfig('viewClassMap');

// 設定をセット
$this->Csrf->setConfig('cookieName', 'token');

コンポーネントは、ヘルパーと同じように、config() でアクセス可能な $_config プロパティーを作成するためにコンストラクターの設定で自分の $_defaultConfig プロパティーを自動的にマージします。

// src/Controller/PostsController.php
class PostsController extends AppController
{
    public function initialize(): void
    {
        $this->loadComponent('Auth', [
            'className' => 'MyAuth'
        ]);
    }
}

// src/Controller/Component/MyAuthComponent.php
use Cake\Controller\Component\AuthComponent;

class MyAuthComponent extends AuthComponent
{
    // コア AuthComponent を上書きするコードを追加
}

// コントローラーのアクションの中で
$this->loadComponent('OneTimer');
$time = $this->OneTimer->getTime();

コンポーネントの使用¶

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

class PostsController extends AppController
{
    public function initialize(): void
    {
        parent::initialize();
        $this->loadComponent('Flash');
    }

    public function delete()
    {
        if ($this->Post->delete($this->request->getData('Post.id')) {
            $this->Flash->success('Post deleted.');

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

コンポーネントの作成¶

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

はじめに、新しいコンポーネントファイルとクラスを作成します。 src/Controller/Component/MathComponent.php にファイルを作成します 。 コンポーネントのための基本的な構造は次のようになります。

namespace App\Controller\Component;

use Cake\Controller\Component;

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

// コントローラーの中で
// 標準の $this->Csrf と同様に
// 新しいコンポーネントを $this->Math として利用可能にします。
public function initialize(): void
{
    parent::initialize();
    $this->loadComponent('Math');
    $this->loadComponent('Csrf');
}

// コントローラーの中で
public function initialize(): void
{
    parent::initialize();
    $this->loadComponent('Math', [
        'precision' => 2,
        'randomGenerator' => 'srand'
    ]);
    $this->loadComponent('Csrf');
}

// src/Controller/Component/CustomComponent.php
namespace App\Controller\Component;

use Cake\Controller\Component;

class CustomComponent extends Component
{
    // あなたのコンポーネントが使っている他のコンポーネント
    public $components = ['Existing'];

    // あなたのコンポーネントに必要な、その他の追加のセットアップを実行
    public function initialize(array $config): void
    {
        $this->Existing->foo();
    }

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

// src/Controller/Component/ExistingComponent.php
namespace App\Controller\Component;

use Cake\Controller\Component;

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

$controller = $this->getController();

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

また、コンポーネントは、リクエストサイクルを増強することができる、 いくつかのリクエストライフサイクルコールバックを提供しています。

beforeFilter(EventInterface $event)¶

コントローラーの beforeFilter メソッドの前に呼び出されますが、 コントローラーのinitialize() メソッドの 後 です。

startup(EventInterface $event)¶

コントローラーの beforeFilter メソッドの後、コントローラーの現在の アクションハンドラの前に呼び出されます。

beforeRender(EventInterface $event)¶

コントローラーがリクエストされたアクションのロジックを実行した後、 ビューとレイアウトが描画される前に呼び出されます。

shutdown(EventInterface $event)¶

出力結果がブラウザーに送信される前に呼び出されます。

beforeRedirect(EventInterface $event, $url, Response $response)¶

コントローラーの redirect メソッドが呼び出された時に、 他のアクションより先に呼びだされます。このメソッドが false を返す時、 コントローラーはリクエストのリダイレクトを中断します。 $url と $response パラメーターを使用すると、リダイレクト先やレスポンスの 任意の他のヘッダーを検査や変更することができます。

コンポーネントイベントでのリダイレクトの使用¶

コンポーネントのコールバックメソッド内からリダイレクトするには、次のようにします。

public function beforeFilter(EventInterface $event)
{
    $event->stopPropagation();

    return $this->getController()->redirect('/');
}

イベントを停止することで、CakePHPに他のコンポーネントのコールバックを実行させたくないこと、 そしてコントローラがこれ以上アクションを処理してはいけないことを知らせます。 As of 4.1.0 you can raise a RedirectException to signal a redirect:

use Cake\Http\Exception\RedirectException;
use Cake\Routing\Router;

public function beforeFilter(EventInterface $event)
{
    throw new RedirectException(Router::url('/'))
}

Raising an exception will halt all other event listeners and create a new response that doesn't retain or inherit any of the current response's headers. When raising a RedirectException you can include additional headers:

throw new RedirectException(Router::url('/'), 302, [
    'Header-Key' => 'value',
]);