php-nchan-client
, (*1)
Table of contents, (*2)
Overview
This is a PHP client for https://nchan.io., (*3)
Installation and requirements
composer require marein/php-nchan-client
If you want to use the
PSR-18 adapter,
install a library that implements PSR-18 http client
(see here)
and a library that implements PSR-17 http factories
(see here)., (*4)
If you want to use the built-in http client (default if you don't set anything),
enable the php configuration
allow_url_fopen., (*5)
Usage
The following code examples use the built-in http client., (*6)
Publish a message
Show code
, (*7)
```php
<?php, (*8)
namespace {, (*9)
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);
}
```
, (*10)
Show code
, (*11)
```php
<?php, (*12)
namespace {, (*13)
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);
}
```
, (*14)
Delete a channel
Show code
, (*15)
```php
<?php, (*16)
namespace {, (*17)
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();
}
```
, (*18)
Endpoints with the nchan_stub_status directive can be queried as follows., (*19)
Show code
, (*20)
```php
<?php, (*21)
namespace {, (*22)
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);
}
```
, (*23)
Authorize requests
Endpoints with the nchan_authorize_request directive must be authorized.
The constructor of the
built-in http client
takes an implementation of type
Credentials.
This library comes with 2 built-in implementations,
BasicAuthenticationCredentials
and
BearerAuthenticationCredentials., (*24)
Show code
, (*25)
```php
<?php, (*26)
namespace {, (*27)
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);
}
```
, (*28)
If you use another http client through the
PSR-18 adapter,
the respective http client has its own extension points to modify the request before it is sent., (*29)
PSR-18 compatibility
This library comes with a PSR-18 compatible
adapter.
There are good reasons not to use the built-in client.
It's based on the http stream wrapper and file_get_contents.
This closes the TCP connection after each request.
Other clients, see below, can keep the connection open., (*30)
The following example uses
guzzlehttp/guzzle
and
guzzlehttp/psr7., (*31)
Show code
, (*32)
```php
<?php, (*33)
namespace {, (*34)
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()
)
);
}
```
, (*35)
The following code example uses
symfony/http-client
and
nyholm/psr7., (*36)
Show code
, (*37)
```php
<?php, (*38)
namespace {, (*39)
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
)
);
}
```
, (*40)
Wallogit.com
