From 6b739fa2ec43c63d3b2ca6867254faaa8f60f6d8 Mon Sep 17 00:00:00 2001
From: Sergey Panteleev <sergey@php.net>
Date: Fri, 17 Sep 2021 22:55:42 +0300
Subject: [PATCH] Add `get_mangled_object_vars` description (#953)

Co-authored-by: George Peter Banyard <girgias@php.net>
---
 .../functions/get-mangled-object-vars.xml     | 146 ++++++++++++++++++
 reference/classobj/versions.xml               |   1 +
 2 files changed, 147 insertions(+)
 create mode 100644 reference/classobj/functions/get-mangled-object-vars.xml

diff --git a/reference/classobj/functions/get-mangled-object-vars.xml b/reference/classobj/functions/get-mangled-object-vars.xml
new file mode 100644
index 0000000000..61a02f0cfd
--- /dev/null
+++ b/reference/classobj/functions/get-mangled-object-vars.xml
@@ -0,0 +1,146 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="function.get-mangled-object-vars" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>get_mangled_object_vars</refname>
+  <refpurpose>Returns an array of mangled object properties</refpurpose>
+ </refnamediv>
+ 
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>array</type><methodname>get_mangled_object_vars</methodname>
+   <methodparam><type>object</type><parameter>object</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Returns an &array; whose elements are the <parameter>object</parameter>'s
+   properties. The keys are the member variable names, with a few notable
+   exceptions: private variables have the class name prepended to the variable name,
+   and protected variables have a <literal>*</literal> prepended to the variable name.
+   These prepended values have <literal>NUL</literal> bytes on either side.
+  </para>
+ </refsect1>
+ 
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>object</parameter></term>
+     <listitem>
+      <para>
+       An object instance.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+ 
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns an &array; containing all properties, regardless of visibility, of <parameter>object</parameter>.
+  </para>
+ </refsect1>
+ 
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><function>get_mangled_object_vars</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+
+class A
+{
+    public $public = 1;
+
+    protected $protected = 2;
+
+    private $private = 3;
+}
+
+class B extends A
+{
+    private $private = 4;
+}
+
+$object = new B;
+$object->dynamic = 5;
+$object->{'6'} = 6;
+
+var_dump(get_mangled_object_vars($object));
+
+class AO extends ArrayObject
+{
+    private $private = 1;
+}
+
+$arrayObject = new AO(['x' => 'y']);
+$arrayObject->dynamic = 2;
+
+var_dump(get_mangled_object_vars($arrayObject));
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+array(6) {
+  ["Bprivate"]=>
+  int(4)
+  ["public"]=>
+  int(1)
+  ["*protected"]=>
+  int(2)
+  ["Aprivate"]=>
+  int(3)
+  ["dynamic"]=>
+  int(5)
+  [6]=>
+  int(6)
+}
+array(2) {
+  ["AOprivate"]=>
+  int(1)
+  ["dynamic"]=>
+  int(2)
+}
+
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+ 
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>get_class_vars</function></member>
+    <member><function>get_object_vars</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
+ 
+</refentry>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/classobj/versions.xml b/reference/classobj/versions.xml
index 7d88b25f6a..51ad032184 100644
--- a/reference/classobj/versions.xml
+++ b/reference/classobj/versions.xml
@@ -15,6 +15,7 @@
  <function name="get_declared_classes" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
  <function name="get_declared_interfaces" from="PHP 5, PHP 7, PHP 8"/>
  <function name="get_declared_traits" from="PHP 5 &gt;= 5.4.0, PHP 7, PHP 8"/>
+ <function name="get_mangled_object_vars" from="PHP 7 &gt;= 7.4.0, PHP 8"/>
  <function name="get_object_vars" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
  <function name="get_parent_class" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
  <function name="interface_exists" from="PHP 5 &gt;= 5.0.2, PHP 7, PHP 8"/>