PHP-127 - Duration type (#96)

PHP-127 - Add Duration type support

Author: stamhankar999

ext/config.m4

@@ -44,6 +44,7 @@ if test "$PHP_CASSANDRA" != "no"; then
     src/DefaultSchema.c \
     src/DefaultSession.c \
     src/DefaultTable.c \
+    src/Duration.c \
     src/Exception.c \
     src/ExecutionOptions.c \
     src/Float.c \

ext/config.w32

@@ -118,6 +118,7 @@ if (PHP_CASSANDRA != "no") {
               "DefaultSchema.c " +
               "DefaultSession.c " +
               "DefaultTable.c " +
+              "Duration.c " +
               "Exception.c " +
               "ExecutionOptions.c " +
               "Float.c " +

ext/doc/Cassandra/Duration.php

@@ -0,0 +1,48 @@
+<?php
+
+/*
+  Copyright (c) 2016 DataStax, Inc.
+  This software can be used solely with DataStax Enterprise. Please consult the
+  license at http://www.datastax.com/terms/datastax-Cassandra-driver-license-terms
+*/
+
+namespace Cassandra;
+
+/**
+ * A PHP representation of the CQL `duration` datatype
+ */
+final class Duration implements Value  {
+
+    /**
+     * @param long|double|string|Bigint $months Months attribute of the duration.
+     * @param long|double|string|Bigint $days Days attribute of the duration.
+     * @param long|double|string|Bigint $nanos Nanos attribute of the duration.
+     */
+    public function __construct($months, $days, $nanos) { }
+
+    /**
+     * @return Type the Cassandra type for Duration
+     */
+    public function type() { }
+
+    /**
+     * @return string the months attribute of this Duration
+     */
+    public function months() { }
+
+    /**
+     * @return string the days attribute of this Duration
+     */
+    public function days() { }
+
+    /**
+     * @return string the nanoseconds attribute of this Duration
+     */
+    public function nanos() { }
+
+    /**
+     * @return string string representation of this Duration; may be used as a literal parameter in CQL queries.
+     */
+    public function __toString() { }
+
+}

ext/php_driver.c

@@ -493,6 +493,7 @@ PHP_MINIT_FUNCTION(php_driver)
   php_driver_define_Uuid(TSRMLS_C);
   php_driver_define_Varint(TSRMLS_C);
   php_driver_define_Custom(TSRMLS_C);
+  php_driver_define_Duration(TSRMLS_C);
 
   php_driver_define_Set(TSRMLS_C);
   php_driver_define_Map(TSRMLS_C);

ext/php_driver_globals.h

@@ -26,6 +26,7 @@ ZEND_BEGIN_MODULE_GLOBALS(php_driver)
   php5to7_zval  type_timeuuid;
   php5to7_zval  type_smallint;
   php5to7_zval  type_tinyint;
+  php5to7_zval  type_duration;
 ZEND_END_MODULE_GLOBALS(php_driver)
 
 ZEND_EXTERN_MODULE_GLOBALS(php_driver)

ext/php_driver_types.h

@@ -73,6 +73,7 @@
   #define PHP_DRIVER_GET_TYPE(obj) php_driver_type_object_fetch(Z_OBJ_P(obj))
   #define PHP_DRIVER_GET_RETRY_POLICY(obj) php_driver_retry_policy_object_fetch(Z_OBJ_P(obj))
   #define PHP_DRIVER_GET_TIMESTAMP_GEN(obj) php_driver_timestamp_gen_object_fetch(Z_OBJ_P(obj))
+  #define PHP_DRIVER_GET_DURATION(obj) php_driver_duration_object_fetch(Z_OBJ_P(obj))
 #else
   #define PHP_DRIVER_GET_NUMERIC(obj) ((php_driver_numeric *)zend_object_store_get_object((obj) TSRMLS_CC))
   #define PHP_DRIVER_GET_BLOB(obj) ((php_driver_blob *)zend_object_store_get_object((obj) TSRMLS_CC))
@@ -110,6 +111,7 @@
   #define PHP_DRIVER_GET_TYPE(obj) ((php_driver_type *)zend_object_store_get_object((obj) TSRMLS_CC))
   #define PHP_DRIVER_GET_RETRY_POLICY(obj) ((php_driver_retry_policy *)zend_object_store_get_object((obj) TSRMLS_CC))
   #define PHP_DRIVER_GET_TIMESTAMP_GEN(obj) ((php_driver_timestamp_gen *)zend_object_store_get_object((obj) TSRMLS_CC))
+  #define PHP_DRIVER_GET_DURATION(obj) ((php_driver_duration *)zend_object_store_get_object((obj) TSRMLS_CC))
 #endif
 
 typedef enum {
@@ -171,6 +173,12 @@ PHP_DRIVER_BEGIN_OBJECT_TYPE(inet)
   CassInet inet;
 PHP_DRIVER_END_OBJECT_TYPE(inet)
 
+PHP_DRIVER_BEGIN_OBJECT_TYPE(duration)
+  cass_int64_t months;
+  cass_int64_t days;
+  cass_int64_t nanos;
+PHP_DRIVER_END_OBJECT_TYPE(duration)
+
 PHP_DRIVER_BEGIN_OBJECT_TYPE(collection)
   php5to7_zval type;
   HashTable values;
@@ -521,6 +529,7 @@ extern PHP_DRIVER_API zend_class_entry *php_driver_uuid_ce;
 extern PHP_DRIVER_API zend_class_entry *php_driver_timeuuid_ce;
 extern PHP_DRIVER_API zend_class_entry *php_driver_varint_ce;
 extern PHP_DRIVER_API zend_class_entry *php_driver_custom_ce;
+extern PHP_DRIVER_API zend_class_entry *php_driver_duration_ce;
 
 extern PHP_DRIVER_API zend_class_entry *php_driver_set_ce;
 extern PHP_DRIVER_API zend_class_entry *php_driver_map_ce;
@@ -578,6 +587,7 @@ void php_driver_define_Uuid(TSRMLS_D);
 void php_driver_define_Timeuuid(TSRMLS_D);
 void php_driver_define_Varint(TSRMLS_D);
 void php_driver_define_Custom(TSRMLS_D);
+void php_driver_define_Duration(TSRMLS_D);
 
 /* Classes */
 extern PHP_DRIVER_API zend_class_entry *php_driver_core_ce;

ext/src/DefaultSession.c

@@ -139,6 +139,13 @@ bind_argument_by_index(CassStatement *statement, size_t index, zval *value TSRML
       CHECK_RESULT(cass_statement_bind_inet(statement, index, inet->inet));
     }
 
+    if (instanceof_function(Z_OBJCE_P(value), php_driver_duration_ce TSRMLS_CC)) {
+      php_driver_duration *duration = PHP_DRIVER_GET_DURATION(value);
+      CHECK_RESULT(cass_statement_bind_duration(statement,
+                                                index,
+                                                duration->months, duration->days, duration->nanos));
+    }
+
     if (instanceof_function(Z_OBJCE_P(value), php_driver_set_ce TSRMLS_CC)) {
       CassError rc;
       CassCollection *collection;
@@ -295,6 +302,13 @@ bind_argument_by_name(CassStatement *statement, const char *name,
       CHECK_RESULT(cass_statement_bind_inet_by_name(statement, name, inet->inet));
     }
 
+    if (instanceof_function(Z_OBJCE_P(value), php_driver_duration_ce TSRMLS_CC)) {
+      php_driver_duration *duration = PHP_DRIVER_GET_DURATION(value);
+      CHECK_RESULT(cass_statement_bind_duration_by_name(statement,
+                                                        name,
+                                                        duration->months, duration->days, duration->nanos));
+    }
+
     if (instanceof_function(Z_OBJCE_P(value), php_driver_set_ce TSRMLS_CC)) {
       CassError rc;
       CassCollection *collection;