archived-doc-en/reference/spl/splfixedarray.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.splfixedarray" 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 SplFixedArray class</title>
 <titleabbrev>SplFixedArray</titleabbrev>
 
 <partintro>
 
<!-- {{{ splfixedarray intro -->
  <section xml:id="splfixedarray.intro">
   &reftitle.intro;
   <para>
    The SplFixedArray class provides the main functionalities of array. The 
    main difference between a SplFixedArray and a normal PHP array is that 
    the SplFixedArray must be resized manually and allows only integers within 
    the range as indexes. The advantage is that it uses less memory than
    a standard <type>array</type>.
   </para>
  </section>
<!-- }}} -->
 
  <section xml:id="splfixedarray.synopsis">
   &reftitle.classsynopsis;
 
<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass>
     <classname>SplFixedArray</classname>
    </ooclass>

    <classsynopsisinfo>
     <ooclass>
      <classname>SplFixedArray</classname>
     </ooclass>

     <oointerface>
      <interfacename>IteratorAggregate</interfacename>
     </oointerface>

     <oointerface>
      <interfacename>ArrayAccess</interfacename>
     </oointerface>

     <oointerface>
      <interfacename>Countable</interfacename>
     </oointerface>

     <oointerface>
      <interfacename>JsonSerializable</interfacename>
     </oointerface>
    </classsynopsisinfo>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splfixedarray')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='SplFixedArray'])">
     <xi:fallback/>
    </xi:include>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splfixedarray')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='SplFixedArray'])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
 
  </section>

  <section role="changelog">
   &reftitle.changelog;
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.2.0</entry>
       <entry>
        The <methodname>SplFixedArray::__serialize</methodname> and
        <methodname>SplFixedArray::__unserialize</methodname>
        magic methods have been added to <classname>SplFixedArray</classname>.
       </entry>
      </row>
      <row>
       <entry>8.1.0</entry>
       <entry>
        <classname>SplFixedArray</classname> implements
        <interfacename>JsonSerializable</interfacename> now.
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        <classname>SplFixedArray</classname> implements
        <interfacename>IteratorAggregate</interfacename> now.
        Previously, <interfacename>Iterator</interfacename> was implemented instead.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </section>

<!-- {{{ splfixedarray examples -->
  <section xml:id="splfixedarray.examples">
   &reftitle.examples;
   <para>
    <example>
     <title><classname>SplFixedArray</classname> usage example</title>
     <programlisting role="php">
<![CDATA[
<?php
// Initialize the array with a fixed length
$array = new SplFixedArray(5);

$array[1] = 2;
$array[4] = "foo";

var_dump($array[0]); // NULL
var_dump($array[1]); // int(2)

var_dump($array["4"]); // string(3) "foo"

// Increase the size of the array to 10
$array->setSize(10);

$array[9] = "asdf";

// Shrink the array to a size of 2
$array->setSize(2);

// The following lines throw a RuntimeException: Index invalid or out of range
try {
    var_dump($array["non-numeric"]);
} catch(RuntimeException $re) {
    echo "RuntimeException: ".$re->getMessage()."\n";
}

try {
    var_dump($array[-1]);
} catch(RuntimeException $re) {
    echo "RuntimeException: ".$re->getMessage()."\n";
}

try {
    var_dump($array[5]);
} catch(RuntimeException $re) {
    echo "RuntimeException: ".$re->getMessage()."\n";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
NULL
int(2)
string(3) "foo"
RuntimeException: Index invalid or out of range
RuntimeException: Index invalid or out of range
RuntimeException: Index invalid or out of range
]]>
     </screen>
    </example>
   </para>
  </section>
<!-- }}} -->
 
<!-- {{{ splfixedarray properties
  <section xml:id="splfixedarray.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="splfixedarray.props.name">
     <term><varname>name</varname></term>
     <listitem>
      <para>Prop description</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
}}} -->
 
 </partintro>
 
 &reference.spl.entities.splfixedarray;
 
</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:"~/.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
-->