{"id":15025698,"url":"https://github.com/byrnedo/php-nats-streaming","last_synced_at":"2025-08-21T15:31:55.891Z","repository":{"id":56951580,"uuid":"110111234","full_name":"byrnedo/php-nats-streaming","owner":"byrnedo","description":"Client for nats streaming server in php","archived":false,"fork":false,"pushed_at":"2017-12-04T15:38:25.000Z","size":124,"stargazers_count":45,"open_issues_count":8,"forks_count":21,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-12-07T10:51:33.644Z","etag":null,"topics":["message-queue","messaging","nats-streaming-server","php","php71"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/byrnedo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-09T12:14:38.000Z","updated_at":"2024-11-04T19:33:30.000Z","dependencies_parsed_at":"2022-08-21T03:40:27.885Z","dependency_job_id":null,"html_url":"https://github.com/byrnedo/php-nats-streaming","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/byrnedo%2Fphp-nats-streaming","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/byrnedo%2Fphp-nats-streaming/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/byrnedo%2Fphp-nats-streaming/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/byrnedo%2Fphp-nats-streaming/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/byrnedo","download_url":"https://codeload.github.com/byrnedo/php-nats-streaming/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230520390,"owners_count":18238948,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["message-queue","messaging","nats-streaming-server","php","php71"],"created_at":"2024-09-24T20:02:51.314Z","updated_at":"2024-12-20T01:15:07.782Z","avatar_url":"https://github.com/byrnedo.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PHP Nats Streaming Server Client\n\n## Build\n\n| Master  | Develop |\n| ------------- | ------------- |\n| [![Build Status](https://travis-ci.org/byrnedo/php-nats-streaming.svg?branch=master)](https://travis-ci.org/byrnedo/php-nats-streaming)  | [![Build Status](https://travis-ci.org/byrnedo/php-nats-streaming.svg?branch=develop)](https://travis-ci.org/byrnedo/php-nats-streaming)  |\n\n## Coverage\n\n| Master  | Develop |\n| ------------- | ------------- |\n| [![Coverage Status](https://coveralls.io/repos/github/byrnedo/php-nats-streaming/badge.svg?branch=master)](https://coveralls.io/github/byrnedo/php-nats-streaming?branch=master)  | [![Coverage Status](https://coveralls.io/repos/github/byrnedo/php-nats-streaming/badge.svg?branch=develop)](https://coveralls.io/github/byrnedo/php-nats-streaming?branch=develop)  |\n\n\n\n## Intro\n\nA php client for [Nats Streaming Server](https://nats.io/documentation/streaming/nats-streaming-intro/).\n\n\nUses [phpnats](https://github.com/repejota/phpnats) under the hood and closesly resembles it's api.\n\n\n## Requirements\n\n* php 5.6+\n* [stan](https://github.com/nats-io/nats-streaming-server)\n\n\n## Installation\n\nGet [composer](https://getcomposer.org/):\n```bash\ncurl -O http://getcomposer.org/composer.phar \u0026\u0026 chmod +x composer.phar\n```\n\nAdd php-nats-streaming as a dependency to your project\n\n```bash\nphp composer.phar require 'byrnedo/php-nats-streaming:^0.2.4'\n```\n\n## Usage\n\n### Publish\n```php\n$options = new \\NatsStreaming\\ConnectionOptions();\n$options-\u003esetClientID(\"test\");\n$options-\u003esetClusterID(\"test-cluster\");\n$c = new \\NatsStreaming\\Connection($options);\n\n$c-\u003econnect();\n\n// Publish\n$r = $c-\u003epublish('special.subject', 'some serialized payload...');\n\n// optionally wait for the ack\n$gotAck = $r-\u003ewait();\nif (!$gotAck) {\n    ...\n}\n\n$c-\u003eclose();\n\n```\n\n#### Note\n\nIf publishing many messages at a time, you might at first do this:\n\n```php\nforeach ($req as $data){\n    $r = $c-\u003epublish(...);\n    $gotAck = $r-\u003ewait();\n    if (!$gotAck) {\n        ...\n    }\n}\n```\n\nIt's actually *much* faster to do the following:\n\n```php\n$rs = [];\nforeach ($req as $data){\n    $rs[] = $c-\u003epublish(...);\n}\n\nforeach ($rs as $r){\n    $r-\u003ewait();\n}\n```\n\n### Subscribe\n```php\n$options = new \\NatsStreaming\\ConnectionOptions();\n$c = new \\NatsStreaming\\Connection($options);\n\n$c-\u003econnect();\n\n$subOptions = new \\NatsStreaming\\SubscriptionOptions();\n$subOptions-\u003esetStartAt(\\NatsStreamingProtos\\StartPosition::First());\n\n$sub = $c-\u003esubscribe('special.subject', function ($message) {\n    // implement\n}, $subOptions);\n\n$sub-\u003ewait(1);\n\n// not explicitly needed\n$sub-\u003eunsubscribe(); // or $sub-\u003eclose();\n\n$c-\u003eclose();\n\n```\n\nIf you want to subscribe to multiple channels you can use `$c-\u003ewait()`:\n\n```php\n...\n\n$c-\u003econnect();\n\n...\n\n$sub = $c-\u003esubscribe('special.subject', function ($message) {\n    // implement\n}, $subOptions);\n$sub2 = $c-\u003esubscribe('special.subject', function ($message) {\n    // implement\n}, $subOptions);\n\n$c-\u003ewait();\n```\n\n### Queue Group Subscribe\n```php\n$options = new \\NatsStreaming\\ConnectionOptions();\n$c = new \\NatsStreaming\\Connection($options);\n\n$c-\u003econnect();\n\n$subOptions = new \\NatsStreaming\\SubscriptionOptions();\n$sub = $c-\u003equeueSubscribe('specialer.subject', 'workgroup', function ($message) {\n    // implement\n}, $subOptions);\n\n\n$sub-\u003ewait(1);\n\n// not explicitly needed\n$sub-\u003eclose(); // or $sub-\u003eunsubscribe();\n\n$c-\u003eclose();\n\n```\n\n### Manual Ack\n```php\n\n$options = new \\NatsStreaming\\ConnectionOptions();\n$c = new \\NatsStreaming\\Connection($options);\n\n$c-\u003econnect();\n\n$subOptions = new \\NatsStreaming\\SubscriptionOptions();\n$subOptions-\u003esetManualAck(true);\n\n$sub = $c-\u003esubscribe('special.subject', function ($message) {\n    $message-\u003eack();\n}, $subOptions);\n\n$sub-\u003ewait(1);\n\n$c-\u003eclose();\n\n```\n\n## License\n\nMIT, see [LICENSE](LICENSE)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbyrnedo%2Fphp-nats-streaming","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbyrnedo%2Fphp-nats-streaming","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbyrnedo%2Fphp-nats-streaming/lists"}