Поделиться через


Использование центров уведомлений из PHP

Вы можете получить доступ ко всем функциям Центров уведомлений из серверной части Java/PHP/Ruby с помощью интерфейса REST Концентратора уведомлений, как описано в разделе MSDN.

В этом разделе показано, как:

Клиентский интерфейс

Основной клиентский интерфейс может предоставлять те же методы, которые доступны в пакете SDK для центров уведомлений .NET, это позволяет напрямую переводить все учебники и примеры, доступные на этом сайте, и материалы, которыми делится сообщество в Интернете.

Вы можете найти весь код, доступный в примере оболочки REST PHP.

Например, чтобы создать клиент, выполните приведенные ниже действия.

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

Чтобы отправить системное уведомление iOS:

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

Внедрение

Если вы еще не сделали этого, следуйте инструкциям из [руководства по началу работы] до последнего раздела, в котором необходимо реализовать серверную часть. Кроме того, если вы хотите использовать код из примера оболочки REST PHP и перейти непосредственно к разделу "Завершение работы".

Все сведения о реализации полной оболочки REST можно найти на сайте MSDN. В этом разделе описана реализация PHP основных шагов, необходимых для доступа к конечным точкам REST Центров уведомлений:

  1. Анализ строки подключения
  2. Сгенерировать токен авторизации
  3. Выполнение 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);
            }
        }
    }
}

Создание маркера безопасности

См. документацию Azure для получения сведений о том, как создать маркер безопасности SAS.

Добавьте метод generateSasToken в класс NotificationHub для создания токена на основе URI текущего запроса и учетных данных, извлеченных из строки подключения.

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).

Ознакомьтесь с документацией по 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-запрос /messages POST в конечную точку центра уведомлений с правильным текстом и заголовками для отправки уведомления.

Пройдите учебный курс

Теперь вы можете выполнить руководство по началу работы, отправив уведомление из серверной части 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);

Андроид

$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 должен создать уведомление, отображающееся на целевом устройстве.

Дальнейшие шаги

В этом разделе мы показали, как создать простой клиент REST PHP для центров уведомлений. Здесь вы сможете:

  • Скачайте полный пример оболочки REST PHP, содержащий весь приведенный выше код.
  • Продолжайте изучать функцию тегов Центров уведомлений в [Breaking News tutorial]
  • Узнайте о push-уведомлениях для отдельных пользователей в [руководстве по уведомлениям пользователей]

Дополнительные сведения см. в центре разработчиков PHP.

Отправка push-уведомлений в приложения iOS с помощью Azure Notification Hubs