php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login

go to bug id or search bugs for

Doc Bug #61061 mb_decode_numericentity() description is very confusing
Submitted: 2012-02-12 20:06 UTC Modified: 2021-03-18 23:41 UTC
Votes:1
Avg. Score:3.0 ± 0.0
Reproduced:1 of 1 (100.0%)
Same Version:1 (100.0%)
Same OS:1 (100.0%)
From: matteosistisette at gmail dot com Assigned:
Status: Verified Package: mbstring related
PHP Version: Irrelevant OS:
Private report: No CVE-ID: None
View Developer Edit
Welcome back! If you're the original bug submitter, here's where you can edit the bug or add additional notes.
If you forgot your password, you can retrieve your password here.
Password:
Status:
Package:
Bug Type:
Summary:
From: matteosistisette at gmail dot com
New email:
PHP Version: OS:

 

 [2012-02-12 20:06 UTC] matteosistisette at gmail dot com 
Description:
------------
---
From manual page: http://www.php.net/function.mb-decode-numericentity#refsect1-
function.mb-decode-numericentity-description
---

The description:
""
string mb_decode_numericentity ( string $str , array $convmap , string $encoding 
)
Convert numeric string reference of string str in a specified block to 
character.
""
is completely ununderstandable. 

First, it uses the singular "string reference [...] to character", which seems 
to suggest that the function will only convert ONE html entity into ONE 
character, which is not so (it will convert all numeric html entities in the 
given string to characters).

Second, it is not clear what "in a specified block" means.

Third, "numeric string reference of string str" is pretty confusing.

I'm not native english speaking but it looks like the person who wrote this part 
of the documentation wasn't either.

Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2017-01-28 11:55 UTC] cmb@php.net
-Package: Documentation problem +Package: mbstring related
 [2021-03-18 23:41 UTC] cmb@php.net
-Status: Open +Status: Verified
 [2021-03-18 23:41 UTC] cmb@php.net 
> Third, "numeric string reference of string str" is pretty
> confusing.

I think that should be "numeric entity references in $string".

> Second, it is not clear what "in a specified block" means.

I think that refers to the $map parameter, but wouldn't know
the details.
 [2022-08-30 00:07 UTC] abderrahmanekaddour dot aissat at gmail dot com 
check this new note for more information : 
https://www.php.net/manual/en/function.mb-decode-numericentity.php#127555
 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved. 		Last updated: Mon Nov 25 10:01:32 2024 UTC