File: iterable.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (65 lines) | stat: -rw-r--r-- 1,613 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<sect1 xml:id="language.types.iterable">
 <title>Iterables</title>

 <para>
  <type>Iterable</type> is a built-in compile time type alias for
  <!-- Need to improve rendering of free-standing type elements in PhD
  <type class="union"><type>array</type><type>Traversable</type></type>.
  -->
  <literal>array|Traversable</literal>.
  From its introduction in PHP 7.1.0 and prior to PHP 8.2.0,
  <type>iterable</type> was a built-in pseudo-type that acted as the
  aforementioned type alias and can be used as a type declaration.
  An iterable type can be used in &foreach; and with
  <command>yield from</command> within a
  <link linkend="language.generators">generator</link>.
 </para>

 <note>
  <para>
   Functions declaring iterable as a return type may also be <link
   linkend="language.generators">generators</link>.

   <example>
    <title>
     Iterable generator return type example
    </title>
    <programlisting role="php">
     <![CDATA[
<?php

function gen(): iterable {
    yield 1;
    yield 2;
    yield 3;
}

?>
]]>
    </programlisting>
   </example>
  </para>
 </note>
</sect1>
<!-- 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
-->