archived-doc-ja/reference/classobj/functions/is-a.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0296bdbc0ea6902e95564a8bb1d2f762a2db6964 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<refentry xml:id="function.is-a" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>is_a</refname>
  <refpurpose>オブジェクトがこのクラスのものであるか、このクラスをその親クラスのひとつとしているかどうかを調べる</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>is_a</methodname>
   <methodparam><type>object</type><parameter>object</parameter></methodparam>
   <methodparam><type>string</type><parameter>class_name</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>allow_string</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   指定した  <parameter>object</parameter>
   がこのクラスのものであるか、
   あるいはこのクラスをその親クラスのひとつとしているかどうかを調べます。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>object</parameter></term>
     <listitem>
      <para>
       調べたいオブジェクト。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>class_name</parameter></term>
     <listitem>
      <para>
       クラス名。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>allow_string</parameter></term>
     <listitem>
      <para>
       このパラメータを &false; にすると、
       クラス名を表す文字列を <parameter>object</parameter> に指定できなくなります。
       そして、クラスが存在しない場合のオートローダーの呼び出しもしなくなります。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   オブジェクトがこのクラスのものであるか、
   あるいはこのクラスをその親クラスのひとつとしている場合に
   &true;、それ以外の場合に &false; を返します。
  </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>5.3.9</entry>
       <entry>
        パラメータ <parameter>allow_string</parameter> が追加されました。
       </entry>
      </row>
      <row>
       <entry>5.3.0</entry>
       <entry>
        この関数は非推奨ではなくなりました。そのため
        <constant>E_STRICT</constant> も発生しなくなりました。
       </entry>
      </row>
      <row>
       <entry>5.0.0</entry>
       <entry>
        この関数は非推奨となり、かわりに
        <link linkend="language.operators.type">instanceof</link>
        演算子の使用が推奨されるようになりました。この関数をコールすると
        <constant>E_STRICT</constant> が発生します。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>is_a</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
// クラス定義
class WidgetFactory
{
  var $oink = 'moo';
}

// オブジェクトを作成します
$WF = new WidgetFactory();

if (is_a($WF, 'WidgetFactory')) {
  echo "はい、\$WF は WidgetFactory です\n";
}
?>
]]>
    </programlisting>
   </example>
   <example>
    <title>PHP 5 での <emphasis>instanceof</emphasis> 演算子の使用</title>
    <programlisting role="php">
<![CDATA[
<?php
if ($WF instanceof WidgetFactory) {
    echo 'はい、$WF は WidgetFactory です';
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>get_class</function></member>
    <member><function>get_parent_class</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
-->