Change the order of properties used in foreach(), var_dump(), serialize(), comparison, etc. Now properties are ordered according to their layout in zend_object structure.

Author: dstogov

UPGRADING

@@ -211,6 +211,15 @@ PHP 8.1 UPGRADE NOTES
 5. Changed Functions
 ========================================
 
+- Core:
+  . Properties order used in foreach, var_dump(), serialize(), object comparison
+    etc. was changed. Now properties are naturally ordered according to their
+    declaration and inheritance. Prpoerties declared in a base class are going
+    to be before the child properties. This order is consistent with internal
+    layout of properies in zend_objct structure and repeats the order in
+    default_properties_table[] and properties_info_table[]. The old order was
+    not documented and was caused by class inheritance implementation details.
+
 - Filter:
   . The FILTER_FLAG_ALLOW_OCTAL flag of the FILTER_VALIDATE_INT filter now accept
     octal string with the leading octal prefix ("0o"/"0O")

Zend/tests/bug27798.phpt

@@ -57,12 +57,12 @@ array(3) {
 }
 Child::__construct
 array(3) {
-  ["Baz"]=>
-  int(4)
   ["Foo"]=>
   int(1)
   ["Bar"]=>
   int(2)
+  ["Baz"]=>
+  int(4)
 }
 array(1) {
   ["Foo"]=>

Zend/tests/bug60536_003.phpt

@@ -32,14 +32,14 @@ var_dump($b);
 ?>
 --EXPECTF--
 object(SubclassA)#%d (2) {
-  ["hello":"SubclassA":private]=>
-  int(0)
   ["hello":"BaseWithPropA":private]=>
   int(0)
+  ["hello":"SubclassA":private]=>
+  int(0)
 }
 object(SubclassB)#%d (2) {
-  ["hello":"SubclassB":private]=>
-  int(0)
   ["hello":"BaseWithTPropB":private]=>
   int(0)
+  ["hello":"SubclassB":private]=>
+  int(0)
 }

Zend/tests/bug79862.phpt

@@ -45,14 +45,14 @@ NULL
 NULL
 NULL
 object(c)#1 (6) {
-  ["prop1"]=>
-  int(1)
-  ["prop2":protected]=>
-  int(2)
   ["prop3":"a":private]=>
   int(3)
   ["prop4":"a":private]=>
   int(4)
+  ["prop1"]=>
+  int(1)
+  ["prop2":protected]=>
+  int(2)
   ["prop5"]=>
   int(5)
   ["prop6"]=>

Zend/tests/get_mangled_object_vars.phpt

@@ -33,10 +33,10 @@ echo "\n";
 ?>
 --EXPECT--
 array (
-  '' . "\0" . 'B' . "\0" . 'priv' => 4,
   'pub' => 1,
   '' . "\0" . '*' . "\0" . 'prot' => 2,
   '' . "\0" . 'A' . "\0" . 'priv' => 3,
+  '' . "\0" . 'B' . "\0" . 'priv' => 4,
   'dyn' => 5,
   6 => 6,
 )

Zend/tests/objects_033.phpt

@@ -24,5 +24,5 @@ print_r($a, true);
 var_dump($a < $b);
 ?>
 --EXPECT--
-bool(false)
-bool(false)
+bool(true)
+bool(true)

Zend/tests/traits/property008.phpt

@@ -42,20 +42,20 @@ var_dump($b);
 ?>
 --EXPECT--
 object(SubclassClassicInheritance)#1 (2) {
-  ["hello":"SubclassClassicInheritance":private]=>
-  int(0)
   ["hello":"BaseWithPropA":private]=>
   int(0)
+  ["hello":"SubclassClassicInheritance":private]=>
+  int(0)
 }
 object(SubclassA)#2 (2) {
-  ["hello":"SubclassA":private]=>
-  int(0)
   ["hello":"BaseWithPropA":private]=>
   int(0)
+  ["hello":"SubclassA":private]=>
+  int(0)
 }
 object(SubclassB)#3 (2) {
-  ["hello":"SubclassB":private]=>
-  int(0)
   ["hello":"BaseWithTPropB":private]=>
   int(0)
+  ["hello":"SubclassB":private]=>
+  int(0)
 }

Zend/zend_object_handlers.c

