<?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 => 'fr',
  ),
  'this' => 
  array (
    0 => 'yaf-session.key.php',
    1 => 'Yaf_Session::key',
    2 => 'R&eacute;cup&egrave;re la cl&eacute; de l\'entr&eacute;e de session courante',
  ),
  'up' => 
  array (
    0 => 'class.yaf-session.php',
    1 => 'Yaf_Session',
  ),
  'prev' => 
  array (
    0 => 'yaf-session.isset.php',
    1 => 'Yaf_Session::__isset',
  ),
  'next' => 
  array (
    0 => 'yaf-session.next.php',
    1 => 'Yaf_Session::next',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'fr',
    'path' => 'reference/yaf/yaf_session/key.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="yaf-session.key" class="refentry">
 <div class="refnamediv">
<h1 class="refname">Yaf_Session::key</h1>
<p class="verinfo">(Yaf &gt;=1.0.0)</p><p class="refpurpose"><span class="refname">Yaf_Session::key</span> &mdash; <span class="dc-title">Récupère la clé de l&#039;entrée de session courante</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-yaf-session.key-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::key</strong></span>(): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>

  <p class="simpara">Retourne la clé de l&#039;entrée de session courante lors d&#039;une itération.</p>
 </div>


 <div class="refsect1 parameters" id="refsect1-yaf-session.key-parameters">
  <h3 class="title">Liste de paramètres</h3>
  <p class="simpara">Cette fonction ne contient aucun paramètre.</p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-yaf-session.key-returnvalues">
  <h3 class="title">Valeurs de retour</h3>
<p class="simpara">La clé de l&#039;entrée de session courante.</p>
 </div>


 <div class="refsect1 examples" id="refsect1-yaf-session.key-examples">
  <h3 class="title">Exemples</h3>
  <div class="example" id="example-1">
   <p><strong>Exemple #1 Exemple avec <span class="methodname"><strong>Yaf_Session::key()</strong></span></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">);

for (</span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">rewind</span><span style="color: #007700">(); </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">valid</span><span style="color: #007700">(); </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">next</span><span style="color: #007700">()) {
    echo </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">key</span><span style="color: #007700">(), </span><span style="color: #DD0000">" =&gt; "</span><span style="color: #007700">, </span><span style="color: #0000BB">var_export</span><span style="color: #007700">(</span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">current</span><span style="color: #007700">(), </span><span style="color: #0000BB">true</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>Résultat de l&#039;exemple ci-dessus est similaire à :</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">user_id =&gt; 42
lang =&gt; &#039;en&#039;</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-yaf-session.key-seealso">
  <h3 class="title">Voir aussi</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="yaf-session.current.php" class="methodname" rel="rdfs-seeAlso">Yaf_Session::current()</a> - R&eacute;cup&egrave;re la valeur de l'entr&eacute;e de session courante</span></li>
   <li><span class="methodname"><a href="yaf-session.next.php" class="methodname" rel="rdfs-seeAlso">Yaf_Session::next()</a> - Avance &agrave; l'entr&eacute;e de session suivante</span></li>
   <li><span class="methodname"><a href="yaf-session.rewind.php" class="methodname" rel="rdfs-seeAlso">Yaf_Session::rewind()</a> - R&eacute;initialise l'it&eacute;rateur de session sur la premi&egrave;re entr&eacute;e</span></li>
   <li><span class="methodname"><a href="yaf-session.valid.php" class="methodname" rel="rdfs-seeAlso">Yaf_Session::valid()</a> - V&eacute;rifie si la position courante de la session est valide</span></li>
  </ul>
 </div>

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