Skip to content

Commit 844a420

Browse files
authored
ext/reflection: Document ReflectionProperty::getMangledName() (PHP 8.5) (#5693)
1 parent 5cdc4c9 commit 844a420

1 file changed

Lines changed: 89 additions & 0 deletions

File tree

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
<refentry xml:id="reflectionproperty.getmangledname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
4+
<refnamediv>
5+
<refname>ReflectionProperty::getMangledName</refname>
6+
<refpurpose>Gets the mangled name of the property</refpurpose>
7+
</refnamediv>
8+
9+
<refsect1 role="description">
10+
&reftitle.description;
11+
<methodsynopsis role="ReflectionProperty">
12+
<modifier>public</modifier> <type>string</type><methodname>ReflectionProperty::getMangledName</methodname>
13+
<void/>
14+
</methodsynopsis>
15+
<simpara>
16+
Returns the mangled (internal) name of the property, which encodes the
17+
visibility scope for private and protected properties.
18+
</simpara>
19+
<simpara>
20+
For public properties, the mangled name is identical to the property name.
21+
For protected properties, the mangled name has the form
22+
<literal>\0*\0<replaceable>name</replaceable></literal>.
23+
For private properties, the mangled name has the form
24+
<literal>\0<replaceable>ClassName</replaceable>\0<replaceable>name</replaceable></literal>.
25+
</simpara>
26+
</refsect1>
27+
28+
<refsect1 role="parameters">
29+
&reftitle.parameters;
30+
&no.function.parameters;
31+
</refsect1>
32+
33+
<refsect1 role="returnvalues">
34+
&reftitle.returnvalues;
35+
<simpara>
36+
The mangled name of the reflected property.
37+
</simpara>
38+
</refsect1>
39+
40+
<refsect1 role="changelog">
41+
&reftitle.changelog;
42+
<informaltable>
43+
<tgroup cols="2">
44+
<thead>
45+
<row>
46+
<entry>&Version;</entry>
47+
<entry>&Description;</entry>
48+
</row>
49+
</thead>
50+
<tbody>
51+
<row>
52+
<entry>8.5.0</entry>
53+
<entry>
54+
This method was introduced.
55+
</entry>
56+
</row>
57+
</tbody>
58+
</tgroup>
59+
</informaltable>
60+
</refsect1>
61+
62+
<refsect1 role="seealso">
63+
&reftitle.seealso;
64+
<simplelist>
65+
<member><methodname>ReflectionProperty::getName</methodname></member>
66+
</simplelist>
67+
</refsect1>
68+
69+
</refentry>
70+
<!-- Keep this comment at the end of the file
71+
Local variables:
72+
mode: sgml
73+
sgml-omittag:t
74+
sgml-shorttag:t
75+
sgml-minimize-attributes:nil
76+
sgml-always-quote-attributes:t
77+
sgml-indent-step:1
78+
sgml-indent-data:t
79+
indent-tabs-mode:nil
80+
sgml-parent-document:nil
81+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
82+
sgml-exposed-tags:nil
83+
sgml-local-catalogs:nil
84+
sgml-local-ecat-files:nil
85+
End:
86+
vim600: syn=xml fen fdm=syntax fdl=2 si
87+
vim: et tw=78 syn=sgml
88+
vi: ts=1 sw=1
89+
-->

0 commit comments

Comments
 (0)