<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: a331ac8a86bb5929b79be9a369fac1e3af516241 Maintainer: PhilDaiguille Status: ready -->

<!-- Reviewed: yes -->

<refentry xml:id="function.apache-note" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>apache_note</refname>

<refpurpose>Muestra o asigna la tabla de notas de Apache</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>string</type><type>false</type></type><methodname>apache_note</methodname>

<methodparam><type>string</type><parameter>note_name</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>note_value</parameter><initializer>&null;</initializer></methodparam>

</methodsynopsis>

<para>

Esta función es una abstracción de los comandos <literal>table_get</literal> y

<literal>table_set</literal> de Apache. Edita la tabla de notas que existe durante una

petición. El propósito de esta tabla es permitir que los módulos de Apache se comuniquen.

</para>

<para>

La utilidad de la función <function>apache_note</function> es pasar información

de un módulo a otro, durante la misma petición.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>note_name</parameter></term>

<listitem>

<para>

El nombre de la nota.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>note_value</parameter></term>

<listitem>

<para>

El valor de la nota.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Si <parameter>note_value</parameter> es omitido o &null;, devuelve

el valor actual de la variable <literal>note_name</literal>. De lo contrario,

asigna a la nota <literal>note_name</literal>

el valor <literal>note_value</literal> y

devolverá el valor anterior de la variable <literal>note_name</literal>.

Si la nota no puede ser recuperada, &false; es devuelto.

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.0.0</entry>

<entry>

<parameter>note_value</parameter> ahora es nullable.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Pasaje de información entre PHP y Perl</title>

<programlisting role="php">

<![CDATA[

<?php

apache_note('name', 'Fredrik Ekengren');

// Llamada al script Perl

virtual("/perl/some_script.pl");

$result = apache_note("resultdata");

?>

]]>

</programlisting>

<programlisting role="perl">

<![CDATA[

# Recuperación del objeto de petición Apache

my $r = Apache->request()->main();

# Recuperación de los datos pasados

my $name = $r->notes('name');

# Procesamiento

# Envío del resultado hacia PHP

$r->notes('resultdata', $result);

]]>

</programlisting>

</example>

</para>

<para>

<example>

<title>Valores de identificación en el archivo access.log</title>

<programlisting role="php">

<![CDATA[

<?php

apache_note('sessionID', session_id());

?>

]]>

</programlisting>

<programlisting role="apache">

<![CDATA[

# "%{sessionID}n" puede ser utilizado en la directiva 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:"~/.phpdoc/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

-->