https://github.com/decodelabs/deliverance

Shared data transfer interfaces for PHP
https://github.com/decodelabs/deliverance

data-transfer input-output multiplex php

Last synced: 17 days ago
JSON representation

Shared data transfer interfaces for PHP

• Host: GitHub
• URL: https://github.com/decodelabs/deliverance
• Owner: decodelabs
• License: mit
• Created: 2021-04-09T13:08:13.000Z (almost 4 years ago)
• Default Branch: develop
• Last Pushed: 2024-09-04T21:02:05.000Z (5 months ago)
• Last Synced: 2024-12-18T16:26:57.597Z (about 1 month ago)
• Topics: data-transfer, input-output, multiplex, php
• Language: PHP
• Homepage:
• Size: 81.1 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Deliverance

[![PHP from Packagist](https://img.shields.io/packagist/php-v/decodelabs/deliverance?style=flat)](https://packagist.org/packages/decodelabs/deliverance)

[![Latest Version](https://img.shields.io/packagist/v/decodelabs/deliverance.svg?style=flat)](https://packagist.org/packages/decodelabs/deliverance)

[![Total Downloads](https://img.shields.io/packagist/dt/decodelabs/deliverance.svg?style=flat)](https://packagist.org/packages/decodelabs/deliverance)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/decodelabs/deliverance/integrate.yml?branch=develop)](https://github.com/decodelabs/deliverance/actions/workflows/integrate.yml)

[![PHPStan](https://img.shields.io/badge/PHPStan-enabled-44CC11.svg?longCache=true&style=flat)](https://github.com/phpstan/phpstan)

[![License](https://img.shields.io/packagist/l/decodelabs/deliverance?style=flat)](https://packagist.org/packages/decodelabs/deliverance)

### Shared data transfer interfaces for PHP

Deliverance is a middleware library intended to be used by other framework systems that need to manage multiplex IO operations.

_Get news and updates on the [DecodeLabs blog](https://blog.decodelabs.com)._

---

## Installation

Install via Composer:

```bash

composer require decodelabs/deliverance

```

## Usage

### Channels

Channels represent simple in / out handlers and can be written to and read from:

```php

use DecodeLabs\Deliverance;

$stream = Deliverance::openStream('path/to/file');

$stream->writeLine('Hello world');

$stream = Deliverance::openCliOutputStream(); // Same as new Deliverance\Channel\Stream(STDOUT);

$buffer = Deliverance::newBuffer();

$buffer->write('Some text to buffer');

echo $buffer->read(6); // "Some t"

```

### IO Broker

Channels can be grouped together and managed by an IO Broker -

```php

use DecodeLabs\Deliverance;

// Create a CLI IO handler

$broker = Deliverance::newBroker()

    ->addInputProvider(Deliverance::openStream(STDIN))

    ->addOutputReceiver(Deliverance::openStream(STDOUT))

    ->addErrorReceiver(Deliverance::openStream(STDERR));

// Shortcut to the above:

$broker = Deliverance::newCliBroker();

// Read line from CLI

$broker->setReadBlocking(true);

$text = $broker->readLine();

// Write it back to output

$broker->writeLine('INPUT: '.$text);

```

Once grouped, the Channels in an IO broker can be used as the interface between many different information sources; see [Systemic Unix process launcher](https://github.com/decodelabs/systemic/blob/develop/src/Systemic/Process/Launcher/Unix.php) for an example of an IO Broker managing input and output with proc_open().

## Licensing

Deliverance is licensed under the MIT License. See [LICENSE](./LICENSE) for the full license text.