archived-doc-en/reference/ds/ds.map.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<reference xml:id="class.ds-map" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The Map class</title>
 <titleabbrev>Ds\Map</titleabbrev>

 <partintro>

<!-- {{{ Ds\Map intro -->
  <section xml:id="ds-map.intro">
   &reftitle.intro;
   <para>
    A Map is a sequential collection of key-value pairs, almost identical to an
    &array; used in a similar context. Keys can be any type, but must be unique.
    Values are replaced if added to the map using the same key.
   </para>
  </section>
<!-- }}} -->


<section xml:id="ds-map.strengths">
    <title xmlns="http://docbook.org/ns/docbook">Strengths</title>
    <para>
        <simplelist>
            <member>Keys and values can be any type, including objects.</member>
            <member>Supports array syntax (square brackets).</member>
            <member>Insertion order is preserved.</member>
            <member>Performance and memory efficiency is very similar to an &array;.</member>
            <member>Automatically frees allocated memory when its size drops low enough.</member>
        </simplelist>
   </para>
</section>

<section xml:id="ds-map.weaknesses">
    <title xmlns="http://docbook.org/ns/docbook">Weaknesses</title>
    <para>
        <simplelist>
            <member>Can’t be converted to an array when objects are used as keys.</member>
        </simplelist>
   </para>
</section>


  <section xml:id="ds-map.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>Ds\Map</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>Ds\Map</classname>
     </ooclass>

     <oointerface>
      <interfacename>Ds\Collection</interfacename>
     </oointerface>
     <oointerface>
      <interfacename>ArrayAccess</interfacename>
     </oointerface>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="ds-map.constants.min-capacity">Ds\Map::MIN_CAPACITY</varname>
     <initializer>8</initializer>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.ds-map')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
   </classsynopsis>
<!-- }}} -->

  </section>

<!-- {{{ Ds\Map constants -->
  <section xml:id="ds-map.constants">
   &reftitle.constants;
   <variablelist>

    <varlistentry xml:id="ds-map.constants.min-capacity">
     <term><constant>Ds\Map::MIN_CAPACITY</constant></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>

   </variablelist>
  </section>
<!-- }}} -->

  <section role="changelog">
   &reftitle.changelog;
   <para>
    <informaltable>
     <tgroup cols="2">
      <thead>
       <row>
        <entry>&Version;</entry>
        <entry>&Description;</entry>
       </row>
      </thead>
      <tbody>
       <row>
        <entry>PECL ds 1.3.0</entry>
        <entry>
         The class now implements <classname>ArrayAccess</classname>.
        </entry>
       </row>
       <row>
        <entry>PECL ds 1.2.0</entry>
        <entry>
         <constant>Ds\Map::MIN_CAPACITY</constant> changed from 16 to 8.
        </entry>
       </row>
      </tbody>
     </tgroup>
    </informaltable>
   </para>
  </section>

 </partintro>

 &reference.ds.ds.entities.map;

</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:"~/.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
-->