mb_*code_numericentity Clarify the ValueError conditions

[mmalferov]

In the map parameter of the mb_*code_numericentity functions, any scalar values are allowed, with the caveat that the string scalar must be a numeric string

[lacatoire]

Hi! I looked at the https://github.com/php/php-src/blob/master/ext/mbstring/tests/mb_encode_numericentity.phpt and all the convmap examples use exclusively integer values:

  array(0x0, 0x2FFFF, 0, 0xFFFF)                                                                                                                                                                          
  array(0xFF, 0x2FFFF, 0, 0xFFFF)                                                                                                                                                                         
  [0, 0, 0, 0, 100, 50, 0, 0xFFFF]      

No floats, numeric strings, booleans, or null values are tested as valid inputs.

Also, the https://github.com/php/php-src/blob/master/ext/mbstring/tests/mb_encode_numericentity_errors.phpt shows the error message is: "must only be composed of values of type int"

This suggests the current documentation ("list of integers") is correct. Could you share how you tested that floats/numeric strings are accepted?

[mmalferov]

Could you share how you tested that floats/numeric strings are accepted?

Check this out:

<?php

declare(strict_types=1);

$map = array(128, '01114111', false, null);
$string = 'Hello &#129325;';
echo mb_decode_numericentity($string, $map, 'UTF-8'); // Hello 🤭

I get that $map is supposed to be integers only. But in practice, it accepts more than just int. Probably type coercion "breaks" the intended behavior :)

Anyway, in userland, passing values of other types into the parameter — contrary to the description — produces no warnings, no errors, no exceptions. That means the statement

mb_decode_numericentity() now throws a ValueError if map is not a list of ints.

does not match the actual function behavior

[lacatoire]

Could you share how you tested that floats/numeric strings are accepted?

Check this out:

<?php

declare(strict_types=1);

$map = array(128, '01114111', false, null);
$string = 'Hello &#129325;';
echo mb_decode_numericentity($string, $map, 'UTF-8'); // Hello 🤭

I get that $map is supposed to be integers only. But in practice, it accepts more than just int. Probably type coercion "breaks" the intended behavior :)

Anyway, in userland, passing values of other types into the parameter — contrary to the description — produces no warnings, no errors, no exceptions. That means the statement

mb_decode_numericentity() now throws a ValueError if map is not a list of ints.

does not match the actual function behavior

Thanks for verifying this.