php nchan client

cliente-php-nchan

Tabla de contenido

• Descripción general
• Instalación y requisitos
• Uso
  • Publicar un mensaje
  • Obtener información del canal
  • Eliminar un canal
  • Información de estado de Nchan
  • Autorizar solicitudes
• Compatibilidad con PSR-18

Descripción general

Este es un cliente PHP para https://nchan.io.

Instalación y requisitos

 composer require marein/php-nchan-client

Si desea utilizar el adaptador PSR-18, instale una biblioteca que implemente el cliente http PSR-18 (ver aquí) y una biblioteca que implemente fábricas http PSR-17 (ver aquí).

Si desea utilizar el cliente http integrado (predeterminado si no configura nada), habilite la configuración de PHP enable_url_fopen.

Uso

Los siguientes ejemplos de código utilizan el cliente http integrado.

Publicar un mensaje

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

Obtener información del 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 );
}

Eliminar un 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 ();
}

Información de estado de Nchan

Los puntos finales con la directiva nchan_stub_status se pueden consultar de la siguiente manera.

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 solicitudes

Los puntos finales con la directiva nchan_authorize_request deben estar autorizados. El constructor del cliente http integrado toma una implementación de tipo Credenciales. Esta biblioteca viene con 2 implementaciones integradas, BasicAuthenticationCredentials y 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 );
}

Si utiliza otro cliente http a través del adaptador PSR-18, el cliente http respectivo tiene sus propios puntos de extensión para modificar la solicitud antes de enviarla.

Compatibilidad con PSR-18

Esta biblioteca viene con un adaptador compatible con PSR-18. Hay buenas razones para no utilizar el cliente integrado. Se basa en el contenedor de flujo http y file_get_contents . Esto cierra la conexión TCP después de cada solicitud. Otros clientes, ver más abajo, pueden mantener la conexión abierta.

El siguiente ejemplo utiliza guzzlehttp/guzzle y 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 ()
        )
    );
}

El siguiente ejemplo de código utiliza symfony/http-client y 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
        )
    );
}