mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 10:58:54 +00:00
99 lines
2.6 KiB
XML
99 lines
2.6 KiB
XML
|
<?xml version="1.0" encoding="utf-8"?>
|
||
|
|
<!-- $Revision$ -->
|
||
|
|
<refentry xml:id="function.enum-exists" xmlns="http://docbook.org/ns/docbook">
|
||
|
|
<refnamediv>
|
||
|
|
<refname>enum_exists</refname>
|
||
|
|
<refpurpose>Checks if the enum has been defined</refpurpose>
|
||
|
|
</refnamediv>
|
||
|
|
<refsect1 role="description">
|
||
|
|
&reftitle.description;
|
||
|
|
<methodsynopsis>
|
||
|
|
<type>bool</type><methodname>enum_exists</methodname>
|
||
|
|
<methodparam><type>string</type><parameter>class</parameter></methodparam>
|
||
|
|
<methodparam choice="opt"><type>bool</type><parameter>autoload</parameter><initializer>&true;</initializer></methodparam>
|
||
|
|
</methodsynopsis>
|
||
|
|
<para>
|
||
|
|
This function checks whether or not the given enum has been defined.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 role="parameters">
|
||
|
|
&reftitle.parameters;
|
||
|
|
<para>
|
||
|
|
<variablelist>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>enum</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
The enum name. The name is matched in a case-insensitive manner.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>autoload</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
Whether to call &link.autoload; by default.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
</variablelist>
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 role="returnvalues">
|
||
|
|
&reftitle.returnvalues;
|
||
|
|
<para>
|
||
|
|
Returns &true; if <parameter>enum</parameter> is a defined enum,
|
||
|
|
&false; otherwise.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 role="examples">
|
||
|
|
&reftitle.examples;
|
||
|
|
<para>
|
||
|
|
<example>
|
||
|
|
<title><function>enum_exists</function> example</title>
|
||
|
|
<programlisting role="php">
|
||
|
|
<![CDATA[
|
||
|
|
<?php
|
||
|
|
// Check that the enum exists before trying to use it
|
||
|
|
if (enum_exists(Suit::class)) {
|
||
|
|
$myclass = Suit::Hearts;
|
||
|
|
}
|
||
|
|
?>
|
||
|
|
]]>
|
||
|
|
</programlisting>
|
||
|
|
</example>
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 role="seealso">
|
||
|
|
&reftitle.seealso;
|
||
|
|
<para>
|
||
|
|
<simplelist>
|
||
|
|
<member><function>function_exists</function></member>
|
||
|
|
<member><function>class_exists</function></member>
|
||
|
|
<member><function>interface_exists</function></member>
|
||
|
|
<member><function>get_declared_classes</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
|
||
|
|
-->
|