イベントシステム¶

// イベントの前に実行される任意の設定ファイルやコードの一部の中で
use Cake\Event\EventManager;

EventManager::instance()->on(
    'Model.Order.afterPlace',
    $aCallback
);

EventManager::instance()->setEventList(new EventList());

$eventsFired = EventManager::instance()->getEventList();
$firstEvent = $eventsFired[0];

use Cake\Log\Log;

$this->Orders->getEventManager()->on('Model.Order.afterPlace', function ($event) {
    Log::write(
        'info',
        'A new order was placed with id: ' . $event->getSubject()->id
    );
});

$events = [
    'email-sending' => 'EmailSender::sendBuyEmail',
    'inventory' => [$this->InventoryManager, 'decrement'],
];
foreach ($events as $callable) {
    $eventManager->on('Model.Order.afterPlace', $callable);
}

// 保存操作の前に、以下を作成することが
// できます。 config/bootstrap.php で、
use Cake\ORM\TableRegistry;
// メールを送信する場合
use Cake\Mailer\Email;

TableRegistry::getTableLocator()->get('ThirdPartyPlugin.Feedbacks')
    ->getEventManager()
    ->on('Model.afterSave', function($event, $entity)
    {
        // 例えば、管理者のメールを送信することができます。
        // 3.4 より前は from()/to()/subject() メソッドを使用してください。
        $email = new Email('default');
        $email->setFrom('[email protected]' => 'Your Site')
            ->setTo('[email protected]')
            ->setSubject('New Feedback - Your Site')
            ->send('Body of message');
    });

// EventManager にリスナーを追加
$this->getEventManager()->on('User.Registration', [$this, 'userRegistration']);
$this->getEventManager()->on('User.Verification', [$this, 'userVerification']);
$this->getEventManager()->on('User.Authorization', [$this, 'userAuthorization']);

// アプリケーションのどこか別の場所で
$events = $this->getEventManager()->matchingListeners('Verification');
if (!empty($events)) {
    // 'Verification' イベントリスナーが存在する場合のロジックを実行。
    // 例えば、存在するリスナーを削除。
    $this->getEventManager()->off('User.Verification');
} else {
    // 'Verification' イベントリスナーが存在しない場合のロジックを実行。
}

// コールバックの優先順位を設定
$callback = [$this, 'doSomething'];
$this->getEventManager()->on(
    'Model.Order.afterPlace',
    ['priority' => 2],
    $callback
);

// リスナーの優先順位を設定
class UserStatistic implements EventListenerInterface
{
    public function implementedEvents()
    {
        return [
            'Model.Order.afterPlace' => [
                'callable' => 'updateBuyStatistic',
                'priority' => 100
            ],
        ];
    }
}

$this->getEventManager()
    ->dispatch(new Event('View.afterRender', $this, ['view' => $viewFileName]));

function (Event $event, $viewFileName)

public function doSomething($event)
{
    // ...
    return false; // イベントを中止
}

public function updateBuyStatistic($event)
{
    // ...
    $event->stopPropagation();
}

public function place($order)
{
    $event = new Event('Model.Order.beforePlace', $this, ['order' => $order]);
    $this->getEventManager()->dispatch($event);
    if ($event->isStopped()) {
        return false;
    }
    if ($this->Orders->save($order)) {
        // ...
    }
    // ...
}

// リスナーコールバック
public function doSomething($event)
{
    // ...
    $alteredData = $event->getData('order') + $moreData;
    return $alteredData;
}

// 別のリスナーコールバック
public function doSomethingElse($event)
{
    // ...
    $event->setResult(['order' => $alteredData] + $this->result());
}

// イベントの結果を使用
public function place($order)
{
    $event = new Event('Model.Order.beforePlace', $this, ['order' => $order]);
    $this->getEventManager()->dispatch($event);
    if (!empty($event->getResult()['order'])) {
        $order = $event->getResult()['order'];
    }
    if ($this->Orders->save($order)) {
        // ...
    }
    // ...
}

// 関数の追加
$this->getEventManager()->on('My.event', [$this, 'doSomething']);

// 関数の削除
$this->getEventManager()->off('My.event', [$this, 'doSomething']);

// 無名関数の追加
$myFunction = function ($event) { ... };
$this->getEventManager()->on('My.event', $myFunction);

// 無名関数の削除
$this->getEventManager()->off('My.event', $myFunction);

// EventListener の追加
$listener = new MyEventLister();
$this->getEventManager()->on($listener);

// リスナーから単一のイベントキーを削除
$this->getEventManager()->off('My.event', $listener);

// リスナーで実装された全てのコールバックを削除
$this->getEventManager()->off($listener);