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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.intval" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>intval</refname>
<refpurpose>Get the integer value of a variable</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>intval</methodname>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>base</parameter><initializer>10</initializer></methodparam>
</methodsynopsis>
<para>
Returns the <type>int</type> value of <parameter>value</parameter>,
using the specified <parameter>base</parameter> for the conversion
(the default is base 10). <function>intval</function> should not be used
on objects, as doing so will emit an <constant>E_WARNING</constant> level
error and return 1.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
The scalar value being converted to an integer
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>base</parameter></term>
<listitem>
<para>
The base for the conversion
</para>
<note>
<para>
If <parameter>base</parameter> is 0, the base used is determined
by the format of <parameter>value</parameter>:
<itemizedlist>
<listitem>
<simpara>
if string includes a "0x" (or "0X") prefix, the base is taken
as 16 (hex); otherwise,
</simpara>
</listitem>
<listitem>
<simpara>
if string starts with a "0b" (or "0B"), the base is taken
as 2 (binary); otherwise,
</simpara>
</listitem>
<listitem>
<simpara>
if string starts with "0", the base is taken as 8 (octal);
otherwise,
</simpara>
</listitem>
<listitem>
<simpara>
the base is taken as 10 (decimal).
</simpara>
</listitem>
</itemizedlist>
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The integer value of <parameter>value</parameter> on success, or 0 on
failure. Empty arrays return 0, non-empty arrays return 1.
</para>
<para>
The maximum value depends on the system. 32 bit systems have a
maximum signed integer range of -2147483648 to 2147483647. So for example
on such a system, <literal>intval('1000000000000')</literal> will return
2147483647. The maximum signed integer value for 64 bit systems is
9223372036854775807.
</para>
<para>
Strings will most likely return 0 although this depends on the
leftmost characters of the string. The common rules of
<link linkend="language.types.integer.casting">integer casting</link>
apply.
</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 error level when converting from object was changed from <constant>E_NOTICE</constant> to <constant>E_WARNING</constant>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>intval</function> examples</title>
<para>
The following examples are based on a 64 bit system.
</para>
<programlisting role="php">
<![CDATA[
<?php
echo intval(42); // 42
echo intval(4.2); // 4
echo intval('42'); // 42
echo intval('+42'); // 42
echo intval('-42'); // -42
echo intval(042); // 34
echo intval('042'); // 42
echo intval(1e10); // 10000000000
echo intval('1e10'); // 10000000000
echo intval(0x1A); // 26
echo intval('0x1A'); // 0
echo intval('0x1A', 0); // 26
echo intval(42000000); // 42000000
echo intval(420000000000000000000); // -4275113695319687168
echo intval('420000000000000000000'); // 9223372036854775807
echo intval(42, 8); // 42
echo intval('42', 8); // 34
echo intval(array()); // 0
echo intval(array('foo', 'bar')); // 1
echo intval(false); // 0
echo intval(true); // 1
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
The <parameter>base</parameter> parameter has no effect unless the
<parameter>value</parameter> parameter is a string.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>boolval</function></member>
<member><function>floatval</function></member>
<member><function>strval</function></member>
<member><function>settype</function></member>
<member><function>is_numeric</function></member>
<member><link linkend="language.types.type-juggling">Type juggling</link></member>
<member><link linkend="ref.bc">BCMath Arbitrary Precision Mathematics Functions</link></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
-->
|
