php-doc-en/reference/gmp/functions/gmp-intval.xml
2015-12-18 17:47:52 +00:00

104 lines
2.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.gmp-intval">
<refnamediv>
<refname>gmp_intval</refname>
<refpurpose>Convert GMP number to integer</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>gmp_intval</methodname>
<methodparam><type>GMP</type><parameter>gmpnumber</parameter></methodparam>
</methodsynopsis>
<para>
This function converts GMP number into native PHP <type>integer</type>s.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>gmpnumber</parameter></term>
<listitem>
&gmp.parameter;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The <type>integer</type> value of <parameter>gmpnumber</parameter>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>gmp_intval</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// displays correct result
echo gmp_intval("2147483647") . "\n";
// displays wrong result, above PHP integer limit
echo gmp_intval("2147483648") . "\n";
// displays correct result
echo gmp_strval("2147483648") . "\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
2147483647
2147483647
2147483648
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<warning>
<simpara>
This function returns a useful result only if the number actually
fits the PHP integer (i.e., signed long type). To simply print the GMP
number, use <function>gmp_strval</function>.
</simpara>
</warning>
</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
-->