1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.get-class" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>get_class</refname>
<refpurpose>Returns the name of the class of an object</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>
Gets the name of the class of the given <parameter>object</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>object</parameter></term>
<listitem>
<para>
The tested object.
</para>
<note>
<simpara>
Explicitly passing &null; as the <parameter>object</parameter> is no
longer allowed as of PHP 7.2.0 and emits an <constant>E_WARNING</constant>.
As of PHP 8.0.0, a <classname>TypeError</classname> is emitted when
&null; is used.
</simpara>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the name of the class of which <parameter>object</parameter> is an
instance.
</para>
<para>
If the <parameter>object</parameter> is an instance of a class which exists
in a namespace, the qualified namespaced name of that class is returned.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
If <function>get_class</function> is called with anything other than an
object, <classname>TypeError</classname> is raised. Prior to PHP 8.0.0,
an <constant>E_WARNING</constant> level error was raised.
</para>
<para>
If <function>get_class</function> is called with no arguments from outside a class,
an <classname>Error</classname> is thrown. Prior to PHP 8.0.0,
an <constant>E_WARNING</constant> level error was raised.
</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>
Calling <function>get_class</function> without an argument now emits an
<constant>E_DEPRECATED</constant> warning;
previously, calling this function inside a class returned the name of that class.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
Calling this function from outside a class, without any arguments,
will now throw an <classname>Error</classname>.
Previously, an <constant>E_WARNING</constant> was raised
and the function returned &false;.
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
Prior to this version the default value for <parameter>object</parameter>
was &null; and it had the same effect as not passing any value. Now
&null; has been removed as the default value for <parameter>object</parameter>,
and is no longer a valid input.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Using <function>get_class</function></title>
<programlisting role="php">
<![CDATA[
<?php
class foo {
function name()
{
echo "My name is " , get_class($this) , "\n";
}
}
// create an object
$bar = new foo();
// external call
echo "Its name is " , get_class($bar) , "\n";
// internal call
$bar->name();
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Its name is foo
My name is foo
]]>
</screen>
</example>
<example>
<title>Using <function>get_class</function> in superclass</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>Using <function>get_class</function> with namespaced classes</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
-->
|
