Skip to content

Commit 73a537e

Browse files
bdurkovicBojan Đurković
andauthored
Update to match rdkafka version 6.0.4 (#50)
* Update to match rdkafka version 6.0.4 * fix: the return type of KafkaConsumer::newTopic is KafkaConsumerTopic --------- Co-authored-by: Bojan Đurković <b.durkovic@inshared.nl>
1 parent 23b865d commit 73a537e

23 files changed

+192
-117
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Build Status](https://travis-ci.org/kwn/php-rdkafka-stubs.svg?branch=master)](https://travis-ci.org/kwn/php-rdkafka-stubs)
44
[![Latest Stable Version](https://poser.pugx.org/kwn/php-rdkafka-stubs/v/stable)](https://packagist.org/packages/kwn/php-rdkafka-stubs)
55

6-
This package provides you a set of stubs for [RdKafka extension](https://github.com/arnaud-lb/php-rdkafka). It currently supports version 4.0. For older verisions of rdkafka extenstion (3.x and 0.9) please use version 1.x of this repository.
6+
This package provides you a set of stubs for [RdKafka extension](https://github.com/arnaud-lb/php-rdkafka). It currently supports version 6.0. For older verisions of rdkafka extenstion (3.x and 0.9) please use version 1.x of this repository.
77

88
## Installation
99

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
}
1010
],
1111
"require": {
12-
"ext-rdkafka": ">=4.0"
12+
"ext-rdkafka": ">=6.0"
1313
},
1414
"require-dev": {
1515
"phpunit/phpunit": "^8.2.4"

stubs/RdKafka.php

Lines changed: 51 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
use RdKafka\Metadata;
55
use RdKafka\Topic;
66
use RdKafka\TopicConf;
7-
use RdKafka\Queue;
7+
use RdKafka\TopicPartition;
88

99
abstract class RdKafka
1010
{
@@ -13,7 +13,7 @@ abstract class RdKafka
1313
*
1414
* @return int
1515
*/
16-
public function addBrokers($broker_list)
16+
public function addBrokers(string $broker_list): int
1717
{
1818
}
1919

@@ -25,14 +25,14 @@ public function addBrokers($broker_list)
2525
* @throws Exception
2626
* @return Metadata
2727
*/
28-
public function getMetadata($all_topics, $only_topic = null, $timeout_ms)
28+
public function getMetadata(bool $all_topics, Topic $only_topic = null, int $timeout_ms): Metadata
2929
{
3030
}
3131

3232
/**
3333
* @return int
3434
*/
35-
public function getOutQLen()
35+
public function getOutQLen(): int
3636
{
3737
}
3838

@@ -42,7 +42,7 @@ public function getOutQLen()
4242
*
4343
* @return Topic
4444
*/
45-
public function newTopic($topic_name, TopicConf $topic_conf = null)
45+
public function newTopic(string $topic_name, TopicConf $topic_conf = null): Topic
4646
{
4747
}
4848

@@ -51,7 +51,7 @@ public function newTopic($topic_name, TopicConf $topic_conf = null)
5151
*
5252
* @return void
5353
*/
54-
public function poll($timeout_ms)
54+
public function poll(int $timeout_ms)
5555
{
5656
}
5757

@@ -62,7 +62,14 @@ public function poll($timeout_ms)
6262
*
6363
* @return void
6464
*/
65-
public function setLogLevel($level)
65+
public function setLogLevel(int $level)
66+
{
67+
}
68+
69+
/**
70+
* @deprecated
71+
*/
72+
public function setLogger(int $logger_id)
6673
{
6774
}
6875

@@ -73,32 +80,63 @@ public function setLogLevel($level)
7380
* @param int $high
7481
* @param int $timeout_ms
7582
*/
76-
public function queryWatermarkOffsets($topic, $partition, &$low, &$high, $timeout_ms)
83+
public function queryWatermarkOffsets(string $topic, int $partition, int &$low, int &$high, int $timeout_ms)
7784
{
7885
}
7986

8087
/**
81-
* @param array $topicPartitions
88+
* @param TopicPartition[] $topicPartitions
8289
* @param int $timeout_ms
83-
* @return array
90+
* @return TopicPartition[]
8491
*/
85-
public function offsetsForTimes ($topicPartitions , $timeout_ms)
92+
public function offsetsForTimes (array $topicPartitions, int $timeout_ms): array
8693
{
8794
}
8895

8996
/**
9097
* @param int $purge_flags
9198
* @return int
9299
*/
93-
public function purge($purge_flags)
100+
public function purge(int $purge_flags): int
94101
{
95102
}
96103

97104
/**
98105
* @param int $timeout_ms
99106
* @return int
100107
*/
101-
public function flush($timeout_ms)
108+
public function flush(int $timeout_ms): int
102109
{
103110
}
111+
112+
/**
113+
* @param string $token_value
114+
* @param int|float|string $lifetime_ms
115+
* @param string $principal_name
116+
* @param array $extensions
117+
*
118+
* @return void
119+
*/
120+
public function oauthbearerSetToken(string $token_value, $lifetime_ms, string $principal_name, array $extensions = [])
121+
{
122+
}
123+
124+
/**
125+
* @param string $error
126+
*
127+
* @return void
128+
*/
129+
public function oauthbearerSetTokenFailure(string $error)
130+
{
131+
}
132+
133+
/**
134+
* @param int $timeout_ms
135+
*
136+
* @return int
137+
*/
138+
public function getControllerId(int $timeout_ms): int
139+
{
140+
141+
}
104142
}

stubs/RdKafka/Conf.php

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ class Conf
1010
/**
1111
* @return array<string, string>
1212
*/
13-
public function dump()
13+
public function dump(): array
1414
{
1515
}
1616

@@ -20,7 +20,7 @@ public function dump()
2020
*
2121
* @return void
2222
*/
23-
public function set($name, $value)
23+
public function set(string $name, string $value)
2424
{
2525
}
2626

@@ -36,7 +36,7 @@ public function setDefaultTopicConf(TopicConf $topic_conf)
3636
}
3737

3838
/**
39-
* @param callable $callback
39+
* @param callable $callback (RdKafka\Kafka $kafka, RdKafka\Message $message)
4040
*
4141
* @return void
4242
*/
@@ -45,7 +45,7 @@ public function setDrMsgCb(callable $callback)
4545
}
4646

4747
/**
48-
* @param callable $callback
48+
* @param callable $callback (RdKafka\KafkaConsumer|RdKafka\Producer $kafka, int $err, string $reason)
4949
*
5050
* @return void
5151
*/
@@ -54,7 +54,7 @@ public function setErrorCb(callable $callback)
5454
}
5555

5656
/**
57-
* @param callable $callback
57+
* @param callable $callback (RdKafka\KafkaConsumer $kafka, int $err, array $partitions)
5858
*
5959
* @return void
6060
*/
@@ -63,7 +63,7 @@ public function setRebalanceCb(callable $callback)
6363
}
6464

