mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
ca2253c01d
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@289151 c90b9560-bf6c-de11-be94-00142212c4b1
103 lines
2.3 KiB
XML
103 lines
2.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<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 an object</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>abstract</modifier> <modifier>public</modifier> <type>int</type><methodname>Countable::count</methodname>
|
|
<void />
|
|
</methodsynopsis>
|
|
<para>
|
|
This method is executed when using the <function>count</function> function on an
|
|
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 an <type>integer</type>.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
The return value is cast to an <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:"~/.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
|
|
-->
|
|
|