<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.generator.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'es',
  ),
  'this' => 
  array (
    0 => 'generator.rewind.php',
    1 => 'Generator::rewind',
    2 => 'Ejecuta el generador hasta e incluyendo el primer yield',
  ),
  'up' => 
  array (
    0 => 'class.generator.php',
    1 => 'Generator',
  ),
  'prev' => 
  array (
    0 => 'generator.next.php',
    1 => 'Generator::next',
  ),
  'next' => 
  array (
    0 => 'generator.send.php',
    1 => 'Generator::send',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'es',
    'path' => 'language/predefined/generator/rewind.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="generator.rewind" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Generator::rewind</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.5.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">Generator::rewind</span> &mdash; <span class="dc-title">Ejecuta el generador hasta e incluyendo el primer yield</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-generator.rewind-description">
  <h3 class="title">Descripción</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><strong>Generator::rewind</strong></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>

  <p class="para rdfs-comment">
   Ejecuta el generador hasta e incluyendo el <em>primer</em> <a href="language.generators.syntax.php#control-structures.yield" class="link"><code class="literal">yield</code></a>.
   Si el generador ya está en el <em>primer</em> <a href="language.generators.syntax.php#control-structures.yield" class="link"><code class="literal">yield</code></a>,
   no se realizará ninguna acción.
   Si el generador ha avanzado más allá de una expresión <a href="language.generators.syntax.php#control-structures.yield" class="link"><code class="literal">yield</code></a>,
   este método lanzará una <span class="classname"><a href="class.exception.php" class="classname">Exception</a></span>.
  </p>
  <blockquote class="note"><p><strong class="note">Nota</strong>: 
   <p class="para">
    Se trata del método <em>primero</em> llamado al inicio de
    un ciclo <a href="control-structures.foreach.php" class="link"><code class="literal">foreach</code></a>. <em>No</em> se <em>ejecutará</em>
    <em>después</em> de los ciclos <a href="control-structures.foreach.php" class="link"><code class="literal">foreach</code></a>.
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 parameters" id="refsect1-generator.rewind-parameters">
  <h3 class="title">Parámetros</h3>
  <p class="simpara">Esta función no contiene ningún parámetro.</p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-generator.rewind-returnvalues">
  <h3 class="title">Valores devueltos</h3>
  <p class="para">
   No se retorna ningún valor.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-generator.rewind-examples">
  <h3 class="title">Ejemplos</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Ejemplo #1 Ejemplo de <span class="methodname"><strong>Generator::rewind()</strong></span></strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php

</span><span style="color: #007700">function </span><span style="color: #0000BB">generator</span><span style="color: #007700">(): </span><span style="color: #0000BB">Generator
</span><span style="color: #007700">{
    echo </span><span style="color: #DD0000">"¡Soy un generador!\n"</span><span style="color: #007700">;

    for (</span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">1</span><span style="color: #007700">; </span><span style="color: #0000BB">$i </span><span style="color: #007700">&lt;= </span><span style="color: #0000BB">3</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700">++) {
        yield </span><span style="color: #0000BB">$i</span><span style="color: #007700">;
    }
}

</span><span style="color: #FF8000">// Inicializar el generador
</span><span style="color: #0000BB">$generator </span><span style="color: #007700">= </span><span style="color: #0000BB">generator</span><span style="color: #007700">();

</span><span style="color: #FF8000">// Devolver el generador al inicio de la primera expresión yield,
// si no lo está ya
</span><span style="color: #0000BB">$generator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">rewind</span><span style="color: #007700">(); </span><span style="color: #FF8000">// ¡Soy un generador!

// No ocurre nada aquí; el generador ya está reiniciado
</span><span style="color: #0000BB">$generator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">rewind</span><span style="color: #007700">(); </span><span style="color: #FF8000">// Sin salida (NULL)

// Esto devuelve el generador al inicio de la primera expresión yield,
// si no lo está ya, e itera sobre el generador
</span><span style="color: #007700">foreach (</span><span style="color: #0000BB">$generator </span><span style="color: #007700">as </span><span style="color: #0000BB">$value</span><span style="color: #007700">) {
    </span><span style="color: #FF8000">// Después de devolver el primer valor, el generador permanece en
    // la primera expresión yield hasta que se reanude la ejecución y avance a la siguiente yield
    </span><span style="color: #007700">echo </span><span style="color: #0000BB">$value</span><span style="color: #007700">, </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">; </span><span style="color: #FF8000">// 1

    </span><span style="color: #007700">break;
}

</span><span style="color: #FF8000">// Reanudar y reiniciar nuevamente. No se produce ningún error ya que el generador no ha avanzado más allá del primer yield
</span><span style="color: #0000BB">$generator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">rewind</span><span style="color: #007700">();

echo </span><span style="color: #0000BB">$generator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">current</span><span style="color: #007700">(), </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">; </span><span style="color: #FF8000">// 1

// No se produce ningún error, el generador sigue en la primera yield
</span><span style="color: #0000BB">$generator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">rewind</span><span style="color: #007700">();

</span><span style="color: #FF8000">// Esto hace avanzar el generador a la segunda expresión yield
</span><span style="color: #0000BB">$generator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">next</span><span style="color: #007700">();

try {
    </span><span style="color: #FF8000">// Esto lanzará una excepción,
    // ya que el generador ya ha avanzado a la segunda yield
    </span><span style="color: #0000BB">$generator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">rewind</span><span style="color: #007700">(); </span><span style="color: #FF8000">// Error fatal: Exception no capturada: No se puede devolver un generador que ya ha sido ejecutado
</span><span style="color: #007700">} catch (</span><span style="color: #0000BB">Exception $e</span><span style="color: #007700">) {
    echo </span><span style="color: #0000BB">$e</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getMessage</span><span style="color: #007700">();
}

</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
    </div>

    <div class="example-contents"><p>El ejemplo anterior mostrará:</p></div>
    <div class="example-contents screen">
<div class="annotation-interactive examplescode"><pre class="examplescode">¡Soy un generador!
1
1
No se puede devolver un generador que ya ha sido ejecutado</pre>
</div>
    </div>
   </div>
  </p>
 </div>


</div><?php manual_footer($setup); ?>