mirror of
https://github.com/php/doc-en.git
synced 2026-03-23 23:32:18 +01:00
126 lines
4.4 KiB
XML
126 lines
4.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<!-- $Revision$ -->
|
||
|
||
<reference xml:id="class.ds-sequence" 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 Sequence interface</title>
|
||
<titleabbrev>Ds\Sequence</titleabbrev>
|
||
|
||
<partintro>
|
||
|
||
<!-- {{{ Ds\Sequence intro -->
|
||
<section xml:id="ds-sequence.intro">
|
||
&reftitle.intro;
|
||
<para>
|
||
A Sequence describes the behaviour of values arranged in a single, linear dimension.
|
||
Some languages refer to this as a "List". It’s similar to an array that uses
|
||
incremental integer keys, with the exception of a few characteristics:
|
||
<simplelist>
|
||
<member>Values will always be indexed as [0, 1, 2, …, size - 1].</member>
|
||
<member>Only allowed to access values by index in the range [0, size - 1].</member>
|
||
</simplelist>
|
||
</para>
|
||
<para>
|
||
Use cases:
|
||
<simplelist>
|
||
<member>Wherever you would use an array as a list (not concerned with keys).</member>
|
||
<member>A more efficient alternative to
|
||
<classname>SplDoublyLinkedList</classname> and
|
||
<classname>SplFixedArray</classname>.
|
||
</member>
|
||
</simplelist>
|
||
</para>
|
||
</section>
|
||
<!-- }}} -->
|
||
|
||
<section xml:id="ds-sequence.synopsis">
|
||
&reftitle.interfacesynopsis;
|
||
|
||
<!-- {{{ Synopsis -->
|
||
<classsynopsis class="interface">
|
||
<oointerface><interfacename>Ds\Sequence</interfacename></oointerface>
|
||
|
||
<oointerface>
|
||
<modifier>extends</modifier>
|
||
<interfacename>Ds\Collection</interfacename>
|
||
</oointerface>
|
||
<oointerface>
|
||
<interfacename>ArrayAccess</interfacename>
|
||
</oointerface>
|
||
|
||
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
|
||
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.ds-sequence')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
|
||
|
||
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
|
||
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.ds-collection')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
|
||
<xi:fallback/>
|
||
</xi:include>
|
||
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.countable')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural') and not(modifier='private')])">
|
||
<xi:fallback/>
|
||
</xi:include>
|
||
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.iteratoraggregate')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural') and not(modifier='private')])">
|
||
<xi:fallback/>
|
||
</xi:include>
|
||
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.jsonserializable')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural') and not(modifier='private')])">
|
||
<xi:fallback/>
|
||
</xi:include>
|
||
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.arrayaccess')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural') and not(modifier='private')])">
|
||
<xi:fallback/>
|
||
</xi:include>
|
||
|
||
</classsynopsis>
|
||
<!-- }}} -->
|
||
|
||
</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 interface now extends <classname>ArrayAccess</classname>.
|
||
</entry>
|
||
</row>
|
||
</tbody>
|
||
</tgroup>
|
||
</informaltable>
|
||
</para>
|
||
</section>
|
||
|
||
</partintro>
|
||
|
||
&reference.ds.ds.entities.sequence;
|
||
|
||
</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
|
||
-->
|