archived-doc-ja/reference/classobj/functions/get-class.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4f36c26a72c40b16e955c3c1c88041910932d0bf Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
<refentry xml:id="function.get-class" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>get_class</refname>
  <refpurpose>オブジェクトのクラス名を返す</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>get_class</methodname>
   <methodparam choice="opt"><type>object</type><parameter>object</parameter></methodparam>
  </methodsynopsis>
  <para>
   指定した <parameter>object</parameter> のクラス名を取得します。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>object</parameter></term>
     <listitem>
      <para>
       調べるオブジェクト。
      </para>
      <note>
       <simpara>
        <parameter>object</parameter> に明示的に &null; を渡すことは、
        PHP 7.2.0 以降許されなくなり、<constant>E_WARNING</constant> レベルの警告が発生します。
        PHP 8.0.0 以降では、&null; を渡すと <classname>TypeError</classname> がスローされます。
       </simpara>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   オブジェクト <parameter>object</parameter> がインスタンス
   であるクラスの名前を返します。
  </para>
  <para>
   <parameter>object</parameter> が
   名前空間の中に存在しているクラスのインスタンスだった場合、
   名前空間で修飾されたクラス名が返されます。
  </para>
 </refsect1>
 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   オブジェクト以外に対して <function>get_class</function> をコールすると、
   <classname>TypeError</classname> がスローされます。
   PHP 8.0.0 より前のバージョンでは、
   <constant>E_WARNING</constant> レベルの警告が発生していました。
  </para>
  <para>
   <function>get_class</function> が、クラスの外部から引数なしで呼ばれた場合、
   <classname>Error</classname> が発生します。PHP 8.0.0 より前のバージョンでは、
   <constant>E_WARNING</constant> レベルの警告が発生していました。
  </para>
 </refsect1>
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.3.0</entry>
       <entry>
        <function>get_class</function> を引数なしでコールすると、
        <constant>E_DEPRECATED</constant> が発生するようになりました。
        これより前のバージョンでは、クラスの内部でこの関数をコールすると、
        そのクラスの名前を返していました。
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        この関数をクラスの外部から引数なしで呼び出すと、
        <classname>Error</classname> が発生するようになりました。
        これより前のバージョンでは、
        <constant>E_WARNING</constant> レベルの警告が発生し、
        &false; を返していました。
       </entry>
      </row>
      <row>
       <entry>7.2.0</entry>
       <entry>
        &null; は、<parameter>object</parameter> のデフォルトのパラメータとして
        扱われなくなり、
        正しい入力ではなくなりました。
        これより前のバージョンでは、<parameter>object</parameter>
        のデフォルトのパラメータは &null; であり、何も値を渡さないのと同じ意味でした。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>get_class</function> の使用例</title>
    <programlisting role="php">
<![CDATA[
<?php

class foo {
    function name()
    {
        echo "My name is " , get_class($this) , "\n";
    }
}

// オブジェクトを生成
$bar = new foo();

// 外部からコール
echo "Its name is " , get_class($bar) , "\n";

// 内部からコール
$bar->name();

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Its name is foo
My name is foo
]]>
    </screen>
   </example>
   <example>
    <title><function>get_class</function> のスーパークラスでの使用例</title>
    <programlisting role="php">
<![CDATA[
<?php

abstract class bar {
    public function __construct()
    {
        var_dump(get_class($this));
        var_dump(get_class());
    }
}

class foo extends bar {
}

new foo;

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
string(3) "foo"
string(3) "bar"
]]>
    </screen>
   </example>
   <example>
    <title>名前空間の中にあるクラスを <function>get_class</function> で使う</title>
    <programlisting role="php">
<![CDATA[
<?php

namespace Foo\Bar;

class Baz {
    public function __construct()
    {

    }
}

$baz = new \Foo\Bar\Baz;

var_dump(get_class($baz));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
string(11) "Foo\Bar\Baz"
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>get_called_class</function></member>
    <member><function>get_parent_class</function></member>
    <member><function>gettype</function></member>
    <member><function>get_debug_type</function></member>
    <member><function>is_subclass_of</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
-->