On Sep 22, 2011, at 8:05 AM, Peter Cowburn wrote:

> On 22 September 2011 15:54, Philip Olson <phi...@roshambo.org> wrote:
>> 
>>>>> + <refsect1 role="notes">
>>>>> +  &reftitle.notes;
>>>>> +  <note>
>>>>> +   <para>
>>>>> +    For those accustomed to using 
>>>>> <function>mysql_real_escape_string</function>,
>>>>> +    note that the arguments of 
>>>>> <function>mysqli_real_escape_string</function>
>>>>> +    differ from what <function>mysql_real_escape_string</function> 
>>>>> expects.
>>>>> +    The <parameter>link</parameter> identifier comes first in
>>>>> +    <function>mysqli_real_escape_string</function>, whereas the string 
>>>>> to be escaped
>>>>> +    comes first in <function>mysql_real_escape_string</function>.
>>>>> +   </para>
>>>>> +  </note>
>>>>> + </refsect1>
>>>> 
>>>> 
>>>> That is true with all the mysql[i]_*() functions.
>>>> mysql_ takes the (optional) link identifier as the latter parameter,
>>>> while the mysqli_ ones require it - and it is the first parameter..
>>>> 
>>>> With that in mind, is this really needed?
>>> 
>>> Good question. Lets see what the phpdoc list thinks. :)
>> 
>> My initial reaction sees two options:
>> 
>>  (1) Add a general comment within the Introduction* about this
>>  (2) Begin the mysql->mysqli migration guide, by starting with this
>> 
>> I lean towards (2).
> 
> That sounds like a plan. Something like this certainly would feel most
> at home within a migration guide rather than clogging up many
> functions' notes sections.

I'll add this to my TODO. Actually, the general idea was already on my 
TODO but unfortunately this entire list has gathered cobwebs over the 
past few months. I'll also add "Remove cobwebs" to the TODO. :)

Regards,
Philip

Reply via email to