php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document ReflectionClassConstant::isDeprecated() (#3895)

Browse Source
This commit is contained in:
Tim Düsterhus
2024-11-12 15:25:41 +01:00
committed by GitHub
parent 42432109c9
commit 7de265dc47
2 changed files with 91 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
reference/reflection/reflectionclassconstant/isdeprecated.xml Normal file
View File

@@ -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
reference/reflection/versions.xml
View File

@@ -276,6 +276,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"/>