php-doc-en/reference/classobj/functions/interface-exists.xml
Larry Garfield 9fe8103520
Document enumerations
Co-authored-by: Yoshinari Takaoka <mumumu@mumumu.org>
Co-authored-by: Sergey Panteleev <sergey@php.net>
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>

Closes GH-960.
2021-10-29 01:14:57 +02:00

102 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.interface-exists" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>interface_exists</refname>
<refpurpose>Checks if the interface has been defined</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>interface_exists</methodname>
<methodparam><type>string</type><parameter>interface</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>autoload</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
Checks if the given interface has been defined.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>interface</parameter></term>
<listitem>
<para>
The interface name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>autoload</parameter></term>
<listitem>
<para>
Whether to call &link.autoload; or not by default.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the interface given by
<parameter>interface</parameter> has been defined, &false; otherwise.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>interface_exists</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Check the interface exists before trying to use it
if (interface_exists('MyInterface')) {
class MyClass implements MyInterface
{
// Methods
}
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>get_declared_interfaces</function></member>
<member><function>class_implements</function></member>
<member><function>class_exists</function></member>
<member><function>enum_exists</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
-->