Skip to content

Document ReflectionClassConstant::isDeprecated() #3895

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

Merged
merged 2 commits into from
Nov 12, 2024
Merged

Document ReflectionClassConstant::isDeprecated() #3895

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb0e3fe
Document `ReflectionClassConstant::isDeprecated()`
TimWolla Oct 22, 2024
b605b13
Review
Girgias Nov 12, 2024
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
90 changes: 90 additions & 0 deletions reference/reflection/reflectionclassconstant/isdeprecated.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="reflectionclassconstant.isdeprecated" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ReflectionClassConstant::isDeprecated</refname>
<refpurpose>Checks if deprecated</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="ReflectionClassConstant">
<modifier>public</modifier> <type>bool</type><methodname>ReflectionClassConstant::isDeprecated</methodname>
<void/>
</methodsynopsis>
<simpara>
Checks whether the class constant is deprecated.
</simpara>

</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&true; if it's deprecated, otherwise &false;
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
<title>
<methodname>ReflectionClassConstant::isDeprecated</methodname> example
</title>
<programlisting role="php">
<![CDATA[
<?php
class Basket {
#[\Deprecated(message: 'use Basket::APPLE instead')]
public const APLE = 'apple';

public const APPLE = 'apple';
}
$classConstant = new ReflectionClassConstant('Basket', 'APLE');
var_dump($classConstant->isDeprecated());
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(true)
]]>
</screen>
</example>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><classname>Deprecated</classname></member>
<member><methodname>ReflectionClassConstant::getDocComment</methodname></member>
</simplelist>
</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
-->
1 change: 1 addition & 0 deletions reference/reflection/versions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,7 @@
<function name="reflectionclassconstant::__tostring" from="PHP 7 &gt;= 7.1.0, PHP 8"/>
<function name="reflectionclassconstant::export" from="PHP 7 &gt;= 7.1.0" deprecated="PHP 7.4.0" removed="PHP 8"/>
<function name="reflectionclassconstant::getname" from="PHP 7 &gt;= 7.1.0, PHP 8"/>
<function name="reflectionclassconstant::isdeprecated" from="PHP 8 &gt;= 8.4.0"/>
<function name="reflectionclassconstant::isenumcase" from="PHP 8 &gt;= 8.1.0"/>
<function name="reflectionclassconstant::isfinal" from="PHP 8 &gt;= 8.1.0"/>
<function name="reflectionclassconstant::ispublic" from="PHP 7 &gt;= 7.1.0, PHP 8"/>
Expand Down