6565
/**
66-
* @param callable $callback
66+
* @param callable $callback (object $kafka, string $json, int $json_len);
6767
*
6868
* @return void
6969
*/
@@ -72,7 +72,7 @@ public function setStatsCb(callable $callback)
7272
}
7373

7474
/**
75-
* @param callable $callback
75+
* @param callable $callback (RdKafka\Message $msg)
7676
*
7777
* @return void
7878
*/
@@ -81,7 +81,7 @@ public function setConsumeCb(callable $callback)
8181
}
8282

8383
/**
84-
* @param callable $callback
84+
* @param callable $callback (object $kafka, int $err, array $partitions);
8585
*
8686
* @return void
8787
*/
@@ -90,11 +90,21 @@ public function setOffsetCommitCb(callable $callback)
9090
}
9191

9292
/**
93-
* @param callable $callback
93+
* @param callable $callback (object $kafka, int $level, string $facility, string $message);
9494
*
9595
* @return void
9696
*/
9797
public function setLogCb(callable $callback)
9898
{
9999
}
100+
101+
/**
102+
* @param callable $callback (RdKafka\Producer $producer)
103+
*
104+
* @return void
105+
*/
106+
public function setOauthbearerTokenRefreshCb(callable $callback)
107+
{
108+
109+
}
100110
}

stubs/RdKafka/Consumer.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,26 @@
55
class Consumer extends \RdKafka
66
{
77
/**
8-
* @param Conf $conf
8+
* @param Conf|null $conf
99
*/
1010
public function __construct(Conf $conf = null)
1111
{
1212
}
1313

1414
/**
15-
* @param string $topic_name
16-
* @param TopicConf $topic_conf
15+
* @param string $topic_name
16+
* @param TopicConf|null $topic_conf
1717
*
1818
* @return ConsumerTopic
1919
*/
20-
public function newTopic($topic_name, TopicConf $topic_conf = null)
20+
public function newTopic(string $topic_name, TopicConf $topic_conf = null): Topic
2121
{
2222
}
2323

2424
/**
2525
* @return Queue
2626
*/
27-
public function newQueue()
27+
public function newQueue(): Queue
2828
{
2929
}
3030
}

stubs/RdKafka/ConsumerTopic.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ private function __construct()
1414
*
1515
* @return Message|null
1616
*/
17-
public function consume($partition, $timeout_ms)
17+
public function consume(int $partition, int $timeout_ms)
1818
{
1919
}
2020

@@ -25,7 +25,7 @@ public function consume($partition, $timeout_ms)
2525
*
2626
* @return void
2727
*/
28-
public function consumeQueueStart($partition, $offset, Queue $queue)
28+
public function consumeQueueStart(int $partition, int $offset, Queue $queue)
2929
{
3030
}
3131

@@ -35,7 +35,7 @@ public function consumeQueueStart($partition, $offset, Queue $queue)
3535
*
3636
* @return void
3737
*/
38-
public function consumeStart($partition, $offset)
38+
public function consumeStart(int $partition, int $offset)
3939
{
4040
}
4141

@@ -44,7 +44,7 @@ public function consumeStart($partition, $offset)
4444
*
4545
* @return void
4646
*/
47-
public function consumeStop($partition)
47+
public function consumeStop(int $partition)
4848
{
4949
}
5050

@@ -54,7 +54,7 @@ public function consumeStop($partition)
5454
*
5555
* @return void
5656
*/
57-
public function offsetStore($partition, $offset)
57+
public function offsetStore(int $partition, int $offset)
5858
{
5959
}
6060

@@ -65,9 +65,9 @@ public function offsetStore($partition, $offset)
6565
*
6666
* @throws Exception
6767
* @throws \InvalidArgumentException
68-
* @return array
68+
* @return Message[]|null
6969
*/
70-
public function consumeBatch($partition, $timeout_ms, $batch_size)
70+
public function consumeBatch(int $partition, int $timeout_ms, int $batch_size)
7171
{
7272
}
7373

@@ -78,7 +78,7 @@ public function consumeBatch($partition, $timeout_ms, $batch_size)
7878
*
7979
* @return void
8080
*/
81-
public function consumeCallback($partition, $timeout_ms, callable $callback)
81+
public function consumeCallback(int $partition, int $timeout_ms, callable $callback)
8282
{
8383
}
8484
}

0 commit comments

Comments
 (0)