- Added splbool description

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@260484 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
David Coallier 2008-05-30 19:55:38 +00:00
parent 3aed8005cd
commit fd86ab0b1d
3 changed files with 169 additions and 1 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- State: new -->
<book xml:id="book.spl_types" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
@ -22,6 +22,8 @@
&reference.spl_types.splint;
&reference.spl_types.splfloat;
&reference.spl_types.splenum;
&reference.spl_types.splbool;
</book>
<!-- Keep this comment at the end of the file

View file

@ -0,0 +1,61 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<reference xml:id="class.splbool" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The SplBool class</title>
<titleabbrev>SplBool</titleabbrev>
<partintro>
<!-- {{{ splbool intro -->
<section xml:id="splbool.intro">
&reftitle.intro;
<para>
The SplBool class is used to enforce strong typing of the bool type.
</para>
</section>
<!-- }}} -->
<section xml:id="splbool.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>SplBool</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>SplBool</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splbool')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])" />
</classsynopsis>
</section>
</partintro>
</reference>
<!-- 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:"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

@ -0,0 +1,105 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="splbool.construct" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SplBool::__construct</refname>
<refpurpose>Constructs a bool object type</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<constructorsynopsis>
<methodname>SplBool::__construct</methodname>
<void />
</constructorsynopsis>
<para>
This constructs a new object of type bool.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>input</parameter></term>
<listitem>
<para>
The <parameter>input</parameter> parameter accepts a <type>bool</type>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>strict</parameter></term>
<listitem>
<para>
A <type>boolean</type> variable to indicate wether the object's
strictness should be set or not.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>SplBool::__construct</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$one = new SplBool(true);
$two = new SplBool(1);
var_dump($one);
var_dump($two);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
object(SplBool)#1 (1) {
["__default"]=>
bool(true)
}
object(SplBool)#1 (1) {
["__default"]=>
bool(true)
}
]]>
</screen>
</example>
</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:"../../../../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
-->