<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.apache.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'fr',
  ),
  'this' => 
  array (
    0 => 'function.apache-note.php',
    1 => 'apache_note',
    2 => 'Lit et affecte les notes de requ&ecirc;te Apache',
  ),
  'up' => 
  array (
    0 => 'ref.apache.php',
    1 => 'Fonctions Apache',
  ),
  'prev' => 
  array (
    0 => 'function.apache-lookup-uri.php',
    1 => 'apache_lookup_uri',
  ),
  'next' => 
  array (
    0 => 'function.apache-request-headers.php',
    1 => 'apache_request_headers',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'fr',
    'path' => 'reference/apache/functions/apache-note.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.apache-note" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">apache_note</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">apache_note</span> &mdash; <span class="dc-title">Lit et affecte les notes de requête Apache</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.apache-note-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>apache_note</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$note_name</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$note_value</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   Cette fonction est une enveloppe pour les commandes <code class="literal">table_get</code> et
   <code class="literal">table_set</code> d&#039;Apache. Elle édite la table des notes qui existe lors d&#039;une
   requête. Le but de cette table est de permettre aux modules Apache de communiquer.
  </p>
  <p class="para">
   L&#039;utilité de la fonction <span class="function"><strong>apache_note()</strong></span> est de passer des informations
   d&#039;un module vers un autre, durant la même requête.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.apache-note-parameters">
  <h3 class="title">Liste de paramètres</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">note_name</code></dt>
     <dd>
      <p class="para">
       Le nom de la note.
      </p>
     </dd>
    
    
     <dt><code class="parameter">note_value</code></dt>
     <dd>
      <p class="para">
       La valeur de la note.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.apache-note-returnvalues">
  <h3 class="title">Valeurs de retour</h3>
  <p class="para">
   Si <code class="parameter">note_value</code> est omis ou <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>, elle renvoie
   la valeur courante de la variable <code class="literal">note_name</code>. Sinon,
   elle affecte à la note <code class="literal">note_name</code>
   la valeur <code class="literal">note_value</code> et
   retourne la valeur précédente de la variable <code class="literal">note_name</code>.
   Si la note ne peut être récupérée, <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> est retourné.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.apache-note-changelog">
  <h3 class="title">Historique</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Version</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">note_value</code> est désormais nullable.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.apache-note-examples">
  <h3 class="title">Exemples</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemple #1 Passage d&#039;informations entre PHP et Perl</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />apache_note</span><span style="color: #007700">(</span><span style="color: #DD0000">'name'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Fredrik Ekengren'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Appel du script Perl<br /></span><span style="color: #0000BB">virtual</span><span style="color: #007700">(</span><span style="color: #DD0000">"/perl/some_script.pl"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">apache_note</span><span style="color: #007700">(</span><span style="color: #DD0000">"resultdata"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents">
<div class="perlcode"><pre class="perlcode"># Récupération de l&#039;objet de demande Apache
my $r = Apache-&gt;request()-&gt;main();

# Récupération des données passées
my $name = $r-&gt;notes(&#039;name&#039;);

# Des traitements

# Envoi du résultat vers PHP
$r-&gt;notes(&#039;resultdata&#039;, $result);</pre>
</div>
    </div>

   </div>
  </p>
  <p class="para">
   <div class="example" id="example-2">
    <p><strong>Exemple #2 Enregistrement de valeurs dans access.log</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />apache_note</span><span style="color: #007700">(</span><span style="color: #DD0000">'sessionID'</span><span style="color: #007700">, </span><span style="color: #0000BB">session_id</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents">
<div class="apachecode"><pre class="apachecode"># &quot;%{sessionID}n&quot; peut être utilisé dans la directive LogFormat</pre>
</div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.apache-note-seealso">
  <h3 class="title">Voir aussi</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.virtual.php" class="function" rel="rdfs-seeAlso">virtual()</a> - Effectue une sous-requ&ecirc;te Apache</span></li>
   </ul>
  </p>
 </div>

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