PHP から Notification Hubs を使用する方法

[アーティクル]
06/01/2023

MSDN のトピック「Notification Hubs REST API」の説明にあるように Notification Hub REST インターフェイスを使用し、Java/PHP/Ruby バックエンドから Notification Hubs のすべての機能にアクセスできます。

このトピックでは、次の方法について説明します。

PHP で Notification Hubs 機能の REST クライアントを記述します。
選択したモバイルプラットフォーム用の Azure Notification Hubs を使用した iOS アプリへのプッシュ通知の送信に関するページに従って、バックエンド部分を PHP で実装します。

クライアントインターフェイス

メインのクライアントインターフェイスは、.NET Notification Hubs SDK で使用可能なものと同じメソッドを提供できます。これを使用すると、現在このサイトで使用可能であり、インターネット上のコミュニティによって提供されたすべてのチュートリアルとサンプルを直接変換できます。

「 PHP REST wrapper sample (PHP REST ラッパーサンプル)」で利用可能なすべてのコードを検索できます。

たとえば、クライアントを作成する場合:

$hub = new NotificationHub("connection string", "hubname");

iOS ネイティブ通知を送信する場合:

$notification = new Notification("apple", '{"aps":{"alert": "Hello!"}}');
$hub->sendNotification($notification, null);

実装

まだ実行していない場合は、[入門用チュートリアル] の、最後のセクションのバックエンドを実装する必要がある箇所まで手順に従ってください。また、必要があれば「PHP REST wrapper sample (PHP REST ラッパーサンプル)」のコードを使用し、直接チュートリアルの完了セクションに進むこともできます。

REST ラッパーすべての実装の詳細については、 MSDN の記事を参照してください。このセクションでは、Notification Hubs REST エンドポイントにアクセスするために必要な主要な手順の PHP 実装について説明します。

接続文字列を解析する
認証トークンを生成する
HTTP 呼び出しを実行する

接続文字列を解析する

接続文字列を解析するコンストラクターを持つクライアントを実装するメインクラスです。

class NotificationHub {
    const API_VERSION = "?api-version=2013-10";

    private $endpoint;
    private $hubPath;
    private $sasKeyName;
    private $sasKeyValue;

    function __construct($connectionString, $hubPath) {
        $this->hubPath = $hubPath;

        $this->parseConnectionString($connectionString);
    }

    private function parseConnectionString($connectionString) {
        $parts = explode(";", $connectionString);
        if (sizeof($parts) != 3) {
            throw new Exception("Error parsing connection string: " . $connectionString);
        }

        foreach ($parts as $part) {
            if (strpos($part, "Endpoint") === 0) {
                $this->endpoint = "https" . substr($part, 11);
            } else if (strpos($part, "SharedAccessKeyName") === 0) {
                $this->sasKeyName = substr($part, 20);
            } else if (strpos($part, "SharedAccessKey") === 0) {
                $this->sasKeyValue = substr($part, 16);
            }
        }
    }
}

セキュリティトークンを作成する

SAS セキュリティトークンを作成する方法については、Azure ドキュメントを参照してください。

現在の要求の URI と接続文字列から抽出された資格情報に基づいてトークンを作成するには、NotificationHub クラスに generateSasToken メソッドを追加します。

private function generateSasToken($uri) {
    $targetUri = strtolower(rawurlencode(strtolower($uri)));

    $expires = time();
    $expiresInMins = 60;
    $expires = $expires + $expiresInMins * 60;
    $toSign = $targetUri . "\n" . $expires;

    $signature = rawurlencode(base64_encode(hash_hmac('sha256', $toSign, $this->sasKeyValue, TRUE)));

    $token = "SharedAccessSignature sr=" . $targetUri . "&sig="
                . $signature . "&se=" . $expires . "&skn=" . $this->sasKeyName;

    return $token;
}

通知を送信する

最初に、通知を表すクラスを定義します。

class Notification {
    public $format;
    public $payload;

    # array with keynames for headers
    # Note: Some headers are mandatory: Windows: X-WNS-Type, WindowsPhone: X-NotificationType
    # Note: For Apple you can set Expiry with header: ServiceBusNotification-ApnsExpiry in W3C DTF, YYYY-MM-DDThh:mmTZD (for example, 1997-07-16T19:20+01:00).
    public $headers;

    function __construct($format, $payload) {
        if (!in_array($format, ["template", "apple", "windows", "fcm", "windowsphone"])) {
            throw new Exception('Invalid format: ' . $format);
        }

        $this->format = $format;
        $this->payload = $payload;
    }
}

このクラスは、ネイティブ通知の本文、またはテンプレート通知の場合は一連のプロパティ、および形式 (ネイティブなプラットフォームまたはテンプレート) とプラットフォーム固有のプロパティ (Apple の有効期限プロパティや WNS ヘッダーなど) を含む一連のヘッダーのコンテナーです。

使用可能なすべてのオプションについては、Notification Hubs REST API のドキュメントおよび特定の通知プラットフォームの形式を参照してください。

このクラスを利用して、NotificationHub クラス内に送信通知メソッドを作成できます。

