Add property filtering support to V8\ObjectValue::Get{Property,OwnProperty}Names()

Author: pinepain

src/php_v8_object.cc

@@ -611,11 +611,18 @@ static PHP_METHOD(V8Object, SetNativeDataProperty) {
 
 static PHP_METHOD(V8Object, GetPropertyNames) {
     zval *context_zv;
+    zend_long mode            = static_cast<zend_long>(v8::KeyCollectionMode::kOwnOnly);
+    zend_long property_filter = static_cast<zend_long>(v8::PropertyFilter::ALL_PROPERTIES);
+    zend_long index_filter    = static_cast<zend_long>(v8::IndexFilter::kIncludeIndices);
 
-    if (zend_parse_parameters(ZEND_NUM_ARGS(), "o", &context_zv) == FAILURE) {
+    if (zend_parse_parameters(ZEND_NUM_ARGS(), "o|lll", &context_zv, &mode, &property_filter, &index_filter) == FAILURE) {
         return;
     }
 
+    mode = mode ? mode & PHP_V8_KEY_COLLECTION_MODE_FLAGS : mode;
+    property_filter = property_filter ? property_filter & PHP_V8_PROPERTY_FILTER_FLAGS : property_filter;
+    index_filter = index_filter ? index_filter & PHP_V8_INDEX_FILTER_FLAGS : index_filter;
+
     PHP_V8_VALUE_FETCH_WITH_CHECK(getThis(), php_v8_value);
     PHP_V8_CONTEXT_FETCH_WITH_CHECK(context_zv, php_v8_context);
 
@@ -629,7 +636,10 @@ static PHP_METHOD(V8Object, GetPropertyNames) {
     PHP_V8_TRY_CATCH(isolate);
     PHP_V8_INIT_ISOLATE_LIMITS_ON_OBJECT_VALUE(php_v8_value);
 
-    v8::MaybeLocal<v8::Array> maybe_local_array = local_object->GetPropertyNames(context);
+    v8::MaybeLocal<v8::Array> maybe_local_array = local_object->GetPropertyNames(context,
+                                                                                 static_cast<v8::KeyCollectionMode>(mode),
+                                                                                 static_cast<v8::PropertyFilter >(property_filter),
+                                                                                 static_cast<v8::IndexFilter>(index_filter));
 
     PHP_V8_MAYBE_CATCH(php_v8_context, try_catch);
     PHP_V8_THROW_EXCEPTION_WHEN_EMPTY(maybe_local_array, "Failed to get property names")
@@ -641,10 +651,12 @@ static PHP_METHOD(V8Object, GetPropertyNames) {
 
 static PHP_METHOD(V8Object, GetOwnPropertyNames) {
     zval *context_zv;
+    zend_long filter = static_cast<zend_long>(v8::PropertyFilter::ALL_PROPERTIES);
 
-    if (zend_parse_parameters(ZEND_NUM_ARGS(), "o", &context_zv) == FAILURE) {
+    if (zend_parse_parameters(ZEND_NUM_ARGS(), "o|l", &context_zv, &filter) == FAILURE) {
         return;
     }
+    filter = filter ? filter & PHP_V8_PROPERTY_FILTER_FLAGS : filter;
 
     PHP_V8_VALUE_FETCH_WITH_CHECK(getThis(), php_v8_value);
     PHP_V8_CONTEXT_FETCH_WITH_CHECK(context_zv, php_v8_context);
@@ -659,7 +671,7 @@ static PHP_METHOD(V8Object, GetOwnPropertyNames) {
     PHP_V8_TRY_CATCH(isolate);
     PHP_V8_INIT_ISOLATE_LIMITS_ON_OBJECT_VALUE(php_v8_value);
 
-    v8::MaybeLocal<v8::Array> maybe_local_array = local_object->GetOwnPropertyNames(context);
+    v8::MaybeLocal<v8::Array> maybe_local_array = local_object->GetOwnPropertyNames(context, static_cast<v8::PropertyFilter >(filter));
 
     PHP_V8_MAYBE_CATCH(php_v8_context, try_catch);
     PHP_V8_THROW_EXCEPTION_WHEN_EMPTY(maybe_local_array, "Failed to get own property names")
@@ -1357,10 +1369,14 @@ ZEND_END_ARG_INFO()
 
 PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_php_v8_object_GetPropertyNames, ZEND_RETURN_VALUE, 1, V8\\ArrayObject, 0)
                 ZEND_ARG_OBJ_INFO(0, context, V8\\Context, 0)
+                ZEND_ARG_TYPE_INFO(0, mode, IS_LONG, 0)
+                ZEND_ARG_TYPE_INFO(0, property_filter, IS_LONG, 0)
+                ZEND_ARG_TYPE_INFO(0, index_filter, IS_LONG, 0)
 ZEND_END_ARG_INFO()
 
 PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_php_v8_object_GetOwnPropertyNames, ZEND_RETURN_VALUE, 1, V8\\ArrayObject, 0)
                 ZEND_ARG_OBJ_INFO(0, context, V8\\Context, 0)
+                ZEND_ARG_TYPE_INFO(0, filter, IS_LONG, 0)
 ZEND_END_ARG_INFO()
 
 PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_php_v8_object_GetPrototype, ZEND_RETURN_VALUE, 0, V8\\Value, 0)

stubs/src/IndexFilter.php

@@ -17,6 +17,6 @@
 
 class IndexFilter
 {
-    const kIncludesIndices = 0; // allows for integer indices to be collected, while
+    const kIncludeIndices = 0; // allows for integer indices to be collected, while
     const kSkipIndices = 1; // will exclude integer indicies from being collected.
 }

stubs/src/ObjectValue.php

@@ -202,12 +202,18 @@ public function SetNativeDataProperty(
      * be enumerated by a for-in statement over this object.
      *
      * @param Context $context
+     * @param int     $mode            One of KeyCollectionMode options
+     * @param int     $property_filter One or multiple PropertyFilter options
+     * @param int     $index_filter    One or multiple IndexFilter options
      *
-     *
-     * @return \V8\ArrayObject
+     * @return ArrayObject
      */
-    public function GetPropertyNames(Context $context): ArrayObject
-    {
+    public function GetPropertyNames(
+        Context $context,
+        int $mode = KeyCollectionMode::kOwnOnly,
+        int $property_filter = PropertyFilter::ALL_PROPERTIES,
+        int $index_filter = IndexFilter::kIncludeIndices
+    ): ArrayObject {
     }
 
     /**
@@ -216,11 +222,11 @@ public function GetPropertyNames(Context $context): ArrayObject
      * prototype objects.
      *
      * @param Context $context
+     * @param int     $filter One or multiple PropertyFilter options
      *
-     *
-     * @return \V8\ArrayObject
+     * @return ArrayObject
      */
-    public function GetOwnPropertyNames(Context $context): ArrayObject
+    public function GetOwnPropertyNames(Context $context, int $filter = PropertyFilter::ALL_PROPERTIES): ArrayObject
     {
     }