Merge pull request #32 from pinepain/refactor-to-psr

Refactor methods name to follow PSR-2 camelCase convention

Author: pinepain

README.md

@@ -34,10 +34,6 @@ make any assumptions for you, so you stay in control, it does exactly what you a
 
 With php-v8 you can even implement nodejs in PHP. Not sure whether anyone should/will do this anyway, but it's doable.
 
-*NOTE: Most, if not all, methods are named like in the V8 API - starting from capital letter. This PSR violation is done
-intentionally with the purpose to provide a more solid experience between the native V8 C++ API and the V8 PHP API.*
-
-
 ## Demo
 
 Here is a [Hello World][v8-hello-world]
@@ -50,9 +46,9 @@ $context = new \V8\Context($isolate);
 $source = new \V8\StringValue($isolate, "'Hello' + ', World!'");
 
 $script = new \V8\Script($context, $source);
-$result = $script->Run($context);
+$result = $script->run($context);
 
-echo $result->ToString($context)->Value(), PHP_EOL;
+echo $result->toString($context)->value(), PHP_EOL;
 ```
 
 which will output `Hello, World!`. See how it's shorter and more readable than [that C++ version][v8-hello-world]?

php_v8.h

@@ -77,6 +77,9 @@ ZEND_END_MODULE_GLOBALS(v8)
 
 #define PHP_V8_IS_UP_AND_RUNNING() (zend_is_executing() && !CG(unclean_shutdown))
 
+#define PHP_V8_ME(classname, name, flags)   PHP_ME(classname, name, arginfo_##name, flags)
+#define PHP_V8_ABSTRACT_ME(classname, name) PHP_ABSTRACT_ME(classname, name, arginfo_##name)
+
 /* Always refer to the globals in your function as PHP_V8_G(variable).
    You are encouraged to rename these macros something shorter, see
    examples in any other php module directory.

src/php_v8_array.cc

@@ -25,7 +25,7 @@ zend_class_entry *php_v8_array_class_entry;
 #define this_ce php_v8_array_class_entry
 
 
-static PHP_METHOD(V8Array, __construct) {
+static PHP_METHOD(Array, __construct) {
     zval rv;
     zval *php_v8_context_zv;
 
@@ -48,7 +48,7 @@ static PHP_METHOD(V8Array, __construct) {
     php_v8_value->persistent->Reset(isolate, local_array);
 }
 
-static PHP_METHOD(V8Array, Length) {
+static PHP_METHOD(Array, length) {
     if (zend_parse_parameters_none() == FAILURE) {
         return;
     }
@@ -60,19 +60,18 @@ static PHP_METHOD(V8Array, Length) {
 }
 
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_v8_array___construct, ZEND_SEND_BY_VAL, ZEND_RETURN_VALUE, 1)
+ZEND_BEGIN_ARG_INFO_EX(arginfo___construct, ZEND_SEND_BY_VAL, ZEND_RETURN_VALUE, 1)
                 ZEND_ARG_OBJ_INFO(0, context, V8\\Context, 0)
                 ZEND_ARG_TYPE_INFO(0, length, IS_LONG, 0)
 ZEND_END_ARG_INFO()
 
-PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_v8_array_Length, ZEND_RETURN_VALUE, 0, IS_LONG, 0)
+PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_length, ZEND_RETURN_VALUE, 0, IS_LONG, 0)
 ZEND_END_ARG_INFO()
 
 
 static const zend_function_entry php_v8_array_methods[] = {
-        PHP_ME(V8Array, __construct, arginfo_v8_array___construct, ZEND_ACC_PUBLIC | ZEND_ACC_CTOR)
-
-        PHP_ME(V8Array, Length, arginfo_v8_array_Length, ZEND_ACC_PUBLIC)
+        PHP_V8_ME(Array, __construct, ZEND_ACC_PUBLIC | ZEND_ACC_CTOR)
+        PHP_V8_ME(Array, length,      ZEND_ACC_PUBLIC)
 
         PHP_FE_END
 };

src/php_v8_boolean.cc

@@ -23,7 +23,7 @@ zend_class_entry *php_v8_boolean_class_entry;
 #define this_ce php_v8_boolean_class_entry
 
 
-static PHP_METHOD(V8BooleanValue, __construct) {
+static PHP_METHOD(BooleanValue, __construct) {
     zval *php_v8_isolate_zv;
 
     zend_bool value = '\0';
@@ -41,7 +41,7 @@ static PHP_METHOD(V8BooleanValue, __construct) {
     php_v8_value->persistent->Reset(isolate, local_value);
 }
 
-static PHP_METHOD(V8BooleanValue, Value) {
+static PHP_METHOD(BooleanValue, value) {
     if (zend_parse_parameters_none() == FAILURE) {
         return;
     }
@@ -55,18 +55,18 @@ static PHP_METHOD(V8BooleanValue, Value) {
 }
 
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_v8_boolean___construct, ZEND_SEND_BY_VAL, ZEND_RETURN_VALUE, 2)
+ZEND_BEGIN_ARG_INFO_EX(arginfo___construct, ZEND_SEND_BY_VAL, ZEND_RETURN_VALUE, 2)
                 ZEND_ARG_OBJ_INFO(0, isolate, V8\\Isolate, 0)
                 ZEND_ARG_TYPE_INFO(0, value, _IS_BOOL, 0)
 ZEND_END_ARG_INFO()
 
-PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_v8_boolean_Value, ZEND_RETURN_VALUE, 0, _IS_BOOL, 0)
+PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_value, ZEND_RETURN_VALUE, 0, _IS_BOOL, 0)
 ZEND_END_ARG_INFO()
 
 
 static const zend_function_entry php_v8_boolean_methods[] = {
-        PHP_ME(V8BooleanValue, __construct, arginfo_v8_boolean___construct, ZEND_ACC_PUBLIC | ZEND_ACC_CTOR)
-        PHP_ME(V8BooleanValue, Value, arginfo_v8_boolean_Value, ZEND_ACC_PUBLIC)
+        PHP_V8_ME(BooleanValue, __construct, ZEND_ACC_PUBLIC | ZEND_ACC_CTOR)
+        PHP_V8_ME(BooleanValue, value,       ZEND_ACC_PUBLIC)
         PHP_FE_END
 };
 

src/php_v8_boolean_object.cc

@@ -24,7 +24,7 @@ zend_class_entry *php_v8_boolean_object_class_entry;
 #define this_ce php_v8_boolean_object_class_entry
 
 
-static PHP_METHOD(V8BooleanObject, __construct) {
+static PHP_METHOD(BooleanObject, __construct) {
     zval rv;
     zval *php_v8_context_zv;
 
@@ -44,7 +44,7 @@ static PHP_METHOD(V8BooleanObject, __construct) {
 }
 
 
-static PHP_METHOD(V8BooleanObject, ValueOf) {
+static PHP_METHOD(BooleanObject, valueOf) {
     if (zend_parse_parameters_none() == FAILURE) {
         return;
     }
@@ -58,19 +58,18 @@ static PHP_METHOD(V8BooleanObject, ValueOf) {
 }
 
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_v8_boolean_object___construct, ZEND_SEND_BY_VAL, ZEND_RETURN_VALUE, 2)
+ZEND_BEGIN_ARG_INFO_EX(arginfo___construct, ZEND_SEND_BY_VAL, ZEND_RETURN_VALUE, 2)
                 ZEND_ARG_OBJ_INFO(0, context, V8\\Context, 0)
                 ZEND_ARG_TYPE_INFO(0, value, _IS_BOOL, 0)
 ZEND_END_ARG_INFO()
 
-PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_v8_boolean_object_ValueOf, ZEND_RETURN_VALUE, 0, _IS_BOOL, 0)
+PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_valueOf, ZEND_RETURN_VALUE, 0, _IS_BOOL, 0)
 ZEND_END_ARG_INFO()
 
 
 static const zend_function_entry php_v8_boolean_object_methods[] = {
-        PHP_ME(V8BooleanObject, __construct, arginfo_v8_boolean_object___construct, ZEND_ACC_PUBLIC | ZEND_ACC_CTOR)
-
-        PHP_ME(V8BooleanObject, ValueOf, arginfo_v8_boolean_object_ValueOf, ZEND_ACC_PUBLIC)
+        PHP_V8_ME(BooleanObject, __construct, ZEND_ACC_PUBLIC | ZEND_ACC_CTOR)
+        PHP_V8_ME(BooleanObject, valueOf,     ZEND_ACC_PUBLIC)
 
         PHP_FE_END
 };

src/php_v8_cached_data.cc

@@ -64,7 +64,7 @@ static zend_object * php_v8_cached_data_ctor(zend_class_entry *ce)
     return &php_v8_cached_data->std;
 }
 
-static PHP_METHOD(V8CachedData, __construct)
+static PHP_METHOD(CachedData, __construct)
 {
     zend_string *string = NULL;
 
@@ -83,7 +83,7 @@ static PHP_METHOD(V8CachedData, __construct)
     php_v8_cached_data->cached_data = new v8::ScriptCompiler::CachedData(data, length, v8::ScriptCompiler::CachedData::BufferPolicy::BufferOwned);
 }
 
-static PHP_METHOD(V8CachedData, GetData)
+static PHP_METHOD(CachedData, getData)
 {
     if (zend_parse_parameters_none() == FAILURE) {
         return;
@@ -94,7 +94,7 @@ static PHP_METHOD(V8CachedData, GetData)
     RETVAL_STRINGL(reinterpret_cast<const char*>(php_v8_cached_data->cached_data->data), php_v8_cached_data->cached_data->length);
 }
 
-static PHP_METHOD(V8CachedData, IsRejected)
+static PHP_METHOD(CachedData, isRejected)
 {
     if (zend_parse_parameters_none() == FAILURE) {
         return;
@@ -106,21 +106,21 @@ static PHP_METHOD(V8CachedData, IsRejected)
 }
 
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_v8_cached_data___construct, ZEND_SEND_BY_VAL, ZEND_RETURN_VALUE, 1)
+ZEND_BEGIN_ARG_INFO_EX(arginfo___construct, ZEND_SEND_BY_VAL, ZEND_RETURN_VALUE, 1)
                 ZEND_ARG_TYPE_INFO(0, data, IS_STRING, 0)
 ZEND_END_ARG_INFO()
 
-PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_v8_cached_data_GetData, ZEND_RETURN_VALUE, 0, IS_STRING, 0)
+PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_getData, ZEND_RETURN_VALUE, 0, IS_STRING, 0)
 ZEND_END_ARG_INFO()
 
-PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_v8_cached_data_IsRejected, ZEND_RETURN_VALUE, 0, _IS_BOOL, 0)
+PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_isRejected, ZEND_RETURN_VALUE, 0, _IS_BOOL, 0)
 ZEND_END_ARG_INFO()
 
 
 static const zend_function_entry php_v8_cached_data_methods[] = {
-    PHP_ME(V8CachedData, __construct,   arginfo_v8_cached_data___construct, ZEND_ACC_PUBLIC | ZEND_ACC_CTOR)
-    PHP_ME(V8CachedData, GetData,       arginfo_v8_cached_data_GetData,     ZEND_ACC_PUBLIC)
-    PHP_ME(V8CachedData, IsRejected,    arginfo_v8_cached_data_IsRejected,  ZEND_ACC_PUBLIC)
+    PHP_V8_ME(CachedData, __construct, ZEND_ACC_PUBLIC | ZEND_ACC_CTOR)
+    PHP_V8_ME(CachedData, getData,     ZEND_ACC_PUBLIC)
+    PHP_V8_ME(CachedData, isRejected,  ZEND_ACC_PUBLIC)
 
     PHP_FE_END
 };

src/php_v8_callback_info.cc

@@ -26,7 +26,7 @@ zend_class_entry *php_v8_callback_info_class_entry;
 static zend_object_handlers php_v8_callback_info_object_handlers;
 
 
-static PHP_METHOD(V8CallbackInfo, GetIsolate) {
+static PHP_METHOD(CallbackInfo, getIsolate) {
     zval rv;
     zval *tmp;
 
@@ -38,7 +38,7 @@ static PHP_METHOD(V8CallbackInfo, GetIsolate) {
     ZVAL_COPY(return_value, tmp);
 }
 
-static PHP_METHOD(V8CallbackInfo, GetContext) {
+static PHP_METHOD(CallbackInfo, getContext) {
     zval rv;
     zval *tmp;
 
@@ -50,7 +50,7 @@ static PHP_METHOD(V8CallbackInfo, GetContext) {
     ZVAL_COPY(return_value, tmp);
 }
 
-static PHP_METHOD(V8CallbackInfo, This) {
+static PHP_METHOD(CallbackInfo, this) {
     zval rv;
     zval *tmp;
 
@@ -62,7 +62,7 @@ static PHP_METHOD(V8CallbackInfo, This) {
     ZVAL_COPY(return_value, tmp);
 }
 
-static PHP_METHOD(V8CallbackInfo, Holder) {
+static PHP_METHOD(CallbackInfo, holder) {
     zval rv;
     zval *tmp;
 
@@ -74,7 +74,7 @@ static PHP_METHOD(V8CallbackInfo, Holder) {
     ZVAL_COPY(return_value, tmp);
 }
 
-static PHP_METHOD(V8CallbackInfo, GetReturnValue) {
+static PHP_METHOD(CallbackInfo, getReturnValue) {
     zval rv;
     zval *tmp;
 
@@ -86,27 +86,27 @@ static PHP_METHOD(V8CallbackInfo, GetReturnValue) {
     ZVAL_COPY(return_value, tmp);
 }
 
-PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_v8_callback_info_GetIsolate, ZEND_RETURN_VALUE, 0, V8\\Isolate, 0)
+PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_getIsolate, ZEND_RETURN_VALUE, 0, V8\\Isolate, 0)
 ZEND_END_ARG_INFO()
 
-PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_v8_callback_info_GetContext, ZEND_RETURN_VALUE, 0, V8\\Context, 0)
+PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_getContext, ZEND_RETURN_VALUE, 0, V8\\Context, 0)
 ZEND_END_ARG_INFO()
 
-PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_v8_callback_info_This, ZEND_RETURN_VALUE, 0, V8\\ObjectValue, 0)
+PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_this, ZEND_RETURN_VALUE, 0, V8\\ObjectValue, 0)
 ZEND_END_ARG_INFO()
 
-PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_v8_callback_info_Holder, ZEND_RETURN_VALUE, 0, V8\\ObjectValue, 0)
+PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_holder, ZEND_RETURN_VALUE, 0, V8\\ObjectValue, 0)
 ZEND_END_ARG_INFO()
 
-PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_v8_callback_info_GetReturnValue, ZEND_RETURN_VALUE, 0, V8\\ReturnValue, 0)
+PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_getReturnValue, ZEND_RETURN_VALUE, 0, V8\\ReturnValue, 0)
 ZEND_END_ARG_INFO()
 
 static const zend_function_entry php_v8_callback_info_methods[] = {
-        PHP_ME(V8CallbackInfo, This, arginfo_v8_callback_info_This, ZEND_ACC_PUBLIC)
-        PHP_ME(V8CallbackInfo, Holder, arginfo_v8_callback_info_Holder, ZEND_ACC_PUBLIC)
-        PHP_ME(V8CallbackInfo, GetIsolate, arginfo_v8_callback_info_GetIsolate, ZEND_ACC_PUBLIC)
-        PHP_ME(V8CallbackInfo, GetContext, arginfo_v8_callback_info_GetContext, ZEND_ACC_PUBLIC)
-        PHP_ME(V8CallbackInfo, GetReturnValue, arginfo_v8_callback_info_GetReturnValue, ZEND_ACC_PUBLIC)
+        PHP_V8_ME(CallbackInfo, this,           ZEND_ACC_PUBLIC)
+        PHP_V8_ME(CallbackInfo, holder,         ZEND_ACC_PUBLIC)
+        PHP_V8_ME(CallbackInfo, getIsolate,     ZEND_ACC_PUBLIC)
+        PHP_V8_ME(CallbackInfo, getContext,     ZEND_ACC_PUBLIC)
+        PHP_V8_ME(CallbackInfo, getReturnValue, ZEND_ACC_PUBLIC)
         PHP_FE_END
 };