public function sendNotification($notification, $tagsOrTagExpression="") {
    if (is_array($tagsOrTagExpression)) {
        $tagExpression = implode(" || ", $tagsOrTagExpression);
    } else {
        $tagExpression = $tagsOrTagExpression;
    }

    # build uri
    $uri = $this->endpoint . $this->hubPath . "/messages" . NotificationHub::API_VERSION;
    $ch = curl_init($uri);

    if (in_array($notification->format, ["template", "apple", "fcm"])) {
        $contentType = "application/json";
    } else {
        $contentType = "application/xml";
    }

    $token = $this->generateSasToken($uri);

    $headers = [
        'Authorization: '.$token,
        'Content-Type: '.$contentType,
        'ServiceBusNotification-Format: '.$notification->format
    ];

    if ("" !== $tagExpression) {
        $headers[] = 'ServiceBusNotification-Tags: '.$tagExpression;
    }

    # add headers for other platforms
    if (is_array($notification->headers)) {
        $headers = array_merge($headers, $notification->headers);
    }

    curl_setopt_array($ch, array(
        CURLOPT_POST => TRUE,
        CURLOPT_RETURNTRANSFER => TRUE,
        CURLOPT_SSL_VERIFYPEER => FALSE,
        CURLOPT_HTTPHEADER => $headers,
        CURLOPT_POSTFIELDS => $notification->payload
    ));

    // Send the request
    $response = curl_exec($ch);

    // Check for errors
    if($response === FALSE){
        throw new Exception(curl_error($ch));
    }

    $info = curl_getinfo($ch);

    if ($info['http_code'] <> 201) {
        throw new Exception('Error sending notification: '. $info['http_code'] . ' msg: ' . $response);
    }
}

上記のメソッドは、HTTP POST 要求とともに、通知を送信するための正しい本文とヘッダーを、通知ハブの /messages エンドポイントに送信します。

チュートリアルの完了

ここで、PHP バックエンドから通知を送信して、使用についてのチュートリアルを完了できます。

Notification Hubs クライアントを初期化します ([入門用チュートリアル] の説明に従って接続文字列とハブ名を置き換えます)。

$hub = new NotificationHub("connection string", "hubname");

次に、ターゲットモバイルプラットフォームに応じて送信コードを追加します。

Windows ストアおよび Windows Phone 8.1 (非 Silverlight)

$toast = '<toast><visual><binding template="ToastText01"><text id="1">Hello from PHP!</text></binding></visual></toast>';
$notification = new Notification("windows", $toast);
$notification->headers[] = 'X-WNS-Type: wns/toast';
$hub->sendNotification($notification, null);

iOS

$alert = '{"aps":{"alert":"Hello from PHP!"}}';
$notification = new Notification("apple", $alert);
$hub->sendNotification($notification, null);

Android

$message = '{"data":{"msg":"Hello from PHP!"}}';
$notification = new Notification("fcm", $message);
$hub->sendNotification($notification, null);

Windows Phone 8.0 および 8.1 Silverlight

$toast = '<?xml version="1.0" encoding="utf-8"?>' .
            '<wp:Notification xmlns:wp="WPNotification">' .
               '<wp:Toast>' .
                    '<wp:Text1>Hello from PHP!</wp:Text1>' .
               '</wp:Toast> ' .
            '</wp:Notification>';
$notification = new Notification("windowsphone", $toast);
$notification->headers[] = 'X-WindowsPhone-Target : toast';
$notification->headers[] = 'X-NotificationClass : 2';
$hub->sendNotification($notification, null);

Kindle Fire

$message = '{"data":{"msg":"Hello from PHP!"}}';
$notification = new Notification("adm", $message);
$hub->sendNotification($notification, null);

PHP コードを実行すると、ターゲットデバイスに表示される通知が生成されます。

次の手順

このトピックでは、Notification Hubs 用のシンプルな PHP REST クライアントを作成する方法を説明します。ここでは、次の操作を実行できます。

PHP REST wrapper sample (PHP REST ラッパーサンプル)をすべてダウンロードします。サンプルには上記のコード、および登録管理のコードがすべて含まれています。
引き続き、「[ニュース速報チュートリアル]」で Notification Hubs のタグ付け機能について学習してください。
個別ユーザーへの通知のプッシュについては、「[ユーザーへの通知チュートリアル]」で学習してください。

詳細については、 PHP デベロッパーセンターも参照してください。

Azure Notification Hubs を使用して iOS アプリにプッシュ通知を送信する

次の方法で共有

PHP から Notification Hubs を使用する方法

クライアントインターフェイス

実装

接続文字列を解析する

セキュリティトークンを作成する

通知を送信する

チュートリアルの完了

Windows ストアおよび Windows Phone 8.1 (非 Silverlight)

iOS

Android

Windows Phone 8.0 および 8.1 Silverlight

Kindle Fire

次の手順

フィードバック

その他のリソース

次の方法で共有

PHP から Notification Hubs を使用する方法

クライアント インターフェイス

実装

接続文字列を解析する

セキュリティ トークンを作成する

通知を送信する

チュートリアルの完了

Windows ストアおよび Windows Phone 8.1 (非 Silverlight)

iOS

Android

Windows Phone 8.0 および 8.1 Silverlight

Kindle Fire

次の手順

フィードバック

その他のリソース

クライアントインターフェイス

セキュリティトークンを作成する