Files
doc-fr/reference/apache/functions/apache-note.xml
Yannick Torres 5548c2d5b2 * &php; => PHP
* UTF-8 => ISO-8859-15


git-svn-id: https://svn.php.net/repository/phpdoc/fr/trunk@260946 c90b9560-bf6c-de11-be94-00142212c4b1
2008-06-08 19:52:16 +00:00

151 lines
3.9 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.16 $ -->
<!-- EN-Revision: 1.7 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.apache-note" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>apache_note</refname>
<refpurpose>Affiche ou affecte le paramètre <literal>"apache request notes"</literal> </refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>apache_note</methodname>
<methodparam><type>string</type><parameter>note_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>note_value</parameter></methodparam>
</methodsynopsis>
<para>
Cette fonction est une abstraction des commandes <literal>table_get</literal> et
<literal>table_set</literal> d'Apache. Elle édite la table des notes qui existe lors d'une
demande. Le but de cette table est de permettre aux modules Apache de communiquer.
</para>
<para>
L'utilité de la fonction <function>apache_note</function> est de passer des informations
d'un module vers un autre, durant la même demande.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>note_name</parameter></term>
<listitem>
<para>
Le nom de la note.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>note_value</parameter></term>
<listitem>
<para>
La valeur de la note.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Si la fonction est appelée avec un argument, elle renvoie
la valeur courante de la variable <literal>note_name</literal>. Si
<function>apache_note</function> est appelée avec deux arguments,
<function>apache_note</function> affecte à la note <parameter>note_name</parameter>
la valeur <parameter>note_value</parameter> et <function>apache_note</function>
retournera la valeur précédente de la variable <parameter>note_name</parameter>.
Si la note ne peut être récupérée, &false; est retourné.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Passage d'informations entre PHP et Perl</title>
<programlisting role="php">
<![CDATA[
<?php
apache_note('name', 'Fredrik Ekengren');
// Appel du script Perl
virtual("/perl/some_script.pl");
$result = apache_note("resultdata");
?>
]]>
</programlisting>
<programlisting role="perl">
<![CDATA[
# Récupération de l'objet de demande Apache
my $r = Apache->request()->main();
# Récupération des données passées
my $name = $r->notes('name');
# Des traitements
# Envoi du résultat vers PHP
$r->notes('resultdata', $result);
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>Valeurs d'identification dans le fichier access.log</title>
<programlisting role="php">
<![CDATA[
<?php
apache_note('sessionID', session_id());
?>
]]>
</programlisting>
<programlisting role="apache">
<![CDATA[
# "%{sessionID}n" peut être utilisé dans la directive LogFormat
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>virtual</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->