Skip to content

Stricter return type for getBackingType #1608

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
SamMousa wants to merge 7 commits into from
Closed

Stricter return type for getBackingType #1608

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3c9f076
Better return types for `getBackingType`
SamMousa Jun 2, 2022
3537585
chore: add changelog entry
SamMousa Jun 3, 2022
19b2e57
Update reference/reflection/reflectionenum/getbackingtype.xml
SamMousa Jun 6, 2022
fa57d78
Update reference/reflection/reflectionenum/getbackingtype.xml
SamMousa Jun 6, 2022
ca27c0a
Update reference/reflection/reflectionenum/getbackingtype.xml
SamMousa Jun 6, 2022
3c9b2c7
fix: changelog before examples
SamMousa Jun 15, 2022
816d2d0
Update reference/reflection/reflectionenum/getbackingtype.xml
SamMousa Jun 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 26 additions & 5 deletions reference/reflection/reflectionenum/getbackingtype.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>ReflectionType</type><type>null</type></type><methodname>ReflectionEnum::getBackingType</methodname>
<modifier>public</modifier> <type class="union"><type>ReflectionNamedType</type><type>null</type></type><methodname>ReflectionEnum::getBackingType</methodname>
<void />
</methodsynopsis>
<para>
If the enumeration is a Backed Enum, this method will return an instance
of <classname>ReflectionType</classname> for the backing type of the Enum.
of <classname>ReflectionNamedType</classname> for the backing type of the Enum.
If it is not a Backed Enum, it will return <literal>null</literal>.
</para>

Expand All @@ -27,11 +27,32 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An instance of <classname>ReflectionType</classname>, or <literal>null</literal>
An instance of <classname>ReflectionNamedType</classname>, or <literal>null</literal>
if the Enum has no backing type.
</para>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.2.0</entry>
<entry>
The declared return type was narrowed to <classname>ReflectionNamedType</classname>
from <classname>ReflectionType</classname>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
Expand Down Expand Up @@ -65,7 +86,7 @@ string(6) "string"
</example>
</para>
</refsect1>
Comment thread
SamMousa marked this conversation as resolved.

Comment thread
SamMousa marked this conversation as resolved.
<refsect1 role="seealso">
&reftitle.seealso;
<para>
Expand Down