save work

Author: nick-zh

content/consumer/getAssignment.md

@@ -5,10 +5,19 @@ draft: false
 ---
 ## Description
 ```php
-
+public function getAssignment(): array {}
 ```
-asdf
+Returns the current partition assignment
 ## Example
 ```php
-
+$conf = Kafka\Configuration();
+$conf->set('metadata.broker.list', 'kafka:9092');
+$consumer = new Kafka\Consumer($conf);
+$consumer->assign(
+    [
+        new Kafka\TopicPartition('test-topic', 1, 3000),
+        new Kafka\TopicPartition('test-topic', 2, 3009)
+    ]
+);
+var_dump($consumer->getAssignment());
 ```

content/consumer/getCommittedOffsets.md

@@ -5,10 +5,14 @@ draft: false
 ---
 ## Description
 ```php
-
+public function getCommittedOffsets(array $topics, int $timeoutMs): array {}
 ```
-asdf
+Returns the committed offsets for topics and partitions for a consumer group
 ## Example
 ```php
-
+$conf = Kafka\Configuration();
+$conf->set('metadata.broker.list', 'kafka:9092');
+$consumer = new Kafka\Consumer($conf);
+$topicPartition = new TopicPartition('test-topic', 0);
+var_dump($consumer->getCommittedOffsets([$topicPartition], 10000));
 ```

content/consumer/getMetadata.md

@@ -5,10 +5,14 @@ draft: false
 ---
 ## Description
 ```php
-
+function getMetadata(bool $allTopics, int $timeoutMs, ConsumerTopic $topic = null): Metadata {}
 ```
-asdf
+Get metadata for all topics or a single topic
 ## Example
 ```php
-
+$conf = Kafka\Configuration();
+$conf->set('metadata.broker.list', 'kafka:9092');
+$consumer = new Kafka\Consumer($conf);
+$topicHandle = $consumer->getTopicHandle('test-topic');
+$singleTopicMetadata = $consumer->metadata(true, $topicHandle, 10000);
 ```

content/consumer/getOffsetPositions.md

@@ -5,10 +5,15 @@ draft: false
 ---
 ## Description
 ```php
-
+public function getOffsetPositions(array $topics): array {}
 ```
-asdf
+The offset field of each requested partition will be set to the offset of the last consumed message + 1  
+If there was no previous message `RD_KAFKA_OFFSET_INVALID` will be returned
 ## Example
 ```php
-
+$conf = Kafka\Configuration();
+$conf->set('metadata.broker.list', 'kafka:9092');
+$consumer = new Kafka\Consumer($conf);
+$topicPartition = new TopicPartition('test-topic', 0);
+$topicPartitionsWithOffsets = $consumer->getOffsetPositions([$topicPartition]));
 ```

content/consumer/getSubscription.md

@@ -5,10 +5,14 @@ draft: false
 ---
 ## Description
 ```php
-
+public function getSubscription(): array {}
 ```
-asdf
+Return topic names to which the consumer is currently subscribed to
 ## Example
 ```php
-
+$conf = Kafka\Configuration();
+$conf->set('metadata.broker.list', 'kafka:9092');
+$consumer = new Kafka\Consumer($conf);
+$consumer->subscribe(['test-topic']);
+var_dump($consumer->getSubscription());
 ```

content/consumer/getTopicHandle.md

@@ -5,10 +5,17 @@ draft: false
 ---
 ## Description
 ```php
-
+public function getTopicHandle(string $topic): ConsumerTopic {}
 ```
-asdf
+Get a topic handle for a given topic name. A topic handle is needed  
+for example to query metadata from the broker
 ## Example
 ```php
+$conf = Kafka\Configuration();
+$conf->set('metadata.broker.list', 'kafka:9092');
+$consumer = new Kafka\Consumer($conf);
+$topicHandle = $consumer->getTopicHandle('test-topic');
 
+// use the topic handle for further calls, e.g. to query metadata
+$singleTopicMetadata = $consumer->metadata(true, $topicHandle, 10000);
 ```

content/consumer/offsetForTimes.md

@@ -5,10 +5,17 @@ draft: false
 ---
 ## Description
 ```php
-
+public function offsetsForTimes(array $topicPartitions, int $timeoutMs): array {}
 ```
-asdf
+Look up the offsets for the given partitions by timestamp.  
+The returned offset for each partition is the earliest offset whose  
+timestamp is greater than or equal to the given timestamp in the  
+corresponding partition.
 ## Example
 ```php
-
+$conf = Kafka\Configuration();
+$conf->set('metadata.broker.list', 'kafka:9092');
+$consumer = new Kafka\Consumer($conf);
+$topicPartition = new TopicPartition('test-topic', 0, strtotime("-1 week"));
+$offsetsOneWeekAgo = $consumer->offsetForTimes([$topicPartition], 10000);
 ```

content/consumer/queryWatermarkOffsets.md

@@ -5,10 +5,17 @@ draft: false
 ---
 ## Description
 ```php
-
+public function queryWatermarkOffsets(string $topic, int $partition, int &$low, int &$high, int $timeoutMs): void {}
 ```
-asdf
+Query broker for low (oldest) and high (newest) offsets for a partition
 ## Example
 ```php
+$low = 0;
+$high = 0;
 
+$conf = Kafka\Configuration();
+$conf->set('metadata.broker.list', 'kafka:9092');
+$consumer = new Kafka\Consumer($conf);
+$topicPartition = new TopicPartition('test-topic', 0, strtotime("-1 week"));
+$consumer->queryWatermarkOffsets('test-topic, 0, int &$low, int &$high, 10000);
 ```

content/consumer/subscribe.md

@@ -5,10 +5,15 @@ draft: false
 ---
 ## Description
 ```php
-
+public function subscribe(array $topics): void {}
 ```
-asdf
+Subscribe to one or more topics (regexp also supported).  
+Any previous subscription will be unassigned and unsubscribed first.  
+
 ## Example
 ```php
-
+$conf = Kafka\Configuration();
+$conf->set('metadata.broker.list', 'kafka:9092');
+$consumer = new Kafka\Consumer($conf);
+$consumer->subscribe(['test-topic']);
 ```

content/consumer/unsubscribe.md

@@ -5,10 +5,15 @@ draft: false
 ---
 ## Description
 ```php
-
+public function unsubscribe(): void {}
 ```
-asdf
+Unsubscribe from the current subscriptions
+
 ## Example
 ```php
-
+$conf = Kafka\Configuration();
+$conf->set('metadata.broker.list', 'kafka:9092');
+$consumer = new Kafka\Consumer($conf);
+$consumer->subscribe(['test-topic']);
+$consumer->unsubscribe();
 ```