mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
9fe8103520
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.
121 lines
3.1 KiB
XML
121 lines
3.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.class-exists" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>class_exists</refname>
|
|
<refpurpose>Checks if the class has been defined</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>class_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 class has been defined.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>class</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The class 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>class</parameter> is a defined class,
|
|
&false; otherwise.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>class_exists</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// Check that the class exists before trying to use it
|
|
if (class_exists('MyClass')) {
|
|
$myclass = new MyClass();
|
|
}
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
<example>
|
|
<title><parameter>autoload</parameter> parameter example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
spl_autoload_register(function ($class_name) {
|
|
include $class_name . '.php';
|
|
|
|
// Check to see whether the include declared the class
|
|
if (!class_exists($class_name, false)) {
|
|
throw new LogicException("Unable to load class: $class_name");
|
|
}
|
|
});
|
|
|
|
if (class_exists(MyClass::class)) {
|
|
$myclass = new MyClass();
|
|
}
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>function_exists</function></member>
|
|
<member><function>enum_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
|
|
-->
|