[php][compiler][ext] - Add missing has* methods and other well known types (#20636)

FabioBatSilva · copybara-github · commit 01a7429792ce · 2025-05-08T12:29:39.000-07:00
Should fix : #20036 Closes #20636 COPYBARA_INTEGRATE_REVIEW=#20636 from ChessCom:php-wellknown-types-predicate-methods 65aece9 PiperOrigin-RevId: 756414066
diff --git a/php/ext/google/protobuf/wkt.inc b/php/ext/google/protobuf/wkt.inc
@@ -319,6 +319,13 @@ static PHP_METHOD(google_protobuf_Api, setSourceContext) {
   RETURN_COPY(getThis());
 }
 
+static PHP_METHOD(google_protobuf_Api, hasSourceContext) {
+  Message* intern = (Message*)Z_OBJ_P(getThis());
+  const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
+      intern->desc->msgdef, "source_context");
+  RETVAL_BOOL(upb_Message_HasFieldByDef(intern->msg, f));
+}
+
 static PHP_METHOD(google_protobuf_Api, getMixins) {
   Message* intern = (Message*)Z_OBJ_P(getThis());
   const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
@@ -375,6 +382,7 @@ static zend_function_entry google_protobuf_Api_phpmethods[] = {
   PHP_ME(google_protobuf_Api, setVersion, arginfo_setter, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Api, getSourceContext, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Api, setSourceContext, arginfo_setter, ZEND_ACC_PUBLIC)
+  PHP_ME(google_protobuf_Api, hasSourceContext, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Api, getMixins, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Api, setMixins, arginfo_setter, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Api, getSyntax, arginfo_void, ZEND_ACC_PUBLIC)
@@ -1183,12 +1191,20 @@ static PHP_METHOD(google_protobuf_Struct_FieldsEntry, setValue) {
   RETURN_COPY(getThis());
 }
 
+static PHP_METHOD(google_protobuf_Struct_FieldsEntry, hasValue) {
+  Message* intern = (Message*)Z_OBJ_P(getThis());
+  const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
+      intern->desc->msgdef, "value");
+  RETVAL_BOOL(upb_Message_HasFieldByDef(intern->msg, f));
+}
+
 static zend_function_entry google_protobuf_Struct_FieldsEntry_phpmethods[] = {
   PHP_ME(google_protobuf_Struct_FieldsEntry, __construct, arginfo_construct, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Struct_FieldsEntry, getKey, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Struct_FieldsEntry, setKey, arginfo_setter, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Struct_FieldsEntry, getValue, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Struct_FieldsEntry, setValue, arginfo_setter, ZEND_ACC_PUBLIC)
+  PHP_ME(google_protobuf_Struct_FieldsEntry, hasValue, arginfo_void, ZEND_ACC_PUBLIC)
   ZEND_FE_END
 };
 
@@ -1235,6 +1251,13 @@ static PHP_METHOD(google_protobuf_Value, setNullValue) {
   RETURN_COPY(getThis());
 }
 
+static PHP_METHOD(google_protobuf_Value, hasNullValue) {
+  Message* intern = (Message*)Z_OBJ_P(getThis());
+  const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
+      intern->desc->msgdef, "null_value");
+  RETVAL_BOOL(upb_Message_HasFieldByDef(intern->msg, f));
+}
+
 static PHP_METHOD(google_protobuf_Value, getNumberValue) {
   Message* intern = (Message*)Z_OBJ_P(getThis());
   const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
@@ -1257,6 +1280,13 @@ static PHP_METHOD(google_protobuf_Value, setNumberValue) {
   RETURN_COPY(getThis());
 }
 
+static PHP_METHOD(google_protobuf_Value, hasNumberValue) {
+  Message* intern = (Message*)Z_OBJ_P(getThis());
+  const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
+      intern->desc->msgdef, "number_value");
+  RETVAL_BOOL(upb_Message_HasFieldByDef(intern->msg, f));
+}
+
 static PHP_METHOD(google_protobuf_Value, getStringValue) {
   Message* intern = (Message*)Z_OBJ_P(getThis());
   const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
@@ -1279,6 +1309,13 @@ static PHP_METHOD(google_protobuf_Value, setStringValue) {
   RETURN_COPY(getThis());
 }
 
+static PHP_METHOD(google_protobuf_Value, hasStringValue) {
+  Message* intern = (Message*)Z_OBJ_P(getThis());
+  const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
+      intern->desc->msgdef, "string_value");
+  RETVAL_BOOL(upb_Message_HasFieldByDef(intern->msg, f));
+}
+
 static PHP_METHOD(google_protobuf_Value, getBoolValue) {
   Message* intern = (Message*)Z_OBJ_P(getThis());
   const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
@@ -1301,6 +1338,13 @@ static PHP_METHOD(google_protobuf_Value, setBoolValue) {
   RETURN_COPY(getThis());
 }
 
+static PHP_METHOD(google_protobuf_Value, hasBoolValue) {
+  Message* intern = (Message*)Z_OBJ_P(getThis());
+  const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
+      intern->desc->msgdef, "bool_value");
+  RETVAL_BOOL(upb_Message_HasFieldByDef(intern->msg, f));
+}
+
 static PHP_METHOD(google_protobuf_Value, getStructValue) {
   Message* intern = (Message*)Z_OBJ_P(getThis());
   const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
@@ -1323,6 +1367,13 @@ static PHP_METHOD(google_protobuf_Value, setStructValue) {
   RETURN_COPY(getThis());
 }
 
+static PHP_METHOD(google_protobuf_Value, hasStructValue) {
+  Message* intern = (Message*)Z_OBJ_P(getThis());
+  const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
+      intern->desc->msgdef, "struct_value");
+  RETVAL_BOOL(upb_Message_HasFieldByDef(intern->msg, f));
+}
+
 static PHP_METHOD(google_protobuf_Value, getListValue) {
   Message* intern = (Message*)Z_OBJ_P(getThis());
   const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
@@ -1345,6 +1396,13 @@ static PHP_METHOD(google_protobuf_Value, setListValue) {
   RETURN_COPY(getThis());
 }
 
+static PHP_METHOD(google_protobuf_Value, hasListValue) {
+  Message* intern = (Message*)Z_OBJ_P(getThis());
+  const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
+      intern->desc->msgdef, "list_value");
+  RETVAL_BOOL(upb_Message_HasFieldByDef(intern->msg, f));
+}
+
 static PHP_METHOD(google_protobuf_Value, getKind) {
   Message* intern = (Message*)Z_OBJ_P(getThis());
   const upb_OneofDef *oneof = upb_MessageDef_FindOneofByName(
@@ -1357,16 +1415,22 @@ static zend_function_entry google_protobuf_Value_phpmethods[] = {
   PHP_ME(google_protobuf_Value, __construct, arginfo_construct, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Value, getNullValue, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Value, setNullValue, arginfo_setter, ZEND_ACC_PUBLIC)
+  PHP_ME(google_protobuf_Value, hasNullValue, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Value, getNumberValue, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Value, setNumberValue, arginfo_setter, ZEND_ACC_PUBLIC)
+  PHP_ME(google_protobuf_Value, hasNumberValue, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Value, getStringValue, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Value, setStringValue, arginfo_setter, ZEND_ACC_PUBLIC)
+  PHP_ME(google_protobuf_Value, hasStringValue, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Value, getBoolValue, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Value, setBoolValue, arginfo_setter, ZEND_ACC_PUBLIC)
+  PHP_ME(google_protobuf_Value, hasBoolValue, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Value, getStructValue, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Value, setStructValue, arginfo_setter, ZEND_ACC_PUBLIC)
+  PHP_ME(google_protobuf_Value, hasStructValue, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Value, getListValue, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Value, setListValue, arginfo_setter, ZEND_ACC_PUBLIC)
+  PHP_ME(google_protobuf_Value, hasListValue, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Value, getKind, arginfo_void, ZEND_ACC_PUBLIC)
   ZEND_FE_END
 };
@@ -1836,6 +1900,13 @@ static PHP_METHOD(google_protobuf_Type, setSourceContext) {
   RETURN_COPY(getThis());
 }
 
+static PHP_METHOD(google_protobuf_Type, hasSourceContext) {
+  Message* intern = (Message*)Z_OBJ_P(getThis());
+  const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
+      intern->desc->msgdef, "source_context");
+  RETVAL_BOOL(upb_Message_HasFieldByDef(intern->msg, f));
+}
+
 static PHP_METHOD(google_protobuf_Type, getSyntax) {
   Message* intern = (Message*)Z_OBJ_P(getThis());
   const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
@@ -1892,6 +1963,7 @@ static zend_function_entry google_protobuf_Type_phpmethods[] = {
   PHP_ME(google_protobuf_Type, setOptions, arginfo_setter, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Type, getSourceContext, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Type, setSourceContext, arginfo_setter, ZEND_ACC_PUBLIC)
+  PHP_ME(google_protobuf_Type, hasSourceContext, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Type, getSyntax, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Type, setSyntax, arginfo_setter, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Type, getEdition, arginfo_void, ZEND_ACC_PUBLIC)
@@ -2444,6 +2516,13 @@ static PHP_METHOD(google_protobuf_Enum, setSourceContext) {
   RETURN_COPY(getThis());
 }
 
+static PHP_METHOD(google_protobuf_Enum, hasSourceContext) {
+  Message* intern = (Message*)Z_OBJ_P(getThis());
+  const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
+      intern->desc->msgdef, "source_context");
+  RETVAL_BOOL(upb_Message_HasFieldByDef(intern->msg, f));
+}
+
 static PHP_METHOD(google_protobuf_Enum, getSyntax) {
   Message* intern = (Message*)Z_OBJ_P(getThis());
   const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
@@ -2498,6 +2577,7 @@ static zend_function_entry google_protobuf_Enum_phpmethods[] = {
   PHP_ME(google_protobuf_Enum, setOptions, arginfo_setter, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Enum, getSourceContext, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Enum, setSourceContext, arginfo_setter, ZEND_ACC_PUBLIC)
+  PHP_ME(google_protobuf_Enum, hasSourceContext, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Enum, getSyntax, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Enum, setSyntax, arginfo_setter, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Enum, getEdition, arginfo_void, ZEND_ACC_PUBLIC)
@@ -2668,12 +2748,20 @@ static PHP_METHOD(google_protobuf_Option, setValue) {
   RETURN_COPY(getThis());
 }
 
+static PHP_METHOD(google_protobuf_Option, hasValue) {
+  Message* intern = (Message*)Z_OBJ_P(getThis());
+  const upb_FieldDef *f = upb_MessageDef_FindFieldByName(
+      intern->desc->msgdef, "value");
+  RETVAL_BOOL(upb_Message_HasFieldByDef(intern->msg, f));
+}
+
 static zend_function_entry google_protobuf_Option_phpmethods[] = {
   PHP_ME(google_protobuf_Option, __construct, arginfo_construct, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Option, getName, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Option, setName, arginfo_setter, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Option, getValue, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(google_protobuf_Option, setValue, arginfo_setter, ZEND_ACC_PUBLIC)
+  PHP_ME(google_protobuf_Option, hasValue, arginfo_void, ZEND_ACC_PUBLIC)
   ZEND_FE_END
 };
 
diff --git a/php/tests/WellKnownTest.php b/php/tests/WellKnownTest.php
@@ -270,29 +270,63 @@ public function testStruct()
 
         $m = new Value();
 
-        $this->assertNull($m->getStructValue());
+        # null_value
+        $this->assertFalse($m->hasNullValue());
 
         $m->setNullValue(NullValue::NULL_VALUE);
-        $this->assertSame(NullValue::NULL_VALUE, $m->getNullValue());
+
+        $this->assertTrue($m->hasNullValue());
         $this->assertSame("null_value", $m->getKind());
+        $this->assertSame(NullValue::NULL_VALUE, $m->getNullValue());
+
+        # number_value
+        $this->assertFalse($m->hasNumberValue());
 
         $m->setNumberValue(1.0);
+
+        $this->assertTrue($m->hasNumberValue());
         $this->assertSame(1.0, $m->getNumberValue());
         $this->assertSame("number_value", $m->getKind());
 
+        # string_value
+        $this->assertFalse($m->hasStringValue());
+
         $m->setStringValue("a");
+
+        $this->assertTrue($m->hasStringValue());
+
         $this->assertSame("a", $m->getStringValue());
         $this->assertSame("string_value", $m->getKind());
 
+        # bool_value
+        $this->assertFalse($m->hasBoolValue());
+
         $m->setBoolValue(true);
+
+        $this->assertTrue($m->hasBoolValue());
+
         $this->assertSame(true, $m->getBoolValue());
         $this->assertSame("bool_value", $m->getKind());
 
+
+        # struct_value
+        $this->assertNull($m->getStructValue());
+        $this->assertFalse($m->hasStructValue());
+
         $m->setStructValue(new Struct());
+
+        $this->assertTrue($m->hasStructValue());
+
         $this->assertFalse(is_null($m->getStructValue()));
         $this->assertSame("struct_value", $m->getKind());
 
+        # list_value
+        $this->assertFalse($m->hasListValue());
+
         $m->setListValue(new ListValue());
+
+        $this->assertTrue($m->hasListValue());
+
         $this->assertFalse(is_null($m->getListValue()));
         $this->assertSame("list_value", $m->getKind());
 
diff --git a/src/google/protobuf/compiler/php/php_generator.cc b/src/google/protobuf/compiler/php/php_generator.cc
@@ -1767,6 +1767,8 @@ void GenerateCMessage(const Descriptor* message, io::Printer* printer) {
 
   for (int i = 0; i < message->field_count(); i++) {
     auto field = message->field(i);
+    auto camel_name = UnderscoresToCamelCase(field->name(), true);
+
     printer->Print(
         "static PHP_METHOD($c_name$, get$camel_name$) {\n"
         "  Message* intern = (Message*)Z_OBJ_P(getThis());\n"
@@ -1790,8 +1792,19 @@ void GenerateCMessage(const Descriptor* message, io::Printer* printer) {
         "  RETURN_COPY(getThis());\n"
         "}\n"
         "\n",
-        "c_name", c_name, "name", field->name(), "camel_name",
-        UnderscoresToCamelCase(field->name(), true));
+        "c_name", c_name, "name", field->name(), "camel_name", camel_name);
+
+    if (field->has_presence()) {
+      printer->Print(
+          "static PHP_METHOD($c_name$, has$camel_name$) {\n"
+          "  Message* intern = (Message*)Z_OBJ_P(getThis());\n"
+          "  const upb_FieldDef *f = upb_MessageDef_FindFieldByName(\n"
+          "      intern->desc->msgdef, \"$name$\");\n"
+          "  RETVAL_BOOL(upb_Message_HasFieldByDef(intern->msg, f));\n"
+          "}\n"
+          "\n",
+          "c_name", c_name, "name", field->name(), "camel_name", camel_name);
+    }
   }
 
   for (int i = 0; i < message->real_oneof_decl_count(); i++) {
@@ -1835,12 +1848,20 @@ void GenerateCMessage(const Descriptor* message, io::Printer* printer) {
 
   for (int i = 0; i < message->field_count(); i++) {
     auto field = message->field(i);
+    auto camel_name = UnderscoresToCamelCase(field->name(), true);
+
     printer->Print(
         "  PHP_ME($c_name$, get$camel_name$, arginfo_void, ZEND_ACC_PUBLIC)\n"
         "  PHP_ME($c_name$, set$camel_name$, arginfo_setter, "
         "ZEND_ACC_PUBLIC)\n",
-        "c_name", c_name, "camel_name",
-        UnderscoresToCamelCase(field->name(), true));
+        "c_name", c_name, "camel_name", camel_name);
+
+    if (field->has_presence()) {
+      printer->Print(
+          "  PHP_ME($c_name$, has$camel_name$, arginfo_void, "
+          "ZEND_ACC_PUBLIC)\n",
+          "c_name", c_name, "camel_name", camel_name);
+    }
   }
 
   for (int i = 0; i < message->real_oneof_decl_count(); i++) {
