Re: svn: /phpdoc/en/trunk/reference/network/functions/ http-response-code.xml
| From: | Paul Dragoonis | Date: | Tue, 12 Jul 2011 13:49:38 +0000 |
| Subject: | Re: svn: /phpdoc/en/trunk/reference/network/functions/ http-response-code.xml | ||
| References: | 1 2 | Groups: | php.doc.cvs |
| Request: | Send a blank email to doc-cvs+get-8464@lists.php.net to get a copy of this message | ||
Phillip,
On Tue, Jul 12, 2011 at 6:03 AM, Philip Olson <philip@roshambo.org> wrote:
> Greetings Paul,
>
> This commit changed line endings for this file, therefore it's nearly impossible to see
> the actual changes.
>
> Now, it contained Windows line endings (which are bad) but please, in the future, do WS commits
> separately.
This page is somewhat incomplete, it was 5am and I was passing out so
I wanted to submit something to continue with today. Sorry about the
whitespace, i used edit.php.net editor directly. Does the editor
usually give WS issues?
> As for the commit, it appears you added an example within a parameters description. I
> don't think we should do that. Also, it appears there's some PHP 5.4 specific code in
> the main example, so this man page requires a changelog entry.
Yes, since it's a new function it'll need a changelog entry for
5.4.0+. I hadn't gotten that far yet :-)
> "it appears you added an example within a parameters description. I don't think we
> should do that."
I copied that idea from www.php.net/header. Why is it accepted to do
so on header() but not for this function?
Thanks for the feedback Philip.
Regards,
Paul Dragoonis
>
> Regards,
> Philip
>
> On Jul 11, 2011, at 9:42 PM, Paul Dragoonis wrote:
>
>> dragoonis Tue, 12 Jul 2011 04:42:00 +0000
>>
>> Revision:
>> http://svn.php.net/viewvc?view=revision&revision=313157
>>
>> Log:
>> Updating the http_response_code function as it was just placeholder text before. Now you
>> can set the response code using this function, this is now documented.
>>
>> Changed paths:
>> UU phpdoc/en/trunk/reference/network/functions/http-response-code.xml
>>
>> Modified: phpdoc/en/trunk/reference/network/functions/http-response-code..xml
>> ===================================================================
>> --- phpdoc/en/trunk/reference/network/functions/http-response-code.xml
>> 2011-07-12 03:56:32 UTC (rev 313156)
>> +++ phpdoc/en/trunk/reference/network/functions/http-response-code.xml
>> 2011-07-12 04:42:00 UTC (rev 313157)
>> @@ -1,58 +1,113 @@
>> -<?xml version="1.0" encoding="utf-8"?>
>> -<!-- $Revision$ -->
>> -
>> -<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>Returns the current HTTP response code</refpurpose>
>> - </refnamediv>
>> -
>> - <refsect1 role="description">
>> - &reftitle.description;
>> - <methodsynopsis>
>> - <type>bool</type><methodname>http_response_code</methodname>
>> - <void />
>> - </methodsynopsis>
>> - <para>
>> -
>> - </para>
>> -
>> - &warn.undocumented.func;
>> -
>> - </refsect1>
>> -
>> - <refsect1 role="parameters">
>> - &reftitle.parameters;
>> - &no.function.parameters;
>> - </refsect1>
>> -
>> - <refsect1 role="returnvalues">
>> - &reftitle.returnvalues;
>> - <para>
>> - &return.success;
>> - </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
>> --->
>> +<?xml version="1.0" encoding="utf-8"?>
>> +<!-- $Revision$ -->
>> +
>> +<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>Get or Set the HTTP response code</refpurpose>
>> + </refnamediv>
>> +
>> + <refsect1 role="description">
>> + &reftitle.description;
>> + <methodsynopsis>
>> + <type>int</type><methodname>http_response_code</methodname>
>> + <methodparam
>> choice="opt"><type>int</type><parameter>response_code</parameter></methodparam>
>> + </methodsynopsis>
>> + <para>
>> + If you pass no parameters then http_response_code will get the current status code.
>> + If you pass a parameter it will set the response code.
>> + </para>
>> +
>> + </refsect1>
>> +
>> + <refsect1 role="parameters">
>> + &reftitle.parameters;
>> + <para>
>> + <variablelist>
>> + <varlistentry>
>> + <term><parameter>response_code</parameter></term>
>> + <listitem>
>> + <para>
>> + The optional <parameter>response_code</parameter> will set the
>> response code.
>> + </para>
>> + <para>
>> + <informalexample>
>> + <programlisting role="php">
>> +<![CDATA[
>> +<?php
>> +http_response_code(404);
>> +?>
>> +]]>
>> + </programlisting>
>> + </informalexample>
>> + </para>
>> + </listitem>
>> + </varlistentry>
>> + </variablelist>
>> + </para>
>> + </refsect1>
>> +
>> + <refsect1 role="returnvalues">
>> + &reftitle.returnvalues;
>> + <para>
>> + The current response code. By default the return value is int(200)..
>> + </para>
>> + </refsect1>
>> +
>> + <refsect1 role="examples">
>> + &reftitle.examples;
>> + <para>
>> + <example>
>> + <title>Examples using
>> <function>headers_list</function></title>
>> + <programlisting role="php">
>> +<![CDATA[
>> +<?php
>> +
>> +// Get the current default response code
>> +var_dump(http_response_code()); // int(200)
>> +
>> +// Set our response code
>> +http_response_code(404);
>> +
>> +// Get our new response code
>> +var_dump(http_response_code()); // int(404)
>> +?>
>> +]]>
>> + </programlisting>
>> + &example.outputs;
>> + </example>
>> + </para>
>> + </refsect1>
>> +
>> + <refsect1 role="seealso">
>> + &reftitle.seealso;
>> + <para>
>> + <simplelist>
>> + <member><function>header</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
>> +-->
>>
>>
>> Property changes on: phpdoc/en/trunk/reference/network/functions/http-response-code.xml
>> ___________________________________________________________________
>> Added: svn:eol-style
>> + native
>>
>> --
>> PHP Documentation Commits Mailing List (http://www.php.net/)
>> To unsubscribe, visit: http://www.php.net/unsub.php
>
>