@@ -63,41 +63,24 @@ ZEND_API void rebuild_object_properties(zend_object *zobj) /* {{{ */
 	if (!zobj->properties) {
 		zend_property_info *prop_info;
 		zend_class_entry *ce = zobj->ce;
-		uint32_t flags = 0;
+		int i;
 
 		zobj->properties = zend_new_array(ce->default_properties_count);
 		if (ce->default_properties_count) {
 			zend_hash_real_init_mixed(zobj->properties);
-			ZEND_HASH_FOREACH_PTR(&ce->properties_info, prop_info) {
-				if (!(prop_info->flags & ZEND_ACC_STATIC)) {
-					flags |= prop_info->flags;
+			for (i = 0; i < ce->default_properties_count; i++) {
+				prop_info = ce->properties_info_table[i];
 
-					if (UNEXPECTED(Z_TYPE_P(OBJ_PROP(zobj, prop_info->offset)) == IS_UNDEF)) {
-						HT_FLAGS(zobj->properties) |= HASH_FLAG_HAS_EMPTY_IND;
-					}
-
-					_zend_hash_append_ind(zobj->properties, prop_info->name,
-						OBJ_PROP(zobj, prop_info->offset));
+				if (!prop_info) {
+					continue;
 				}
-			} ZEND_HASH_FOREACH_END();
-			if (flags & ZEND_ACC_CHANGED) {
-				while (ce->parent && ce->parent->default_properties_count) {
-					ce = ce->parent;
-					ZEND_HASH_FOREACH_PTR(&ce->properties_info, prop_info) {
-						if (prop_info->ce == ce &&
-						    !(prop_info->flags & ZEND_ACC_STATIC) &&
-						    (prop_info->flags & ZEND_ACC_PRIVATE)) {
-							zval zv;
-
-							if (UNEXPECTED(Z_TYPE_P(OBJ_PROP(zobj, prop_info->offset)) == IS_UNDEF)) {
-								HT_FLAGS(zobj->properties) |= HASH_FLAG_HAS_EMPTY_IND;
-							}
-
-							ZVAL_INDIRECT(&zv, OBJ_PROP(zobj, prop_info->offset));
-							zend_hash_add(zobj->properties, prop_info->name, &zv);
-						}
-					} ZEND_HASH_FOREACH_END();
+
+				if (UNEXPECTED(Z_TYPE_P(OBJ_PROP(zobj, prop_info->offset)) == IS_UNDEF)) {
+					HT_FLAGS(zobj->properties) |= HASH_FLAG_HAS_EMPTY_IND;
 				}
+
+				_zend_hash_append_ind(zobj->properties, prop_info->name,
+					OBJ_PROP(zobj, prop_info->offset));
 			}
 		}
 	}
@@ -1555,6 +1538,7 @@ ZEND_API int zend_std_compare_objects(zval *o1, zval *o2) /* {{{ */
 	}
 	if (!zobj1->properties && !zobj2->properties) {
 		zend_property_info *info;
+		int i;
 
 		if (!zobj1->ce->default_properties_count) {
 			return 0;
@@ -1570,14 +1554,18 @@ ZEND_API int zend_std_compare_objects(zval *o1, zval *o2) /* {{{ */
 		}
 		Z_PROTECT_RECURSION_P(o1);
 
-		ZEND_HASH_FOREACH_PTR(&zobj1->ce->properties_info, info) {
-			zval *p1 = OBJ_PROP(zobj1, info->offset);
-			zval *p2 = OBJ_PROP(zobj2, info->offset);
+		for (i = 0; i < zobj1->ce->default_properties_count; i++) {
+			zval *p1, *p2;
+
+			info = zobj1->ce->properties_info_table[i];
 
-			if (info->flags & ZEND_ACC_STATIC) {
+			if (!info) {
 				continue;
 			}
 
+			p1 = OBJ_PROP(zobj1, info->offset);
+			p2 = OBJ_PROP(zobj2, info->offset);
+
 			if (Z_TYPE_P(p1) != IS_UNDEF) {
 				if (Z_TYPE_P(p2) != IS_UNDEF) {
 					int ret;
@@ -1597,7 +1585,7 @@ ZEND_API int zend_std_compare_objects(zval *o1, zval *o2) /* {{{ */
 					return 1;
 				}
 			}
-		} ZEND_HASH_FOREACH_END();
+		}
 
 		Z_UNPROTECT_RECURSION_P(o1);
 		return 0;

ext/date/tests/DateTimeZone_clone_basic2.phpt

@@ -51,28 +51,28 @@ object(DateTimeZoneExt1)#%d (4) {
   string(13) "Europe/London"
 }
 object(DateTimeZoneExt2)#%d (6) {
-  ["property3"]=>
-  bool(true)
-  ["property4"]=>
-  float(10.5)
   ["property1"]=>
   int(99)
   ["property2"]=>
   string(5) "Hello"
+  ["property3"]=>
+  bool(true)
+  ["property4"]=>
+  float(10.5)
   ["timezone_type"]=>
   int(3)
   ["timezone"]=>
   string(13) "Europe/London"
 }
 object(DateTimeZoneExt2)#%d (6) {
-  ["property3"]=>
-  bool(true)
-  ["property4"]=>
-  float(10.5)
   ["property1"]=>
   int(99)
   ["property2"]=>
   string(5) "Hello"
+  ["property3"]=>
+  bool(true)
+  ["property4"]=>
+  float(10.5)
   ["timezone_type"]=>
   int(3)
   ["timezone"]=>

ext/date/tests/DateTime_clone_basic2.phpt

@@ -55,14 +55,14 @@ object(DateTimeExt1)#%d (5) {
   string(3) "GMT"
 }
 object(DateTimeExt2)#%d (7) {
-  ["property3"]=>
-  bool(true)
-  ["property4"]=>
-  float(10.5)
   ["property1"]=>
   int(99)
   ["property2"]=>
   string(5) "Hello"
+  ["property3"]=>
+  bool(true)
+  ["property4"]=>
+  float(10.5)
   ["date"]=>
   string(26) "2009-02-03 12:34:41.000000"
   ["timezone_type"]=>
@@ -71,14 +71,14 @@ object(DateTimeExt2)#%d (7) {
   string(3) "GMT"
 }
 object(DateTimeExt2)#%d (7) {
-  ["property3"]=>
-  bool(true)
-  ["property4"]=>
-  float(10.5)
   ["property1"]=>
   int(99)
   ["property2"]=>
   string(5) "Hello"
+  ["property3"]=>
+  bool(true)
+  ["property4"]=>
+  float(10.5)
   ["date"]=>
   string(26) "2009-02-03 12:34:41.000000"
   ["timezone_type"]=>