Files
2024-10-15 13:13:47 -03:00

119 lines
3.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: a331ac8a86bb5929b79be9a369fac1e3af516241 Maintainer: ae Status: ready -->
<!-- splitted from ./en/functions/apache.xml, last change in rev 1.20 -->
<refentry xml:id="function.virtual" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>virtual</refname>
<refpurpose>Realiza uma sub-requisição Apache</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>virtual</methodname>
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
</methodsynopsis>
<para>
<function>virtual</function> é uma função específica do Apache
equivalente a <literal>&lt;!--#include virtual...--&gt;</literal>
no <literal>mod_include</literal>.
Realiza uma sub-requisição do Apache. Útil na inclusão de
scripts CGI ou arquivos <filename>.shtml</filename>, ou qualquer outra coisa que possa ser interceptada
no Apache. Note que para um script CGI, o script precisa gerar um cabeçalho
CGI válido. Isto significa que, no mínimo, ele precisa
gerar um cabeçalho <literal>Content-Type</literal>.
</para>
<para>
Para executar a sub-requisição, todos os buffers são finalizados e enviados para o
navegador. Cabeçalhos pendentes também serão enviados.
</para>
&apache.req.module;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>uri</parameter></term>
<listitem>
<para>
A URL no qual o comando virtual será realizado.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Realizado o comando virtual em caso de sucesso, retorna &false; em caso de erros.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
Veja <function>apache_note</function> para um exemplo.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<warning>
<para>
Uma string de consulta pode ser passada para o arquivo incluído, mas
<varname>$_GET</varname> será copiada do script anterior somente se
<varname>$_SERVER['QUERY_STRING']</varname> for preenchida com o valor da
string de consulta. A string de consulta pode ser passada somente no Apache 2.
A página requisitada não será listada nos registros do Apache.
</para>
</warning>
<note>
<para>
Variáveis de ambiente configuradas no arquivo requisitado não estarão visíveis
no script incluído.
</para>
</note>
<note>
<para>
Essa função pode ser utilizada em scripts PHP. Entretanto, é geralmente melhor
utilizar as funções <function>include</function> ou <function>require</function> para
arquivos PHP.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>apache_note</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
-->