1
0
mirror of https://github.com/php/doc-es.git synced 2026-03-24 15:32:36 +01:00
Files
archived-doc-es/reference/apache/functions/apache-note.xml
Andrés García 72f84928a5 updated to the most recent version.
git-svn-id: https://svn.php.net/repository/phpdoc/es/trunk@349871 c90b9560-bf6c-de11-be94-00142212c4b1
2020-05-14 05:37:06 +00:00

155 lines
3.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: dee2fc06161baf99926320e35bd83646a74aa922 Maintainer: dulasoft Status: ready -->
<!-- Reviewed: no Maintainer: andresdzphp -->
<refentry xml:id="function.apache-note" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>apache_note</refname>
<refpurpose>Obtiene y establece las notas de petición de apache</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>apache_note</methodname>
<methodparam><type>string</type><parameter>note_name</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>string</type><methodname>apache_note</methodname>
<methodparam><type>string</type><parameter>note_name</parameter></methodparam>
<methodparam><type>string</type><parameter>note_value</parameter></methodparam>
</methodsynopsis>
<para>
Esta función es una envoltura para las instrucciones <literal>table_get</literal> y
<literal>table_set</literal> de Apache. Edita las tablas de notas que
existen durante una petición. El propósito de la tabla es permitir la
comunicación entre módulos de Apache.
</para>
<para>
El principal uso de <function>apache_note</function> es el paso de
información desde un módulo a otro en el interior de 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 es llamada con un argumento, devuelve el valor actual de la nota
<literal>note_name</literal>. Si es llamada con dos argumentos, define
el valor de la nota <literal>note_name</literal> to
<literal>note_value</literal> y devuelve el valor previo de la nota <literal>note_name</literal>.
Si la nota no puede ser recuperada, se devuelve &false;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Paso de información entre PHP y Perl</title>
<programlisting role="php">
<![CDATA[
<?php
apache_note('name', 'Fredrik Ekengren');
// Llamada al script de Perl
virtual("/perl/some_script.pl");
$result = apache_note("resultdata");
?>
]]>
</programlisting>
<programlisting role="perl">
<![CDATA[
# Obtiene un objeto de petición de Apache
my $r = Apache->request()->main();
# Obtiene los datos pasados
my $name = $r->notes('name');
# ... proceso de los datos ...
# Devuelve el resultado a PHP
$r->notes('resultdata', $result);
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>Registro de valores en access.log</title>
<programlisting role="php">
<![CDATA[
<?php
apache_note('sessionID', session_id());
?>
]]>
</programlisting>
<programlisting role="apache">
<![CDATA[
# "%{sessionID}n" puede ser usado 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
-->