Files
archived-doc-pt-br/reference/network/functions/http-response-code.xml
2024-10-10 10:35:43 -03:00

141 lines
3.7 KiB
XML
Raw Permalink Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 0c9c2dd669fe9395eaa73d487fbd160f9057429a Maintainer: leonardolara Status: ready -->
<refentry xml:id="function.http-response-code" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>http_response_code</refname>
<refpurpose>Obtém ou define o código de resposta HTTP</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>bool</type></type><methodname>http_response_code</methodname>
<methodparam choice="opt"><type>int</type><parameter>response_code</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Obtém ou define o código de resposta HTTP.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>response_code</parameter></term>
<listitem>
<para>
O opcional <parameter>response_code</parameter> definirá o código de resposta.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Se <parameter>response_code</parameter> for fornecido, o código de status
anterior será retornado. Se <parameter>response_code</parameter> não for
fornecido, o código de status atual será retornado. Ambos os
valores terão como padrão um código de status <literal>200</literal> se usados em um
ambiente de servidor web.
</para>
<para>
&false; será retornado se <parameter>response_code</parameter> não for
fornecido e a função não for chamada em um ambiente de servidor web (como em uma
aplicação CLI). &true; será retornado se
<parameter>response_code</parameter> for fornecido e a função não for chamada em um
ambiente de servidor web (mas somente quando nenhum status de resposta anterior
tiver sido definido).
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Usando <function>http_response_code</function> em um ambiente de servidor web</title>
<programlisting role="php">
<![CDATA[
<?php
// Obtém o código de resposta atual e define um novo
var_dump(http_response_code(404));
// Obtém o novo código de resposta
var_dump(http_response_code());
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
int(200)
int(404)
]]>
</screen>
</example>
<example>
<title>Usando <function>http_response_code</function> em um ambiente CLI</title>
<programlisting role="php">
<![CDATA[
<?php
// Obtém o código de resposta padrão atual
var_dump(http_response_code());
// Define um código de resposta
var_dump(http_response_code(201));
// Obtém o novo código de resposta
var_dump(http_response_code());
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(false)
bool(true)
int(201)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>header</function></member>
<member><function>headers_list</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
-->