# phpkafka

**Repository Path**: longzhiyan/phpkafka

## Basic Information

- **Project Name**: phpkafka
- **Description**: PHP Kafka 客户端，支持 PHP-FPM、Swoole 环境使用。
- **Primary Language**: PHP
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 102
- **Forks**: 19
- **Created**: 2020-11-09
- **Last Updated**: 2024-12-13

## Categories & Tags

**Categories**: message-server

**Tags**: None

## README

# longlang/phpkafka

[![Latest Version](https://poser.pugx.org/longlang/phpkafka/v/stable)](https://packagist.org/packages/longlang/phpkafka)
[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg)](https://secure.php.net/)
[![License](https://img.shields.io/github/license/longyan/phpkafka.svg)](https://github.com/longyan/phpkafka/blob/master/LICENSE)

## Introduction

English | [简体中文](README.cn.md)

PHP Kafka client is used in PHP-FPM and Swoole.

The communication protocol is based on the JSON file in Java. PHP Kafka client supports 50 APIs, which might be one that supports the most message types ever.

> The produce and the consume of messages are implemented. The component is in developing and testing.

## Features

- [x] Support all 50 APIs
- [x] Message compression 
- [x] PHP-FPM and Swoole compatible
- [x] Producer
- [x] Consumer
- [ ] SSL
- [ ] SASL
- [ ] More features and test cases

## Environment

- PHP >= 7.1
- Kafka >= 1.0.0
- Swoole >= 4.5 (optional)

## Installation

`composer require longlang/phpkafka`

## Documentation and Examples

- [Producer](doc/producer.en.md)

- [Consumer](doc/consumer.en.md)

Refer to `examples` for code examples.