File: gettype.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (178 lines) | stat: -rw-r--r-- 4,361 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.gettype" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>gettype</refname>
  <refpurpose>Get the type of a variable</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>gettype</methodname>
   <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns the type of the PHP variable <parameter>value</parameter>. For
   type checking, use <literal>is_*</literal> functions.
  </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:
   <simplelist>
    <member>
      <literal>"boolean"</literal>
     </member>
    <member>
     <literal>"integer"</literal>
    </member>
    <member>
     <literal>"double"</literal> (for historical reasons <literal>"double"</literal> is
     returned in case of a <type>float</type>, and not simply
     <literal>"float"</literal>)
    </member>
    <member>
     <literal>"string"</literal>
    </member>
    <member>
     <literal>"array"</literal>
    </member>
    <member>
     <literal>"object"</literal>
    </member>
    <member>
     <literal>"resource"</literal>
    </member>
    <member>
     <literal>"resource (closed)"</literal> as of PHP 7.2.0
    </member>
    <member>
     <literal>"NULL"</literal>
    </member>
    <member>
     <literal>"unknown type"</literal>
    </member>
   </simplelist>
  </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>7.2.0</entry>
       <entry>
        Closed resources are now reported as <literal>'resource (closed)'</literal>.
        Previously the returned value for closed resources were <literal>'unknown type'</literal>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>gettype</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

$data = array(1, 1., NULL, new stdClass, 'foo');

foreach ($data as $value) {
    echo gettype($value), "\n";
}

?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
integer
double
NULL
object
string
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>get_debug_type</function></member>
    <member><function>settype</function></member>
    <member><function>get_class</function></member>
    <member><function>is_array</function></member>
    <member><function>is_bool</function></member>
    <member><function>is_callable</function></member>
    <member><function>is_float</function></member>
    <member><function>is_int</function></member>
    <member><function>is_null</function></member>
    <member><function>is_numeric</function></member>
    <member><function>is_object</function></member>
    <member><function>is_resource</function></member>
    <member><function>is_scalar</function></member>
    <member><function>is_string</function></member>
    <member><function>function_exists</function></member>
    <member><function>method_exists</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
-->