https://github.com/eosnewmedia/php-com-view-client
PHP client implementation for ComView-API
https://github.com/eosnewmedia/php-com-view-client
Last synced: 8 months ago
JSON representation
PHP client implementation for ComView-API
- Host: GitHub
- URL: https://github.com/eosnewmedia/php-com-view-client
- Owner: eosnewmedia
- License: mit
- Created: 2019-01-29T13:53:17.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-23T06:59:16.000Z (almost 6 years ago)
- Last Synced: 2025-01-02T23:14:25.116Z (9 months ago)
- Language: PHP
- Size: 26.4 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# eos/php-com-view-client
PHP client implementation for ComView-API.
# Installation
Install this library via composer:
composer require eos/com-view-client
# Configuration
This assumes you have implemented the [PSR 17](https://www.php-fig.org/psr/psr-17) and [PSR 18](https://www.php-fig.org/psr/psr-18) interfaces that are passed as dependencies:
Psr\Http\Client\ClientInterface;
Psr\Http\Message\RequestFactoryInterface;
Psr\Http\Message\StreamFactoryInterface;
Psr\Http\Message\UriFactoryInterface;
Create a new instance of `Eos\ComView\Client\ComViewClient`. This will be the entry point for the application.
```php
$client = new Eos\ComView\Client\ComViewClient(
$baseUrl,
$psrHttpClient,
$psrUriFactory,
$psrRequestFactory,
$psrStreamFactory
);
```
# Usage
This library provides 2 methods to send view- and command-requests.
### Eos\ComView\Client\ComViewClient::requestView($viewRequest)
`Eos\ComView\Client\ComViewClient::requestView($viewRequest)` expects an instance of `Eos\ComView\Client\Model\ViewRequest` and returns an instance of `Eos\ComView\Client\Model\ViewResponse`.
```php
$viewRequest = new Eos\ComView\Client\Model\ViewRequest(
$viewName, //string
$headers, //array
$parameters, //array
$pagination, //array
$orderBy //string|null
);
$response = $client->requestView($viewRequest);
```
### Eos\ComView\Client\ComViewClient::executeCommands($commandRequests)
`Eos\ComView\Client\ComViewClient::executeCommands($commandRequest)` expects an instances of `Eos\ComView\Client\Model\CommandRequest` and returns an instance of `Eos\ComView\Client\Model\CommandResponse`.
The command instances in request and response are the same objects, which will be updated during the execution.
```php
$commandRequest = new Eos\ComView\Client\Model\CommandRequest(
[
new Eos\ComView\Client\Model\Command(/*...*/),
new Eos\ComView\Client\Model\Command(/*...*/),
],
$headers // array
);
$response = $client->executeCommands($commandRequest);
```