CakePHP3でイベントリスナーを用いた処理の実装（＆メールやSlackでの通知）

メールコンポーネント

メールを送信するコンポーネントを作成します。Bakeコマンドでファイルを生成します。

# CakePHPのルートディレクトリへ移動する
cd /path/to/cakephp

# SendMailコンポーネントの生成
bin/cake bake component SendMail

# 実行結果
[demo@localhost cakephp]$ bin/cake bake component SendMail

Creating file /path/to/cakephp/src/Controller/Component/SendMailComponent.php
Wrote `/path/to/cakephp/src/Controller/Component/SendMailComponent.php`

Baking test case for App\Controller\Component\SendMailComponent ...

Creating file /path/to/cakephp/tests/TestCase/Controller/Component/SendMailComponentTest.php
Wrote `/path/to/cakephp/tests/TestCase/Controller/Component/SendMailComponentTest.php`

cakephp/src/Controller/Component 配下に SendMailComponent.php が生成されます。

cakephp
├─ src
│   ├─ Controller
│   │   ├─ Component
│   │   │   └─ SendMailComponent.php

実装は以下の通りです。

cakephp/src/Controller/Component/SendMailComponent.php

<?php
namespace App\Controller\Component;

use Cake\Controller\Component;
use Cake\Controller\ComponentRegistry;
use Cake\Mailer\Email;

class SendMailComponent extends Component
{
    protected $_defaultConfig = [];

    public function initialize(array $config)
    {
        $this->email = new Email('default');
    }

    public function send($message)
    {
        $this->email->from(['from@example.com' => 'CakePHP'])
            ->to('to@example.com')
            ->subject('cakephp test')
            ->send($message);
    }
}

シンプルにメッセージ（本文）を受け取って送信している処理になります。

Slackコンポーネント

次に、Slackコンポーネントを作成します。これもBakeコマンドでファイルを生成します。

# CakePHPのルートディレクトリへ移動する
cd /path/to/cakephp

# Slackコンポーネントの生成
bin/cake bake component Slack

# 実行結果
[demo@localhost cakephp]$ bin/cake bake component Slack

Creating file /path/to/cakephp/src/Controller/Component/SlackComponent.php
Wrote `/path/to/cakephp/src/Controller/Component/SlackComponent.php`

Baking test case for App\Controller\Component\SlackComponent ...

Creating file /path/to/cakephp/tests/TestCase/Controller/Component/SlackComponentTest.php
Wrote `/path/to/cakephp/tests/TestCase/Controller/Component/SlackComponentTest.php`

cakephp/src/Controller/Component 配下に SlackComponent.php が生成されます。

cakephp
├─ src
│   ├─ Controller
│   │   ├─ Component
│   │   │   ├─ SendMailComponent.php
│   │   │   └─ SlackComponent.php

実装は以下の通りです。

cakephp/src/Controller/Component/SlackComponent.php

<?php
namespace App\Controller\Component;

use Cake\Controller\Component;
use Cake\Controller\ComponentRegistry;

class SlackComponent extends Component
{
    protected $_defaultConfig = [];

    public $components = ['Exec'];

    protected $endpoint;
    protected $channel;
    protected $body;

    public function initialize(array $config)
    {
        $this->endpoint = getenv("SLACK_WEBHOOK_URL");
        $this->channel = getenv("SLACK_CHANNEL");
        $this->body =  [
            "channel" => $this->channel,
        ];
    }

    /**
     * 送信ハンドラ
     * @param $message
     */
    public function handle($message)
    {
        $this->getBody($message);
        $this->send();
    }

    /**
     * Slack通知処理
     */
    public function send()
    {
        $command = sprintf(
            "curl -X POST -H 'Content-type: application/json' --data '%s' %s",
            $this->messageEncodeJson(),
            $this->endpoint
        );
        $this->Exec->exec($command);
    }

    /**
     * 通知メッセージのエンコード
     * @return string
     */
    private function messageEncodeJson()
    {
        return json_encode($this->body, JSON_UNESCAPED_UNICODE);
    }

    /**
     * 通知メッセージ作成
     * @param $param
     */
    public function getBody($message)
    {
        $this->body =  array_merge($this->body, [
            "text" => $message,
        ]);
    }

    /**
     * メッセージフォーマット
     * @return array
     * @see https://api.slack.com/methods/chat.postMessage
     */
    private function getFormat()
    {
        return [
            "channel" => "",
            "icon_url" => "",
            "icon_emoji" => "",
            "username" => "",      // ボットのユーザー名を設定します。 as_userをfalseに設定して使用必要があります。それ以外の場合は無視します。
            "as_user" => false,    // ボットとしてではなく正式なユーザーとしてメッセージを投稿するにはtrueを渡します。 デフォルトはfalseです。
            "text" =>  "",
            "footer_icon" => "",
            "attachments" => [
                [
                    "color" => "",
                    "footer" => "",
                    "ts" => "",
                    "fields" => [
                        [
                            "title" => "",
                            "value" => "",
                            "short" => true
                        ],
                        [
                            "title" => "",
                            "value" => "",
                            "short" => true
                        ],
                        [
                            "title" => "",
                            "value" => "",
                            "short" => false
                        ]
                    ],

                ]
            ]
        ];
    }

}

getFormat()メソッドは項目参照の為だけに定義しているので今回は使用していません。

execコンポーネント

本編からは少し外れますが、Slackへ送信する際にLinuxのcurlコマンドを叩いているので、SlackComponentではexec()メソッドの為のコンポーネントを挿しています。

cakephp/src/Controller/Component/ExecComponent.php

<?php
namespace App\Controller\Component;

use Cake\Controller\Component;
use Cake\Controller\ComponentRegistry;
use Cake\Core\Exception\Exception;

/**
 * Exec component
 */
class ExecComponent extends Component
{
    protected $_defaultConfig = [];

    /**
     * exec関数を実行する
     * @param $command
     * @return mixed
     */
    public function exec($command)
    {
        $command = sprintf('%s 2>&1', $command);
        exec($command,$output, $ret);
        if($ret) {
            $message = sprintf("Command Failed [Command] %s [Error] %s", $command, $output[0]);
            throw new Exception($message);
        }
        return $output;
    }
}

これは必須ではないので、とりあえずSlack通知を試したい場合はSlackComponentを以下のように変更してください。

// 変更1
public $components = ['Exec'];
// ↓　コメントアウト、もしくは削除
// public $components = ['Exec'];

// 変更2
public function send()
{
    $command = sprintf(
        "curl -X POST -H 'Content-type: application/json' --data '%s' %s",
        $this->messageEncodeJson(),
        $this->endpoint
    );
    //$this->Exec->exec($command);
    // ↓　変更
    exec($command, $output, $result);
}