cvs: phpdoc /en/reference/spl countable.xml /en/reference/spl/countable count.xml

From: Date: Sat, 15 Nov 2008 17:17:59 +0000
Subject: cvs: phpdoc /en/reference/spl countable.xml /en/reference/spl/countable count.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-2554@lists.php.net to get a copy of this message
bjori Sat Nov 15 17:17:59 2008 UTC Added files: /phpdoc/en/reference/spl/countable count.xml /phpdoc/en/reference/spl countable.xml Log: Document the Countable interface http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/countable/count.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/countable/count.xml +++ phpdoc/en/reference/spl/countable/count.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="countable.count" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>Countable::count</refname> <refpurpose>Count elements of a object</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>abstract</modifier> <modifier>public</modifier> <type>integer</type><methodname>Countable::count</methodname> <void /> </methodsynopsis> <para> This method executed when using the <function>count</function> function on a object implementing <classname>Countable</classname>. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> The custom count as <type>integer</type>. </para> <note> <para> The return value is casted to <type>integer</type>. </para> </note> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>Countable::count</function> example</title> <programlisting role="php"> <![CDATA[ <?php class myCounter implements Countable { public function count() { static $count = 0; return ++$count; } } $counter = new myCounter; for($i=0; $i<10; ++$i) { echo "I have been count()ed " . count($counter) . " times\n"; } ?> ]]> </programlisting> &example.outputs.similar; <screen> <![CDATA[ I have been count()ed 1 times I have been count()ed 2 times I have been count()ed 3 times I have been count()ed 4 times I have been count()ed 5 times I have been count()ed 6 times I have been count()ed 7 times I have been count()ed 8 times I have been count()ed 9 times I have been count()ed 10 times ]]> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/countable.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/countable.xml +++ phpdoc/en/reference/spl/countable.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <phpdoc:classref xml:id="class.countable" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> <title>The Countable interface</title> <titleabbrev>Countable</titleabbrev> <partintro> <!-- {{{ Countable intro --> <section xml:id="countable.intro"> &reftitle.intro; <para> Classes implementing <classname>Countable</classname> can be used with the <function>count</function> function. </para> </section> <!-- }}} --> <section xml:id="countable.synopsis"> &reftitle.classsynopsis; <!-- {{{ Synopsis --> <classsynopsis> <ooclass><classname>Countable</classname></ooclass> <!-- {{{ Class synopsis --> <classsynopsisinfo> <ooclass> <classname>Countable</classname> </ooclass> </classsynopsisinfo> <!-- }}} --> <classsynopsisinfo role="comment">Methods</classsynopsisinfo> <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.countable')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" /> </classsynopsis> <!-- }}} --> </section> </partintro> &reference.spl.entities.countable; </phpdoc:classref> <!-- 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 -->

« previous php.doc.cvs (#2554) next »