Skip to content

Commit d4e8706

Browse files
authored
Cleanup naming (#7)
* naming cleanup * update release
1 parent c1152ea commit d4e8706

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+151
-148
lines changed

content/about/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ draft: false
88
[![Supported Kafka versions: >= 0.9](https://img.shields.io/badge/kafka-%3E%3D%200.9-blue.svg)](https://github.com/edenhill/librdkafka/blob/master/INTRODUCTION.md#broker-version-compatibility)
99
![Supported PHP versions: 7.x .. 8.x](https://img.shields.io/badge/php-7.x%20..%208.x-blue.svg)
1010
[![License: BSD-3](https://img.shields.io/badge/License-BSD--3-green.svg)](https://github.com/php-kafka/php-simple-kafka-client/blob/main/LICENSE)
11+
[![Join the chat at https://gitter.im/php-kafka/php-simple-kafka-client](https://badges.gitter.im/php-kafka/php-simple-kafka-client.svg)](https://gitter.im/php-kafka/php-simple-kafka-client?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
1112

1213
This extension provides ways to interact with Apache Kafka.
1314
You can find some examples for producer and consumer [here](https://github.com/php-kafka/php-kafka-examples/tree/main/src/ext-php-simple-kafka-client)

content/configuration/dump.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Dumps the current configuration
1212

1313
## Example
1414
```php
15-
$conf = new Kafka\Configuration();
15+
$conf = new SimpleKafkaClient\Configuration();
1616
$conf->set('auto.offset.reset', 'earliest');
1717
$conf->dump();
1818
```

content/configuration/set.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ Set a configuration value
1212

1313
## Example
1414
```php
15-
$conf = new Kafka\Configuration();
15+
$conf = new SimpleKafkaClient\Configuration();
1616
$conf->set('auto.offset.reset', 'earliest');
1717
```

content/configuration/setDrMsgCb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ the message was succesfully delivered or permanently failed delivery
1414

1515
## Example
1616
```php
17-
$conf = new Kafka\Configuration();
17+
$conf = new SimpleKafkaClient\Configuration();
1818
$conf->setDrMsgCb(
1919
function (Producer $kafka, Message $message) {
2020
if (RD_KAFKA_RESP_ERR_NO_ERROR !== $message->err) {

content/configuration/setErrorCb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ that non-critical errors will be retried by `libdrkafka`
1313

1414
## Example
1515
```php
16-
$conf = new Kafka\Configuration();
16+
$conf = new SimpleKafkaClient\Configuration();
1717
$conf->setErrorCb(
18-
function (Kafka\Kafka $kafka, $errorCode, $reason) {
18+
function (SimpleKafkaClient\Kafka $kafka, $errorCode, $reason) {
1919
//do something
2020
}
2121
);

content/configuration/setLogCb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Set a log callback
1212
You will get events according to the `log_level` setting
1313
## Example
1414
```php
15-
$conf = new Kafka\Configuration();
15+
$conf = new SimpleKafkaClient\Configuration();
1616
$conf->setLogCb(
17-
function (Kafka\Kafka $kafka, int $level, string $facility, string $message) {
17+
function (SimpleKafkaClient\Kafka $kafka, int $level, string $facility, string $message) {
1818
//do something
1919
}
2020
);

content/configuration/setOffsetCommitCb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ this callback will be called with `err == RD_KAFKA_RESP_ERR__NO_OFFSET`
1515
which is not to be considered an error.
1616
## Example
1717
```php
18-
$conf = new Kafka\Configuration();
18+
$conf = new SimpleKafkaClient\Configuration();
1919
$conf->setOffsetCommitCb(
20-
function (Kafka\Kafka $kafka, int $errorCode, array $topicPartition) {
20+
function (SimpleKafkaClient\Kafka $kafka, int $errorCode, array $topicPartition) {
2121
if (RD_KAFKA_RESP_ERR_NO_ERROR === $errorCode) {
2222
echo 'Commit was successful';
2323
} else {

content/configuration/setRebalanceCb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ to the application's callback.
1919

2020
## Example
2121
```php
22-
$conf = new Kafka\Configuration();
22+
$conf = new SimpleKafkaClient\Configuration();
2323
$conf->setRebalanceCb(
24-
function (Kafka\Consumer $kafka, int $errorCode, array $partitions = null) {
24+
function (SimpleKafkaClient\Consumer $kafka, int $errorCode, array $partitions = null) {
2525
case RD_KAFKA_RESP_ERR__ASSIGN_PARTITIONS:
2626
$kafka->assign($partitions);
2727
break;

content/configuration/setStatsCb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Set a statistics callback
1212
The statistics callback is triggered every `statistics.interval.ms` (needs to be configured separately).
1313
## Example
1414
```php
15-
$conf = new Kafka\Configuration();
15+
$conf = new SimpleKafkaClient\Configuration();
1616
$conf->setStatsCb(
17-
function (Kafka\Kafka $kafka, string $json, int $jsonLength) {
17+
function (SimpleKafkaClient\Kafka $kafka, string $json, int $jsonLength) {
1818
//do something
1919
}
2020
);

content/consumer/__construct.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ public function __construct(Configuration $configuration) {}
1010
Get a consumer instance
1111
## Example
1212
```php
13-
$conf = Kafka\Configuration();
13+
$conf = SimpleKafkaClient\Configuration();
1414
$conf->set('metadata.broker.list', 'kafka:9092');
15-
$consumer = new Kafka\Consumer($conf);
15+
$consumer = new SimpleKafkaClient\Consumer($conf);
1616
```

0 commit comments

Comments
 (0)