<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.yaf-session.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'yaf-session.rewind.php',
    1 => 'Yaf_Session::rewind',
    2 => 'Reset session iterator to first entry',
  ),
  'up' => 
  array (
    0 => 'class.yaf-session.php',
    1 => 'Yaf_Session',
  ),
  'prev' => 
  array (
    0 => 'yaf-session.offsetunset.php',
    1 => 'Yaf_Session::offsetUnset',
  ),
  'next' => 
  array (
    0 => 'yaf-session.set.php',
    1 => 'Yaf_Session::set',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/yaf/yaf_session/rewind.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="yaf-session.rewind" class="refentry">
 <div class="refnamediv">
<h1 class="refname">Yaf_Session::rewind</h1>
<p class="verinfo">(Yaf &gt;=1.0.0)</p><p class="refpurpose"><span class="refname">Yaf_Session::rewind</span> &mdash; <span class="dc-title">Reset session iterator to first entry</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-yaf-session.rewind-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><strong>Yaf_Session::rewind</strong></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>

  <p class="simpara">Rewinds the internal iterator to the first session entry.</p>
 </div>


 <div class="refsect1 parameters" id="refsect1-yaf-session.rewind-parameters">
  <h3 class="title">Parameters</h3>
  <p class="simpara">This function has no parameters.</p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-yaf-session.rewind-returnvalues">
  <h3 class="title">Return Values</h3>
<p class="simpara">No value is returned.</p>
 </div>


 <div class="refsect1 examples" id="refsect1-yaf-session.rewind-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <p><strong>Example #1 <span class="methodname"><strong>Yaf_Session::rewind()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php
$session </span><span style="color: #007700">= </span><span style="color: #0000BB">Yaf_Session</span><span style="color: #007700">::</span><span style="color: #0000BB">getInstance</span><span style="color: #007700">();
</span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">start</span><span style="color: #007700">();

</span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #DD0000">"user_id"</span><span style="color: #007700">, </span><span style="color: #0000BB">42</span><span style="color: #007700">);
</span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #DD0000">"lang"</span><span style="color: #007700">, </span><span style="color: #DD0000">"en"</span><span style="color: #007700">);

foreach (</span><span style="color: #0000BB">$session </span><span style="color: #007700">as </span><span style="color: #0000BB">$key </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">$value</span><span style="color: #007700">) {
    echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$key</span><span style="color: #DD0000"> =&gt; </span><span style="color: #0000BB">$value</span><span style="color: #DD0000">"</span><span style="color: #007700">, </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;
}

</span><span style="color: #FF8000">// a new foreach implicitly calls rewind() again
</span><span style="color: #007700">foreach (</span><span style="color: #0000BB">$session </span><span style="color: #007700">as </span><span style="color: #0000BB">$key </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">$value</span><span style="color: #007700">) {
    echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$key</span><span style="color: #DD0000"> =&gt; </span><span style="color: #0000BB">$value</span><span style="color: #DD0000">"</span><span style="color: #007700">, </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;
}
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
   </div>

   <div class="example-contents"><p>The above example will output
something similar to:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">user_id =&gt; 42
lang =&gt; en
user_id =&gt; 42
lang =&gt; en</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-yaf-session.rewind-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="yaf-session.current.php" class="methodname" rel="rdfs-seeAlso">Yaf_Session::current()</a> - Get current session entry value</span></li>
   <li><span class="methodname"><a href="yaf-session.key.php" class="methodname" rel="rdfs-seeAlso">Yaf_Session::key()</a> - Get current session entry key</span></li>
   <li><span class="methodname"><a href="yaf-session.next.php" class="methodname" rel="rdfs-seeAlso">Yaf_Session::next()</a> - Advance to next session entry</span></li>
   <li><span class="methodname"><a href="yaf-session.valid.php" class="methodname" rel="rdfs-seeAlso">Yaf_Session::valid()</a> - Check if current session position is valid</span></li>
  </ul>
 </div>

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