|
1 | 1 | <?xml version="1.0" encoding="utf-8"?>
|
2 |
| -<!-- EN-Revision: 8fee3ae9715ffa15922469eb7d98f4878917a6ee Maintainer: ae Status: ready --><!-- CREDITS: fabioluciano,ae --> |
| 2 | +<!-- EN-Revision: 285d4ca5804f106ed3e19d4b0270819b8d38a74b Maintainer: leonardolara Status: ready --><!-- CREDITS: fabioluciano,ae,leonardolara --> |
3 | 3 | <refentry xml:id="generator.rewind" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
4 | 4 | <refnamediv>
|
5 | 5 | <refname>Generator::rewind</refname>
|
6 |
| - <refpurpose>Reinicia o iterador</refpurpose> |
| 6 | + <refpurpose>Retrocede o gerador para o primeiro "yield"</refpurpose> |
7 | 7 | </refnamediv>
|
8 | 8 |
|
9 | 9 | <refsect1 role="description">
|
|
13 | 13 | <void/>
|
14 | 14 | </methodsynopsis>
|
15 | 15 | <para>
|
16 |
| - Se uma iteração já tiver sido inicializada, lançará uma exceção. |
| 16 | + O método retrocede o gerador para o ponto antes do primeiro &yield;. |
| 17 | + Se o gerador não estiver em uma primeira expressão &yield; quando este método é chamado, |
| 18 | + ele primeiramente irá avançar para a primeira expressão &yield; antes de retroceder. |
| 19 | + Se o gerador já estiver no ponto de início do segundo yield, |
| 20 | + uma exceção <classname>Exception</classname> será lançada. |
17 | 21 | </para>
|
18 |
| - |
| 22 | + <note> |
| 23 | + <para> |
| 24 | + Este é o <emphasis>primeiro</emphasis> método chamado ao iniciar um |
| 25 | + laço &foreach;. Ele <emphasis>não</emphasis> será |
| 26 | + executado <emphasis>após</emphasis> os laços &foreach;. |
| 27 | + </para> |
| 28 | + </note> |
19 | 29 | </refsect1>
|
20 | 30 |
|
21 | 31 | <refsect1 role="parameters">
|
|
30 | 40 | </para>
|
31 | 41 | </refsect1>
|
32 | 42 |
|
| 43 | + <refsect1 role="examples"> |
| 44 | + &reftitle.examples; |
| 45 | + <para> |
| 46 | + <example> |
| 47 | + <title>Exemplo de <methodname>Generator::rewind</methodname></title> |
| 48 | + <programlisting role="php"> |
| 49 | +<![CDATA[ |
| 50 | +<?php |
| 51 | +
|
| 52 | +function generator(): Generator |
| 53 | +{ |
| 54 | + echo "Eu sou um gerador!\n"; |
| 55 | +
|
| 56 | + for ($i = 1; $i <= 3; $i++) { |
| 57 | + yield $i; |
| 58 | + } |
| 59 | +} |
| 60 | +
|
| 61 | +// Inicializa o gerador |
| 62 | +$generator = generator(); |
| 63 | +
|
| 64 | +// Retrocede o gerador para o início da primeira expressão yield, |
| 65 | +// se já não estava lá |
| 66 | +$generator->rewind(); // Eu sou um gerador! |
| 67 | +
|
| 68 | +// Nada acontece aqui. O gerador já está retrocedido. |
| 69 | +$generator->rewind(); // Sem saída (NULL) |
| 70 | +
|
| 71 | +// Isto retrocede o gerador para a primeira expressão yield, |
| 72 | +// se já não estava lá, e itera sobre o gerador. |
| 73 | +foreach ($generator as $value) { |
| 74 | + // Após gerar o primeiro valor, o gerador permanece na |
| 75 | + // primeira expressão yield até que continue a execução e avance ao próximo yield |
| 76 | + echo $value, PHP_EOL; // 1 |
| 77 | +
|
| 78 | + break; |
| 79 | +} |
| 80 | +
|
| 81 | +// Continua e retrocede novamente. Nenhum erro ocorre porque o gerador não avançou além do primeiro yield |
| 82 | +$generator->rewind(); |
| 83 | +
|
| 84 | +echo $generator->current(), PHP_EOL; // 1 |
| 85 | +
|
| 86 | +// Nenhum erro ocorre, o gerador ainda está no primeiro yield |
| 87 | +$generator->rewind(); |
| 88 | +
|
| 89 | +// Isto avança o gerador para a segunda expressão yield |
| 90 | +$generator->next(); |
| 91 | +
|
| 92 | +try { |
| 93 | + // Aqui uma Exception é lançada |
| 94 | + // porque o gerador já avançou para o segundo yield |
| 95 | + $generator->rewind(); // Fatal error: Uncaught Exception: Cannot rewind a generator that was already run |
| 96 | +} catch (Exception $e) { |
| 97 | + echo $e->getMessage(); |
| 98 | +} |
| 99 | +
|
| 100 | +?> |
| 101 | +]]> |
| 102 | + </programlisting> |
| 103 | + &example.outputs; |
| 104 | + <screen> |
| 105 | +<![CDATA[ |
| 106 | +Eu sou um gerador! |
| 107 | +1 |
| 108 | +1 |
| 109 | +Cannot rewind a generator that was already run |
| 110 | +]]> |
| 111 | + </screen> |
| 112 | + </example> |
| 113 | + </para> |
| 114 | + </refsect1> |
33 | 115 |
|
34 | 116 | </refentry>
|
35 | 117 | <!-- Keep this comment at the end of the file
|
|
0 commit comments