Add boolval() documentation.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328469 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Adam Harvey 2012-11-23 08:43:19 +00:00
parent 929137e453
commit 1a28eb6e50
5 changed files with 119 additions and 1 deletions

View file

@ -0,0 +1,114 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.boolval" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>boolval</refname>
<refpurpose>Get the boolean value of a variable</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>boolean</type><methodname>boolval</methodname>
<methodparam><type>mixed</type><parameter>var</parameter></methodparam>
</methodsynopsis>
<para>
Returns the <type>boolean</type> value of <parameter>var</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>var</parameter></term>
<listitem>
<para>
The scalar value being converted to a <type>boolean</type>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The <type>boolean</type> value of <parameter>var</parameter>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>boolval</function> examples</title>
<programlisting role="php">
<![CDATA[
<?php
echo '0: '.(boolval(0) ? 'true' : 'false')."\n";
echo '42: '.(boolval(42) ? 'true' : 'false')."\n";
echo '0.0: '.(boolval(0.0) ? 'true' : 'false')."\n";
echo '4.2: '.(boolval(4.2) ? 'true' : 'false')."\n";
echo '"": '.(boolval("") ? 'true' : 'false')."\n";
echo '"string": '.(boolval("string") ? 'true' : 'false')."\n";
echo '[1, 2]: '.(boolval([1, 2]) ? 'true' : 'false')."\n";
echo '[]: '.(boolval([]) ? 'true' : 'false')."\n";
echo 'stdClass: '.(boolval(new stdClass) ? 'true' : 'false')."\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
0: false
42: true
0.0: false
4.2: true
"": false
"string": true
[1, 2]: true
[]: false
stdClass: true
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>floatval</function></member>
<member><function>intval</function></member>
<member><function>strval</function></member>
<member><function>settype</function></member>
<member><function>is_bool</function></member>
<member><link linkend="language.types.type-juggling">Type juggling</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
-->

View file

@ -66,6 +66,7 @@ echo $float_value_of_var; // 122.34343
&reftitle.seealso;
<para>
<simplelist>
<member><function>boolval</function></member>
<member><function>intval</function></member>
<member><function>strval</function></member>
<member><function>settype</function></member>

View file

@ -142,6 +142,7 @@ echo intval(array('foo', 'bar')); // 1
&reftitle.seealso;
<para>
<simplelist>
<member><function>boolval</function></member>
<member><function>floatval</function></member>
<member><function>strval</function></member>
<member><function>settype</function></member>

View file

@ -86,6 +86,7 @@ echo strval(new StrValTest);
&reftitle.seealso;
<para>
<simplelist>
<member><function>boolval</function></member>
<member><function>floatval</function></member>
<member><function>intval</function></member>
<member><function>settype</function></member>

View file

@ -5,6 +5,7 @@
-->
<versions>
<function name='boolval' from='PHP 5 &gt;= 5.5.0'/>
<function name='debug_zval_dump' from='PHP 4 &gt;= 4.2.0, PHP 5'/>
<function name='doubleval' from='PHP 4, PHP 5'/>
<function name='empty' from='PHP 4, PHP 5'/>
@ -64,4 +65,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->