sebastian Sat Feb 2 06:04:22 2002 EDT
Modified files:
/phpdoc/en/functions classobj.xml
Log:
Document is_a().
Index: phpdoc/en/functions/classobj.xml
diff -u phpdoc/en/functions/classobj.xml:1.32 phpdoc/en/functions/classobj.xml:1.33
--- phpdoc/en/functions/classobj.xml:1.32 Wed Jan 9 19:26:29 2002
+++ phpdoc/en/functions/classobj.xml Sat Feb 2 06:04:19 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.32 $ -->
+<!-- $Revision: 1.33 $ -->
<reference id="ref.classobj">
<title>Class/Object Functions</title>
<titleabbrev>Classes/Objects</titleabbrev>
@@ -643,12 +643,40 @@
</refsect1>
</refentry>
+ <refentry id="function.is-a">
+ <refnamediv>
+ <refname>is_a</refname>
+ <refpurpose>
+ Returns true if the object is of this class or has this class as
+ one of its parents
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>bool <function>is_a</function></funcdef>
+ <paramdef>object <parameter>object</parameter></paramdef>
+ <paramdef>string <parameter>class_name</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ This function returns &true; if the object is of this class or
+ has this class as one of its parents, &false; otherwise.
+ </para>
+ <simpara>
+ See also <function>get_class</function>,
+ <function>get_parent_class</function> and
+ <function>is_subclass_of</function>.
+ </simpara>
+ </refsect1>
+ </refentry>
+
<refentry id="function.is-subclass-of">
<refnamediv>
<refname>is_subclass_of</refname>
<refpurpose>
- Determines if an object belongs to a subclass
- of the specified class
+ Returns true if the object has this class as one of its parents
</refpurpose>
</refnamediv>
<refsect1>
@@ -656,21 +684,23 @@
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>is_subclass_of</function></funcdef>
- <paramdef>object <parameter>obj</parameter></paramdef>
- <paramdef>string <parameter>superclass</parameter></paramdef>
+ <paramdef>object <parameter>object</parameter></paramdef>
+ <paramdef>string <parameter>class_name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- This function returns &true; if the object <parameter>obj</parameter>,
- belongs to a class which is a subclass of
- <parameter>superclass</parameter>, &false; otherwise.
+ This function returns &true; if the object
+ <parameter>object</parameter>, belongs to a class which is a
+ subclass of <parameter>class_name</parameter>, &false; otherwise.
</para>
<simpara>
- See also <function>get_class</function>,
- <function>get_parent_class</function>
+ See also <function>get_class</function>,
+ <function>get_parent_class</function> and
+ <function>is_a</function>.
</simpara>
</refsect1>
</refentry>
+
<refentry id="function.method-exists">
<refnamediv>
<refname>method_exists</refname>
