Whitespace

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@253169 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2008-02-18 18:12:51 +00:00
parent 20e67547e0
commit 0c705633e9

View file

@ -1,96 +1,118 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/var.xml in rev 1.2 -->
<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>var</parameter></methodparam>
</methodsynopsis>
<para>
Returns the type of the PHP variable
<parameter>var</parameter>.
</para>
<warning>
<!-- $Revision: 1.9 $ -->
<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>var</parameter></methodparam>
</methodsynopsis>
<para>
Returns the type of the PHP variable
<parameter>var</parameter>.
</para>
<warning>
<simpara>
Never use <function>gettype</function> to test for a certain type,
since the returned string may be subject to change in a future version.
In addition, it is slow too, as it involves string comparison.
</simpara>
<simpara>
Instead, use the <literal>is_*</literal> functions.
</simpara>
</warning>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Possibles values for the returned string are:
<itemizedlist>
<listitem>
<simpara>
Never use <function>gettype</function> to test for a certain type,
since the returned string may be subject to change in a future version.
In addition, it is slow too, as it involves string comparison.
"<type>boolean</type>" (since PHP 4)
</simpara>
</listitem>
<listitem>
<simpara>
Instead, use the <literal>is_*</literal> functions.
"<type>integer</type>"
</simpara>
</warning>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Possibles values for the returned string are:
<itemizedlist>
<listitem>
<simpara>"<type>boolean</type>" (since PHP 4)</simpara>
</listitem>
<listitem>
<simpara>"<type>integer</type>"</simpara>
</listitem>
<listitem>
<simpara>"<type>double</type>" (for historical reasons "double" is
returned in case of a <type>float</type>, and not simply
"float")</simpara>
</listitem>
<listitem>
<simpara>"<type>string</type>"</simpara>
</listitem>
<listitem>
<simpara>"<type>array</type>"</simpara>
</listitem>
<listitem>
<simpara>"<type>object</type>"</simpara>
</listitem>
<listitem>
<simpara>"<type>resource</type>" (since PHP 4)</simpara>
</listitem>
<listitem>
<simpara>"<type>NULL</type>" (since PHP 4)</simpara>
</listitem>
<listitem>
<simpara>"user function" (PHP 3 only, deprecated)</simpara>
</listitem>
<listitem>
<simpara>"unknown type"</simpara>
</listitem>
</itemizedlist>
</para>
<para>
For PHP 4, you should use <function>function_exists</function> and
<function>method_exists</function> to replace the prior usage of
<function>gettype</function> on a function.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>settype</function></member>
<member><function>is_array</function></member>
<member><function>is_bool</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>
</simplelist>
</para>
</refsect1>
</refentry>
</listitem>
<listitem>
<simpara>
"<type>double</type>" (for historical reasons "double" is
returned in case of a <type>float</type>, and not simply
"float")
</simpara>
</listitem>
<listitem>
<simpara>
"<type>string</type>"
</simpara>
</listitem>
<listitem>
<simpara>
"<type>array</type>"
</simpara>
</listitem>
<listitem>
<simpara>
"<type>object</type>"
</simpara>
</listitem>
<listitem>
<simpara>
"<type>resource</type>" (since PHP 4)
</simpara>
</listitem>
<listitem>
<simpara>
"<type>NULL</type>" (since PHP 4)
</simpara>
</listitem>
<listitem>
<simpara>
"user function" (PHP 3 only, deprecated)
</simpara>
</listitem>
<listitem>
<simpara>
"unknown type"
</simpara>
</listitem>
</itemizedlist>
</para>
<para>
For PHP 4, you should use <function>function_exists</function> and
<function>method_exists</function> to replace the prior usage of
<function>gettype</function> on a function.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>settype</function></member>
<member><function>is_array</function></member>
<member><function>is_bool</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>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: