php nchan client

php-nchan-cliente

Índice

• Visão geral
• Instalação e requisitos
• Uso
  • Publicar uma mensagem
  • Obtenha informações do canal
  • Excluir um canal
  • Informações de status do Nchan
  • Autorizar solicitações
• Compatibilidade com PSR-18

Visão geral

Este é um cliente PHP para https://nchan.io.

Instalação e requisitos

 composer require marein/php-nchan-client

Se você quiser usar o adaptador PSR-18, instale uma biblioteca que implemente o cliente http PSR-18 (veja aqui) e uma biblioteca que implemente fábricas http PSR-17 (veja aqui).

Se você quiser usar o cliente http integrado (padrão se você não definir nada), habilite a configuração php allow_url_fopen.

Uso

Os exemplos de código a seguir usam o cliente http integrado.

Publicar uma mensagem

Mostrar código

 <?php

namespace {

    use Marein  Nchan  Api  Model  PlainTextMessage ;
    use Marein  Nchan  Nchan ;

    include ' /path/to/autoload.php ' ;

    $ nchan = new Nchan ( ' http://my-nchan-domain ' );
    $ channel = $ nchan -> channel ( ' /path-to-publisher-endpoint ' );
    $ channelInformation = $ channel -> publish (
        new PlainTextMessage (
            ' my-message-name ' ,
            ' my message content '
        )
    );

    // Nchan returns some channel information after publishing a message.
    var_dump ( $ channelInformation );
}

Obtenha informações do canal

Mostrar código

 <?php

namespace {

    use Marein  Nchan  Nchan ;

    include ' /path/to/autoload.php ' ;

    $ nchan = new Nchan ( ' http://my-nchan-domain ' );
    $ channel = $ nchan -> channel ( ' /path-to-publisher-endpoint ' );
    $ channelInformation = $ channel -> information ();

    var_dump ( $ channelInformation );
}

Excluir um canal

Mostrar código

 <?php

namespace {

    use Marein  Nchan  Nchan ;

    include ' /path/to/autoload.php ' ;

    $ nchan = new Nchan ( ' http://my-nchan-domain ' );
    $ channel = $ nchan -> channel ( ' /path-to-publisher-endpoint ' );
    $ channel -> delete ();
}

Informações de status do Nchan

Endpoints com a diretiva nchan_stub_status podem ser consultados da seguinte maneira.

Mostrar código

 <?php

namespace {

    use Marein  Nchan  Nchan ;

    include ' /path/to/autoload.php ' ;

    $ nchan = new Nchan ( ' http://my-nchan-domain ' );
    $ status = $ nchan -> status ( ' /path-to-status-location ' );
    $ statusInformation = $ status -> information ();

    var_dump ( $ statusInformation );
}

Autorizar solicitações

Os terminais com a diretiva nchan_authorize_request devem ser autorizados. O construtor do cliente http integrado utiliza uma implementação do tipo Credenciais. Esta biblioteca vem com 2 implementações integradas, BasicAuthenticationCredentials e BearerAuthenticationCredentials.

Mostrar código

 <?php

namespace {

    use Marein  Nchan  HttpAdapter  BasicAuthenticationCredentials ;
    use Marein  Nchan  HttpAdapter  BearerAuthenticationCredentials ;
    use Marein  Nchan  HttpAdapter  HttpStreamWrapperClient ;
    use Marein  Nchan  Nchan ;

    include ' /path/to/autoload.php ' ;

    // Client with basic authentication
    $ adapter = new HttpStreamWrapperClient (
        new BasicAuthenticationCredentials ( ' nchan ' , ' password ' )
    );

    // Client with bearer authentication
    $ adapter = new HttpStreamWrapperClient (
        new BearerAuthenticationCredentials ( ' my-token ' )
    );

    $ nchan = new Nchan ( ' http://my-nchan-domain ' , $ adapter );
}

Se você utilizar outro cliente http através do adaptador PSR-18, o respectivo cliente http terá seus próprios pontos de extensão para modificar a solicitação antes que ela seja enviada.

Compatibilidade com PSR-18

Esta biblioteca vem com um adaptador compatível com PSR-18. Existem boas razões para não usar o cliente integrado. É baseado no wrapper de fluxo http e file_get_contents . Isso fecha a conexão TCP após cada solicitação. Outros clientes, veja abaixo, podem manter a conexão aberta.

O exemplo a seguir usa guzzlehttp/guzzle e guzzlehttp/psr7.

Mostrar código

 <?php

namespace {

    use GuzzleHttp  Client ;
    use GuzzleHttp  Psr7  HttpFactory ;
    use Marein  Nchan  HttpAdapter  Psr18ClientAdapter ;
    use Marein  Nchan  Nchan ;

    include ' /path/to/autoload.php ' ;

    $ nchan = new Nchan (
        ' http://my-nchan-domain ' ,
        new Psr18ClientAdapter (
            new Client (),
            new HttpFactory (),
            new HttpFactory ()
        )
    );
}

O exemplo de código a seguir usa symfony/http-client e nyholm/psr7.

Mostrar código

 <?php

namespace {

    use Marein  Nchan  HttpAdapter  Psr18ClientAdapter ;
    use Marein  Nchan  Nchan ;
    use Nyholm  Psr7  Factory  Psr17Factory ;
    use Symfony  Component  HttpClient  HttpClient ;
    use Symfony  Component  HttpClient  Psr18Client ;

    include ' /path/to/autoload.php ' ;

    // Symfony itself needs an adapter to be PSR-18 compliant.
    $ httpClient = new Psr18Client (
        HttpClient:: create (),
        new Psr17Factory (),
        new Psr17Factory ()
    );

    $ nchan = new Nchan (
        ' http://my-nchan-domain ' ,
        new Psr18ClientAdapter (
            $ httpClient ,
            $ httpClient ,
            $ httpClient
        )
    );
}