jimw Wed Jan 2 07:08:06 2002 EDT
Modified files:
/phpdoc/en/functions classobj.xml
Log:
get_parent_class: update proto, document behavior when passed a string
Index: phpdoc/en/functions/classobj.xml
diff -u phpdoc/en/functions/classobj.xml:1.30 phpdoc/en/functions/classobj.xml:1.31
--- phpdoc/en/functions/classobj.xml:1.30 Tue Dec 18 15:00:26 2001
+++ phpdoc/en/functions/classobj.xml Wed Jan 2 07:08:05 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.30 $ -->
+<!-- $Revision: 1.31 $ -->
<reference id="ref.classobj">
<title>Class/Object Functions</title>
<titleabbrev>Classes/Objects</titleabbrev>
@@ -616,23 +616,28 @@
<refentry id="function.get-parent-class">
<refnamediv>
<refname>get_parent_class</refname>
- <refpurpose>Returns the name of the parent class of an object</refpurpose>
+ <refpurpose>Retrieves the parent class name for object or class</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>get_parent_class</function></funcdef>
- <paramdef>object <parameter>obj</parameter></paramdef>
+ <paramdef>mixed <parameter>obj</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- This function returns the name of the parent class to
- the class of which the object <parameter>obj</parameter>
- is an instance.
+ If <parameter>obj</parameter> is an object, returns the name of the
+ parent class of the class of which <parameter>obj</parameter> is an
+ instance.
+ </para>
+ <para>
+ If <parameter>obj</parameter> is a string, returns the name of the parent
+ class of the class with that name. This functionality was added in PHP
+ 4.0.5.
</para>
<simpara>
- See also <function>get_class</function>,
+ See also <function>get_class</function> and
<function>is_subclass_of</function>
</simpara>
</refsect1>