php nchan client

client-php-nchan

Table des matières

• Aperçu
• Installation et exigences
• Usage
  • Publier un message
  • Obtenir des informations sur la chaîne
  • Supprimer une chaîne
  • Informations sur l'état de Nchan
  • Autoriser les demandes
• Compatibilité PSR-18

Aperçu

Il s'agit d'un client PHP pour https://nchan.io.

Installation et exigences

 composer require marein/php-nchan-client

Si vous souhaitez utiliser l'adaptateur PSR-18, installez une bibliothèque qui implémente le client http PSR-18 (voir ici) et une bibliothèque qui implémente les usines http PSR-17 (voir ici).

Si vous souhaitez utiliser le client http intégré (par défaut si vous ne définissez rien), activez la configuration php allow_url_fopen.

Usage

Les exemples de code suivants utilisent le client http intégré.

Publier un message

Afficher le code

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

Obtenir des informations sur la chaîne

Afficher le code

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

Supprimer une chaîne

Afficher le code

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

Informations sur l'état de Nchan

Les points de terminaison avec la directive nchan_stub_status peuvent être interrogés comme suit.

Afficher le code

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

Autoriser les demandes

Les points de terminaison avec la directive nchan_authorize_request doivent être autorisés. Le constructeur du client http intégré prend une implémentation de type Credentials. Cette bibliothèque est livrée avec 2 implémentations intégrées, BasicAuthenticationCredentials et BearerAuthenticationCredentials.

Afficher le code

 <?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 vous utilisez un autre client http via l'adaptateur PSR-18, le client http respectif possède ses propres points d'extension pour modifier la demande avant son envoi.

Compatibilité PSR-18

Cette bibliothèque est livrée avec un adaptateur compatible PSR-18. Il existe de bonnes raisons de ne pas utiliser le client intégré. Il est basé sur le wrapper de flux http et file_get_contents . Cela ferme la connexion TCP après chaque requête. D'autres clients, voir ci-dessous, peuvent maintenir la connexion ouverte.

L'exemple suivant utilise guzzlehttp/guzzle et guzzlehttp/psr7.

Afficher le code

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

L'exemple de code suivant utilise symfony/http-client et nyholm/psr7.

Afficher le code

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