count.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="splfixedarray.count" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>SplFixedArray::count</refname>
  <refpurpose>Returns the size of the array</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="SplFixedArray">
   <modifier>public</modifier> <type>int</type><methodname>SplFixedArray::count</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Returns the size of the array.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the size of the array.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><methodname>SplFixedArray::count</methodname> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$array = new SplFixedArray(5);
echo $array->count() . "\n";
echo count($array) . "\n";
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
5
5
]]>
    </screen>
   </example>
  </para>
 </refsect1> 
 
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    This method is functionally equivalent to <methodname>SplFixedArray::getSize</methodname>.
   </para>
  </note>
  <note>
   <para>
    The count of elements is always equal to the set size because all values are initially 
    initialized with &null;.
   </para>
  </note>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>SplFixedArray::getSize</methodname></member>
  </simplelist>
 </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
-->