PHPackages                             streamx/ingestion-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. streamx/ingestion-client

ActiveLibrary

streamx/ingestion-client
========================

PHP ingestion client for StreamX - a Digital Experience Data Mesh.

1.0.8(5mo ago)0297↓100%1Apache-2.0PHPCI passing

Since Dec 5Pushed 4mo ago2 watchersCompare

[ Source](https://github.com/streamx-dev/streamx-ingestion-php)[ Packagist](https://packagist.org/packages/streamx/ingestion-client)[ RSS](/packages/streamx-ingestion-client/feed)WikiDiscussions main Synced today

READMEChangelog (7)Dependencies (4)Versions (9)Used By (1)

StreamX PHP Ingestion Client
============================

[](#streamx-php-ingestion-client)

StreamX PHP Ingestion Client enables publishing and unpublishing data to and from StreamX via its REST Ingestion Service.

Requirements
============

[](#requirements)

PHP 7.4 or higher

Compatibility
=============

[](#compatibility)

As of 2024-11-07, the supported version of StreamX is 0.0.45.

Main entry points:
==================

[](#main-entry-points)

- [StreamxClientBuilders](src/Builders/StreamxClientBuilders.php) - with which it's possible to create default or customized clients,
- [StreamxClient](src/StreamxClient.php) - with which it's possible to create publishers
- [Publisher](src/Publisher/Publisher.php) - with which it's possible to make actual ingestions (publishing and unpublishing)

Example usage:
==============

[](#example-usage)

```
// Check current schema for the channel where you want to publish/unpublish, using appropriate StreamX endpoint.
// Save the fully qualified name of the channel schema to a variable. Example:
$channelSchemaName = 'dev.streamx.blueprints.data.PageIngestionMessage';

// Create some test content that matches the channel schema. It can be created as an associative array:
$pageData = ['content' => ['bytes' => 'Hello, StreamX!']];

// It can also be created as a PHP object that follows the same schema:
class Page
{
  public $content;

  public function __construct(Content $content) {
    $this->content = $content;
  }
}

class Content
{
  public $bytes;

  public function __construct(string $bytes) {
    $this->bytes = $bytes;
  }
}
$pageData = new Page(new Content('Hello, StreamX!'));

// Create the client and a publisher dedicated to a specific channel:
$ingestionClient = StreamxClientBuilders::create('http://localhost:8080')->build();
$pagesPublisher = $ingestionClient->newPublisher("pages", $channelSchemaName);

// Publish data
$pagesPublisher->publish('index.html', $pageData);

// Unpublish data (payload is not needed)
$pagesPublisher->unpublish('index.html');

// To pass customized event time and properties, use the send(Message) method:
$message = (Message::newPublishMessage('index.html', $pageData))
    ->withEventTime(1731498686)
    ->withProperties(['prop-1' => 'value-1', 'prop-2' => 'value-2'])
    ->build();
$pagesPublisher->send($message);
```

Installation
============

[](#installation)

The recommended way to install the client is through [Composer](https://getcomposer.org/).

```
composer require streamx/ingestion-client
```

Run tests with coverage
=======================

[](#run-tests-with-coverage)

1. Install xdebug (with version that supports PHP 7.4):

```
pecl install xdebug-3.1.5
```

2. Configure xdebug mode:

```
export XDEBUG_MODE=coverage
```

3. Run tests with coverage and open results in web browser:

```
./vendor/bin/phpunit --coverage-text --coverage-html target/coverage-report
open target/coverage-report/index.html
```

###  Health Score

37

—

LowBetter than 84% of packages

Maintenance73

Regular maintenance activity

Popularity14

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 78.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~51 days

Recently: every ~73 days

Total

7

Last Release

159d ago

Major Versions

0.0.1 → 1.0.02024-12-13

### Community

Maintainers

![](https://www.gravatar.com/avatar/97482613b0345a3b8d10906f2cc1658014c4e39e31b00ce6433c929b2a44e894?d=identicon)[marekczajkowski](/maintainers/marekczajkowski)

---

Top Contributors

[![stan-r-ds](https://avatars.githubusercontent.com/u/165791712?v=4)](https://github.com/stan-r-ds "stan-r-ds (15 commits)")[![adam-bienkowski-ds](https://avatars.githubusercontent.com/u/71756561?v=4)](https://github.com/adam-bienkowski-ds "adam-bienkowski-ds (2 commits)")[![hamster-bay](https://avatars.githubusercontent.com/u/141230116?v=4)](https://github.com/hamster-bay "hamster-bay (2 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/streamx-ingestion-client/health.svg)

```
[![Health](https://phpackages.com/badges/streamx-ingestion-client/health.svg)](https://phpackages.com/packages/streamx-ingestion-client)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
