Como usar Hubs de Notificação do PHP

Você pode acessar todos os recursos dos Hubs de Notificação a partir de um back-end Java/PHP/Ruby usando a interface REST do Hub de Notificação, conforme descrito no tópico do MSDN APIs REST dos Hubs de Notificação.

Neste tópico mostramos como:

Construir um cliente REST para recursos de Hubs de Notificação em PHP;
Siga o Enviar notificações por push para apps iOS usando Hubs de Notificação do Azure para a plataforma móvel de sua escolha, implementando a parte de back-end em PHP.

Interface do cliente

A interface principal do cliente pode fornecer os mesmos métodos que estão disponíveis no SDK dos Hubs de Notificação do .NET, que permite traduzir diretamente todos os tutoriais e exemplos atualmente disponíveis neste site e contribuídos pela comunidade na Internet.

Você pode encontrar todo o código disponível no exemplo de wrapper PHP REST.

Por exemplo, para criar um cliente:

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

Para enviar uma notificação nativa do iOS:

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

Execução

Se você ainda não o fez, siga o [Tutorial de introdução] até a última seção onde você tem que implementar o back-end. Além disso, se você quiser, você pode usar o código do exemplo de wrapper PHP REST e ir diretamente para a seção Complete the tutorial .

Todos os detalhes para implementar um wrapper REST completo podem ser encontrados no MSDN. Nesta seção, descrevemos a implementação PHP das principais etapas necessárias para acessar os pontos de extremidade REST dos Hubs de Notificação:

Analisar a cadeia de conexão
Gerar o token de autorização
Executar a chamada HTTP

Analisar a cadeia de conexão

Aqui está a classe principal implementando o cliente, cujo construtor que analisa a cadeia de conexão:

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);
            }
        }
    }
}

Criar um token de segurança

Consulte a documentação do Azure para obter informações sobre como criar um token de segurança SAS.

Adicione o generateSasToken método à NotificationHub classe para criar o token com base no URI da solicitação atual e nas credenciais extraídas da cadeia de conexão.

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;
}

Enviar uma notificação

Primeiro, vamos definir uma classe que representa uma notificação.

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;
    }
}

Essa classe é um contêiner para um corpo de notificação nativo, ou um conjunto de propriedades no caso de uma notificação de modelo, e um conjunto de cabeçalhos, que contém formato (plataforma nativa ou modelo) e propriedades específicas da plataforma (como propriedade de expiração da Apple e cabeçalhos WNS).

Consulte a documentação das APIs REST dos Hubs de Notificação e os formatos específicos das plataformas de notificação para todas as opções disponíveis.

Armado com essa classe, agora podemos escrever os métodos de notificação de envio dentro da NotificationHub classe:

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);
    }
}

Os métodos acima enviam uma solicitação HTTP POST para o /messages ponto de extremidade do seu hub de notificação, com o corpo e os cabeçalhos corretos para enviar a notificação.

Conclua o tutorial

Agora você pode concluir o tutorial Get Started enviando a notificação de um back-end PHP.

Inicialize o cliente dos Hubs de Notificação (substitua a cadeia de conexão e o nome do hub conforme as instruções no [Tutorial de introdução]):

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

Em seguida, adicione o código de envio dependendo da sua plataforma móvel de destino.

Windows Store e Windows Phone 8.1 (não 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);

Androide

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

Windows Phone 8.0 e 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);

Executar seu código PHP deve produzir agora uma notificação aparecendo no seu dispositivo de destino.

Próximos passos

Neste tópico, mostramos como criar um cliente PHP REST simples para Hubs de Notificação. A partir daqui, você pode:

Faça o download do exemplo completo de wrapper PHP REST, que contém todo o código acima.
Continue a aprender sobre o recurso de marcação dos Hubs de Notificação no [Tutorial de Últimas Notícias]
Saiba mais sobre notificações por push para usuários individuais em [Tutorial Notificar usuários]

Para obter mais informações, consulte também o PHP Developer Center.

Enviar notificações por push para aplicativos iOS usando os Hubs de Notificação do Azure

Feedback

Esta página foi útil?

Last updated on 2025-04-02