mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
149 lines
3.4 KiB
XML
149 lines
3.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.get-parent-class" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>get_parent_class</refname>
|
|
<refpurpose>Retrieves the parent class name for object or class</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>string</type><type>false</type></type><methodname>get_parent_class</methodname>
|
|
<methodparam choice="opt"><type class="union"><type>object</type><type>string</type></type><parameter>object_or_class</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Retrieves the parent class name for object or class.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>object_or_class</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The tested object or class name. This parameter is optional if called
|
|
from the object's method.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the name of the parent class of the class of which
|
|
<parameter>object_or_class</parameter> is an instance or the name.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
If the object does not have a parent or the class given does not exist &false; will be returned.
|
|
</para>
|
|
</note>
|
|
<para>
|
|
If called without parameter outside object, this function returns &false;.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>8.0.0</entry>
|
|
<entry>
|
|
The <parameter>object_or_class</parameter> parameter now only accepts objects or valid class names.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Using <function>get_parent_class</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
class Dad {
|
|
function __construct()
|
|
{
|
|
// implements some logic
|
|
}
|
|
}
|
|
|
|
class Child extends Dad {
|
|
function __construct()
|
|
{
|
|
echo "I'm " , get_parent_class($this) , "'s son\n";
|
|
}
|
|
}
|
|
|
|
class Child2 extends Dad {
|
|
function __construct()
|
|
{
|
|
echo "I'm " , get_parent_class('child2') , "'s son too\n";
|
|
}
|
|
}
|
|
|
|
$foo = new child();
|
|
$bar = new child2();
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
I'm Dad's son
|
|
I'm Dad's son too
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>get_class</function></member>
|
|
<member><function>is_subclass_of</function></member>
|
|
<member><function>class_parents</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
|
|
-->
|