Doc #52638 [Asn->Csd]: Misleading parameter name for http_build_query
| From: | rquadling@php.net | Date: | Thu, 19 Aug 2010 09:31:38 +0000 |
| Subject: | Doc #52638 [Asn->Csd]: Misleading parameter name for http_build_query | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-4892@lists.php.net to get a copy of this message | ||
Edit report at http://bugs.php.net/bug.php?id=52638&edit=1
ID: 52638
Updated by: rquadling@php.net
Reported by: marcus at deglos dot com
Summary: Misleading parameter name for http_build_query
-Status: Assigned
+Status: Closed
Type: Documentation Problem
Package: Documentation problem
Operating System: n/a
PHP Version: Irrelevant
Assigned To: rquadling
Block user comment: N
Previous Comments:
------------------------------------------------------------------------
[2010-08-19 11:28:52] rquadling@php.net
Automatic comment from SVN on behalf of rquadling
Revision: http://svn.php.net/viewvc/?view=revision&revision=302467
Log: Changed the data paramater from $formdata to $query_data
Documented that only public properties are accessed.
Updated example to show nested objects.
Fix bug#52638
------------------------------------------------------------------------
[2010-08-18 22:31:57] marcus at deglos dot com
Description:
------------
The documentation for 'http_build_query' (
http://php.net/manual/en/function.http-build-query.php
) lists the first
parameter as '$formdata'.
Most uses of http_build_query don't involve forms or formdata, which
makes the parameter-name misleading. People scanning the documentation
may ignore this function, thinking that it only applies to forms (I know
I've skipped past it many a time!)
Renaming the parameter '$paramaters' or '$query_params' will help users
understand the use of this function.
Test script:
---------------
n/a
Expected result:
----------------
n/a
Actual result:
--------------
n/a
------------------------------------------------------------------------
--
Edit this bug report at http://bugs.php.net/bug.php?id=52638&edit=1