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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.get-debug-type" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>get_debug_type</refname>
<refpurpose>Gets the type name of a variable in a way that is suitable for debugging</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>get_debug_type</methodname>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Returns the resolved name of the PHP variable <parameter>value</parameter>.
This function will resolve objects to their class name, resources to their
resource type name, and scalar values to their common name as would be used in type
declarations.
</para>
<para>
This function differs from <function>gettype</function> in that it returns type names
that are more consistent with actual usage, rather than those present for historical reasons.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
The variable being type checked.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Possible values for the returned &string; are:
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Type + State</entry>
<entry>Return Value</entry>
<entry>Notes</entry>
</row>
</thead>
<tbody>
<row>
<entry>null</entry>
<entry>
<literal>"null"</literal>
</entry>
<entry>-</entry>
</row>
<row>
<entry>Booleans (&true; or &false;)</entry>
<entry>
<literal>"bool"</literal>
</entry>
<entry>-</entry>
</row>
<row>
<entry>Integers</entry>
<entry>
<literal>"int"</literal>
</entry>
<entry>-</entry>
</row>
<row>
<entry>Floats</entry>
<entry>
<literal>"float"</literal>
</entry>
<entry>-</entry>
</row>
<row>
<entry>Strings</entry>
<entry>
<literal>"string"</literal>
</entry>
<entry>-</entry>
</row>
<row>
<entry>Arrays</entry>
<entry>
<literal>"array"</literal>
</entry>
<entry>-</entry>
</row>
<row>
<entry>Resources</entry>
<entry>
<literal>"resource (resourcename)"</literal>
</entry>
<entry>-</entry>
</row>
<row>
<entry>Resources (Closed)</entry>
<entry>
<literal>"resource (closed)"</literal>
</entry>
<entry>Example: A file stream after being closed with <function>fclose</function>.</entry>
</row>
<row>
<entry>Objects from Named Classes</entry>
<entry>
The full name of the class including its namespace e.g. <literal>Foo\Bar</literal>
</entry>
<entry>-</entry>
</row>
<row>
<entry>Objects from Anonymous Classes</entry>
<entry>
<literal>"class@anonymous"</literal> or parent class name/interface name if the class extends another class or implements an interface e.g. <literal>"Foo\Bar@anonymous"</literal>
</entry>
<entry>
Anonymous classes are those created through the <code>$x = new class { ... }</code> syntax
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>get_debug_type</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
namespace Foo;
echo get_debug_type(null), PHP_EOL;
echo get_debug_type(true), PHP_EOL;
echo get_debug_type(1), PHP_EOL;
echo get_debug_type(0.1), PHP_EOL;
echo get_debug_type("foo"), PHP_EOL;
echo get_debug_type([]), PHP_EOL;
$fp = fopen('/examples/book.xml', 'rb');
echo get_debug_type($fp), PHP_EOL;
fclose($fp);
echo get_debug_type($fp), PHP_EOL;
echo get_debug_type(new \stdClass), PHP_EOL;
echo get_debug_type(new class {}), PHP_EOL;
interface A {}
interface B {}
class C {}
echo get_debug_type(new class implements A {}), PHP_EOL;
echo get_debug_type(new class implements A,B {}), PHP_EOL;
echo get_debug_type(new class extends C {}), PHP_EOL;
echo get_debug_type(new class extends C implements A {}), PHP_EOL;
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
null
bool
int
float
string
array
resource (stream)
resource (closed)
stdClass
class@anonymous
Foo\A@anonymous
Foo\A@anonymous
Foo\C@anonymous
Foo\C@anonymous
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>gettype</function></member>
<member><function>get_class</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
-->
|
