rename ext (#23)

* rename ext

* fix typo

* rename ext

* change namespace (#26)

Author: nick-zh

.github/ISSUE_TEMPLATE

@@ -13,7 +13,7 @@ Please always include the following in an issue:
 Add debug logs, by adjusting your configuration:
 ```php
 <?php
-$conf = new Kafka\Configuration();
+$conf = new SimpleKafkaClient\Configuration();
 // Add the two settings below for a more verbose output
 $conf->set('log_level', (string) LOG_DEBUG);
 $conf->set('debug', 'all');

.github/workflows/test.yml

@@ -68,7 +68,7 @@ jobs:
               run: './php-kafka/.github/workflows/test/build-php.sh'
 
             - name: 'Build php-kafka'
-              run: './php-kafka/.github/workflows/test/build-php-kafka.sh'
+              run: './php-kafka/.github/workflows/test/build-php-simple-kafka-client.sh'
 
             - name: 'Start Kafka'
               run: './php-kafka/.github/workflows/test/start-kafka.sh'

.github/workflows/test/build-php-kafka.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+set -e
+
+echo "Building php-simple-kafka-client with PHP version:"
+php --version
+
+if [ $MEMORY_CHECK -eq 1 ]; then
+    PHP_SIMPLE_KAFKA_CLIENT_CFLAGS="-Wall -Werror -Wno-deprecated-declarations"
+fi
+
+cd php-kafka
+phpize
+CFLAGS="$PHP_SIMPLE_KAFKA_CLIENT_CFLAGS" ./configure
+make
+
+echo "extension=$(pwd)/modules/simple_kafka_client.so"|sudo tee /usr/local/etc/php/simple_kafka_client.ini >/dev/null

.github/workflows/test/build-php-simple-kafka-client.sh

@@ -1,16 +1,16 @@
 dnl $Id$
-dnl config.m4 for extension kafka
+dnl config.m4 for extension simple_kafka_client
 
-PHP_ARG_WITH(kafka, for kafka support,
-[  --with-kafka             Include kafka support])
+PHP_ARG_WITH(simple_kafka_client, for kafka client support,
+[  --with-simple-kafka-client             Include kafka client support])
 
 dnl Check whether the extension is enabled at all
-if test "$PHP_KAFKA" != "no"; then
+if test "$PHP_SIMPLE_KAFKA_CLIENT" != "no"; then
 
   SEARCH_PATH="/usr/local /usr"     # you might want to change this
   SEARCH_FOR="/include/librdkafka/rdkafka.h"  # you most likely want to change this
-  if test -r $PHP_KAFKA/$SEARCH_FOR; then # path given as parameter
-    RDKAFKA_DIR=$PHP_KAFKA
+  if test -r $PHP_SIMPLE_KAFKA_CLIENT/$SEARCH_FOR; then # path given as parameter
+    RDKAFKA_DIR=$PHP_SIMPLE_KAFKA_CLIENT
   else # search default path list
     AC_MSG_CHECKING([for librdkafka/rdkafka.h" in default path])
     for i in $SEARCH_PATH ; do
@@ -28,14 +28,14 @@ if test "$PHP_KAFKA" != "no"; then
 
   PHP_ADD_INCLUDE($RDKAFKA_DIR/include)
 
-  SOURCES="kafka.c producer.c metadata.c metadata_broker.c metadata_topic.c metadata_partition.c metadata_collection.c configuration.c topic.c message.c functions.c consumer.c topic_partition.c kafka_exception.c"
+  SOURCES="simple_kafka_client.c producer.c metadata.c metadata_broker.c metadata_topic.c metadata_partition.c metadata_collection.c configuration.c topic.c message.c functions.c consumer.c topic_partition.c kafka_exception.c"
 
   LIBNAME=rdkafka
   LIBSYMBOL=rd_kafka_new
 
   PHP_CHECK_LIBRARY($LIBNAME,$LIBSYMBOL,
   [
-    PHP_ADD_LIBRARY_WITH_PATH($LIBNAME, $RDKAFKA_DIR/$PHP_LIBDIR, KAFKA_SHARED_LIBADD)
+    PHP_ADD_LIBRARY_WITH_PATH($LIBNAME, $RDKAFKA_DIR/$PHP_LIBDIR, SIMPLE_KAFKA_CLIENT_SHARED_LIBADD)
     AC_DEFINE(HAVE_RDKAFKALIB,1,[ ])
   ],[
     AC_MSG_ERROR([wrong rdkafka lib version or lib not found])
@@ -63,7 +63,7 @@ if test "$PHP_KAFKA" != "no"; then
   LDFLAGS="$ORIG_LDFLAGS"
   CPPFLAGS="$ORIG_CPPFLAGS"
 
-  PHP_SUBST(KAFKA_SHARED_LIBADD)
+  PHP_SUBST(SIMPLE_KAFKA_CLIENT_SHARED_LIBADD)
 
-  PHP_NEW_EXTENSION(kafka, $SOURCES, $ext_shared)
+  PHP_NEW_EXTENSION(simple_kafka_client, $SOURCES, $ext_shared)
 fi

config.m4

@@ -7,7 +7,7 @@ if (PHP_KAFKA != "no") {
 	if (CHECK_LIB("librdkafka.lib", "rdkafka", PHP_KAFKA) &&
 		CHECK_HEADER_ADD_INCLUDE("librdkafka/rdkafka.h", "CFLAGS_RDKAFKA")) {
 
-		EXTENSION("rdkafka", "kafka.c producer.c metadata.c metadata_broker.c metadata_topic.c \
+		EXTENSION("rdkafka", "simple_kafka_client.c producer.c metadata.c metadata_broker.c metadata_topic.c \
 				metadata_partition.c metadata_collection.c configuration.c \
 				topic.c message.c functions.c consumer.c topic_partition.c kafka_exception.c");
 

config.w32

@@ -123,7 +123,7 @@ kafka_conf_object * get_kafka_conf_object(zval *zconf)
     kafka_conf_object *oconf = Z_KAFKA_P(kafka_conf_object, zconf);
 
     if (!oconf->conf) {
-        zend_throw_exception_ex(NULL, 0, "Kafka\\Configuration::__construct() has not been called");
+        zend_throw_exception_ex(NULL, 0, "SimpleKafkaClient\\Configuration::__construct() has not been called");
         return NULL;
     }
 
@@ -304,7 +304,7 @@ static void kafka_conf_log_cb(const rd_kafka_t *rk, int level, const char *facil
     zval_ptr_dtor(&args[3]);
 }
 
-/* {{{ proto Kafka\Configuration::__construct() */
+/* {{{ proto SimpleKafkaClient\Configuration::__construct() */
 ZEND_METHOD(Kafka_Configuration, __construct)
 {
     kafka_conf_object *intern;
@@ -317,7 +317,7 @@ ZEND_METHOD(Kafka_Configuration, __construct)
 }
 /* }}} */
 
-/* {{{ proto array Kafka\Configuration::dump()
+/* {{{ proto array SimpleKafkaClient\Configuration::dump()
    Dump the configuration properties and values of `conf` to an array */
 ZEND_METHOD(Kafka_Configuration, dump)
 {
@@ -348,7 +348,7 @@ ZEND_METHOD(Kafka_Configuration, dump)
 }
 /* }}} */
 
-/* {{{ proto void Kafka\Configuration::set(string $name, string $value)
+/* {{{ proto void SimpleKafkaClient\Configuration::set(string $name, string $value)
    Sets a configuration property. */
 ZEND_METHOD(Kafka_Configuration, set)
 {
@@ -385,7 +385,7 @@ ZEND_METHOD(Kafka_Configuration, set)
 }
 /* }}} */
 
-/* {{{ proto void Kafka\Configuration::setErrorCb(callable $callback)
+/* {{{ proto void SimpleKafkaClient\Configuration::setErrorCb(callable $callback)
    Sets the error callback */
 ZEND_METHOD(Kafka_Configuration, setErrorCb)
 {
@@ -417,7 +417,7 @@ ZEND_METHOD(Kafka_Configuration, setErrorCb)
 }
 /* }}} */
 
-/* {{{ proto void Kafka\Configuration::setDrMsgCb(callable $callback)
+/* {{{ proto void SimpleKafkaClient\Configuration::setDrMsgCb(callable $callback)
    Sets the delivery report callback */
 ZEND_METHOD(Kafka_Configuration, setDrMsgCb)
 {
@@ -449,7 +449,7 @@ ZEND_METHOD(Kafka_Configuration, setDrMsgCb)
 }
 /* }}} */
 
-/* {{{ proto void Kafka\Configuration::setStatsCb(callable $callback)
+/* {{{ proto void SimpleKafkaClient\Configuration::setStatsCb(callable $callback)
    Sets the statistics report callback */
 ZEND_METHOD(Kafka_Configuration, setStatsCb)
 {
@@ -481,7 +481,7 @@ ZEND_METHOD(Kafka_Configuration, setStatsCb)
 }
 /* }}} */
 
-/* {{{ proto void Kafka\Configuration::setRebalanceCb(callback $callback)
+/* {{{ proto void SimpleKafkaClient\Configuration::setRebalanceCb(callback $callback)
    Set rebalance callback for use with coordinated consumer group balancing */
 ZEND_METHOD(Kafka_Configuration, setRebalanceCb)
 {
@@ -513,7 +513,7 @@ ZEND_METHOD(Kafka_Configuration, setRebalanceCb)
 }
 /* }}} */
 
-/* {{{ proto void Kafka\Configuration::setOffsetCommitCb(callback $callback)
+/* {{{ proto void SimpleKafkaClient\Configuration::setOffsetCommitCb(callback $callback)
    Set offset commit callback for use with consumer groups */
 ZEND_METHOD(Kafka_Configuration, setOffsetCommitCb)
 {
@@ -545,7 +545,7 @@ ZEND_METHOD(Kafka_Configuration, setOffsetCommitCb)
 }
 /* }}} */
 
-/* {{{ proto void Kafka\Configuration::setLogCb(callback $callback)
+/* {{{ proto void SimpleKafkaClient\Configuration::setLogCb(callback $callback)
    Set offset commit callback for use with consumer groups */
 ZEND_METHOD(Kafka_Configuration, setLogCb)
 {
@@ -587,7 +587,7 @@ void kafka_conf_init(INIT_FUNC_ARGS)
     handlers.free_obj = kafka_conf_free;
     handlers.offset = XtOffsetOf(kafka_conf_object, std);
 
-    INIT_NS_CLASS_ENTRY(tmpce, "Kafka", "Configuration", class_Kafka_Configuration_methods);
+    INIT_NS_CLASS_ENTRY(tmpce, "SimpleKafkaClient", "Configuration", class_Kafka_Configuration_methods);
     ce_kafka_conf = zend_register_internal_class(&tmpce);
     ce_kafka_conf->create_object = kafka_conf_new;
 }

configuration.c

@@ -2,7 +2,7 @@
 
 /** @generate-function-entries */
 
-namespace Kafka;
+namespace SimpleKafkaClient;
 
 class Configuration
 {

configuration.stub.php

@@ -93,7 +93,7 @@ static object_intern * get_object(zval *zconsumer) /* {{{ */
     object_intern *oconsumer = Z_KAFKA_P(object_intern, zconsumer);
 
     if (!oconsumer->rk) {
-        zend_throw_exception_ex(NULL, 0, "Kafka\\Consumer::__construct() has not been called");
+        zend_throw_exception_ex(NULL, 0, "SimpleKafkaClient\\Consumer::__construct() has not been called");
         return NULL;
     }
 
@@ -119,7 +119,7 @@ static int has_group_id(rd_kafka_conf_t *conf) { /* {{{ */
     return 1;
 } /* }}} */
 
-/* {{{ proto Kafka\Consumer::__construct(Kafka\Configuration $conf) */
+/* {{{ proto SimpleKafkaClient\Consumer::__construct(SimpleKafkaClient\Configuration $conf) */
 ZEND_METHOD(Kafka_Consumer, __construct)
 {
     zval *zconf;
@@ -168,7 +168,7 @@ ZEND_METHOD(Kafka_Consumer, __construct)
 }
 /* }}} */
 
-/* {{{ proto void Kafka\Consumer::assign([array $topics])
+/* {{{ proto void SimpleKafkaClient\Consumer::assign([array $topics])
     Atomic assignment of partitions to consume */
 ZEND_METHOD(Kafka_Consumer, assign)
 {
@@ -213,7 +213,7 @@ ZEND_METHOD(Kafka_Consumer, assign)
 }
 /* }}} */
 
-/* {{{ proto array Kafka\Consumer::getAssignment()
+/* {{{ proto array SimpleKafkaClient\Consumer::getAssignment()
     Returns the current partition getAssignment */
 ZEND_METHOD(Kafka_Consumer, getAssignment)
 {
@@ -241,7 +241,7 @@ ZEND_METHOD(Kafka_Consumer, getAssignment)
 }
 /* }}} */
 
-/* {{{ proto void Kafka\Consumer::subscribe(array $topics)
+/* {{{ proto void SimpleKafkaClient\Consumer::subscribe(array $topics)
     Update the subscription set to $topics */
 ZEND_METHOD(Kafka_Consumer, subscribe)
 {
@@ -281,7 +281,7 @@ ZEND_METHOD(Kafka_Consumer, subscribe)
 }
 /* }}} */
 
-/* {{{ proto array Kafka\Consumer::getSubscription()
+/* {{{ proto array SimpleKafkaClient\Consumer::getSubscription()
    Returns the current subscription as set by subscribe() */
 ZEND_METHOD(Kafka_Consumer, getSubscription)
 {
@@ -315,7 +315,7 @@ ZEND_METHOD(Kafka_Consumer, getSubscription)
 }
 /* }}} */
 
-/* {{{ proto void Kafka\Consumer::unsubsribe()
+/* {{{ proto void SimpleKafkaClient\Consumer::unsubsribe()
     Unsubscribe from the current subscription set */
 ZEND_METHOD(Kafka_Consumer, unsubscribe)
 {
@@ -339,7 +339,7 @@ ZEND_METHOD(Kafka_Consumer, unsubscribe)
 }
 /* }}} */
 
-/* {{{ proto Message Kafka\Consumer::consume()
+/* {{{ proto Message SimpleKafkaClient\Consumer::consume()
    Consume message or get error event, triggers callbacks */
 ZEND_METHOD(Kafka_Consumer, consume)
 {
@@ -434,10 +434,10 @@ static void consumer_commit(int async, INTERNAL_FUNCTION_PARAMETERS) /* {{{ */
             }
         } else if (Z_TYPE_P(zarg) != IS_NULL) {
             php_error(E_ERROR,
-                    "Kafka\\Consumer::%s() expects parameter %d to be %s, %s given",
+                    "SimpleKafkaClient\\Consumer::%s() expects parameter %d to be %s, %s given",
                     get_active_function_name(),
                     1,
-                    "an instance of Kafka\\Message or an array of Kafka\\TopicPartition",
+                    "an instance of SimpleKafkaClient\\Message or an array of SimpleKafkaClient\\TopicPartition",
                     zend_zval_type_name(zarg));
             return;
         }
@@ -456,23 +456,23 @@ static void consumer_commit(int async, INTERNAL_FUNCTION_PARAMETERS) /* {{{ */
 }
 /* }}} */
 
-/* {{{ proto void Kafka\Consumer::commit([mixed $message_or_offsets])
+/* {{{ proto void SimpleKafkaClient\Consumer::commit([mixed $message_or_offsets])
    Commit offsets */
 ZEND_METHOD(Kafka_Consumer, commit)
 {
     consumer_commit(0, INTERNAL_FUNCTION_PARAM_PASSTHRU);
 }
 /* }}} */
 
-/* {{{ proto void Kafka\Consumer::commitAsync([mixed $message_or_offsets])
+/* {{{ proto void SimpleKafkaClient\Consumer::commitAsync([mixed $message_or_offsets])
    Commit offsets */
 ZEND_METHOD(Kafka_Consumer, commitAsync)
 {
     consumer_commit(1, INTERNAL_FUNCTION_PARAM_PASSTHRU);
 }
 /* }}} */
 
-/* {{{ proto void Kafka\Consumer::close()
+/* {{{ proto void SimpleKafkaClient\Consumer::close()
    Close connection */
 ZEND_METHOD(Kafka_Consumer, close)
 {
@@ -491,7 +491,7 @@ ZEND_METHOD(Kafka_Consumer, close)
 }
 /* }}} */
 
-/* {{{ proto Metadata Kafka\Consumer::getMetadata(bool all_topics, int timeout_ms, Kafka\Topic only_topic = null)
+/* {{{ proto Metadata SimpleKafkaClient\Consumer::getMetadata(bool all_topics, int timeout_ms, SimpleKafkaClient\Topic only_topic = null)
    Request Metadata from broker */
 ZEND_METHOD(Kafka_Consumer, getMetadata)
 {
@@ -533,8 +533,8 @@ ZEND_METHOD(Kafka_Consumer, getMetadata)
 }
 /* }}} */
 
-/* {{{ proto Kafka\ConsumerTopic Kafka\Consumer::getTopicHandle(string $topic)
-   Returns a Kafka\ConsumerTopic object */
+/* {{{ proto SimpleKafkaClient\ConsumerTopic SimpleKafkaClient\Consumer::getTopicHandle(string $topic)
+   Returns a SimpleKafkaClient\ConsumerTopic object */
 ZEND_METHOD(Kafka_Consumer, getTopicHandle)
 {
     char *topic;
@@ -571,7 +571,7 @@ ZEND_METHOD(Kafka_Consumer, getTopicHandle)
 }
 /* }}} */
 
-/* {{{ proto array Kafka\Consumer::getCommittedOffsets(array $topics, int timeout_ms)
+/* {{{ proto array SimpleKafkaClient\Consumer::getCommittedOffsets(array $topics, int timeout_ms)
    Retrieve committed offsets for topics+partitions */
 ZEND_METHOD(Kafka_Consumer, getCommittedOffsets)
 {
@@ -610,7 +610,7 @@ ZEND_METHOD(Kafka_Consumer, getCommittedOffsets)
 
 /* }}} */
 
-/* {{{ proto array Kafka\Consumer::getOffsetPositions(array $topics)
+/* {{{ proto array SimpleKafkaClient\Consumer::getOffsetPositions(array $topics)
    Retrieve current offsets for topics+partitions */
 ZEND_METHOD(Kafka_Consumer, getOffsetPositions)
 {
@@ -645,7 +645,7 @@ ZEND_METHOD(Kafka_Consumer, getOffsetPositions)
 }
 /* }}} */
 
-/* {{{ proto void Kafka\Consumer::offsetsForTimes(array $topicPartitions, int $timeout_ms)
+/* {{{ proto void SimpleKafkaClient\Consumer::offsetsForTimes(array $topicPartitions, int $timeout_ms)
    Look up the offsets for the given partitions by timestamp. */
 ZEND_METHOD(Kafka_Consumer, offsetsForTimes)
 {
@@ -682,7 +682,7 @@ ZEND_METHOD(Kafka_Consumer, offsetsForTimes)
 }
 /* }}} */
 
-/* {{{ proto void Kafka\Consumer::queryWatermarkOffsets(string $topic, int $partition, int &$low, int &$high, int $timeout_ms)
+/* {{{ proto void SimpleKafkaClient\Consumer::queryWatermarkOffsets(string $topic, int $partition, int &$low, int &$high, int $timeout_ms)
    Query broker for low (oldest/beginning) or high (newest/end) offsets for partition */
 ZEND_METHOD(Kafka_Consumer, queryWatermarkOffsets)
 {
@@ -726,7 +726,7 @@ void kafka_consumer_init(INIT_FUNC_ARGS) /* {{{ */
 {
     zend_class_entry tmpce;
 
-    INIT_NS_CLASS_ENTRY(tmpce, "Kafka", "Consumer", class_Kafka_Consumer_methods);
+    INIT_NS_CLASS_ENTRY(tmpce, "SimpleKafkaClient", "Consumer", class_Kafka_Consumer_methods);
     ce = zend_register_internal_class(&tmpce);
     ce->create_object = kafka_consumer_new;