nikic

Nikita Popov

Contents

PHP RFC: Remove hex support in numeric strings

  • Date: 2014-08-19
  • Author: Nikita Popov nikic@php.net
  • Status: Implemented (in PHP 7)

Introduction

This RFC proposes to remove support for hexadecimal numers in is_numeric_string. Support for hex in this function is inconsistent with behavior in other places - in particular PHP does not detect hex numbers when performing integer or float casts.

PHP internally has two primary methods from converting strings into numbers:

The first, and most commonly used, are direct casts to the integer or float types (convert_to_long and convert_to_double). These casts do NOT support hexadecimal numbers:

var_dump((int)   "0x123"); // int(0)
var_dump((float) "0x123"); // float(0)

The second possibility is the is_numeric_string function, which will convert a string to either an integer or a float, whichever is more appropriate. This function does support hexadecimal numbers.

This leads to a discrepancy in behavior between type casts and behavior when is_numeric_string is used. Two examples of how this manifests:

is_numeric() function

$str = '0x123';
if (!is_numeric($str)) {
    throw new Exception('Not a number');
}
 
// Exception not thrown, instead wrong result is generated here:
$n = (int) $str; // 0

Loose equality comparison

var_dump('0x123' == '291'); // TRUE
 
var_dump((int) '0x123' == (int) '291'); // FALSE

Proposal

This RFC proposes to remove support for hexadecimal numbers in is_numeric_string to ensure consistent behavior across the language.

An alternative approach would be to add hexadecimal support for integer/double casts instead. However this would also imply that we should support integers of other bases supported by PHP syntax. In particular octal numbers and binary numbers should be detected as well (which is_numeric_string currently does not accept). However supporting octal numbers is not possible, because handling the string '0123' as the number 83 would be highly unexpected for end users of an application.

Generally hexadecimal strings are not often necessary and should be explicitly handled in the cases where they are. A robust way of both validating and parsing hexadecimal strings is given by FILTER_VALIDATE_INT in conjunction with FILTER_FLAG_ALLOW_HEX.

Backward Incompatible Changes

Hexadecimal numbers in strings are no longer supported in the following contexts:

  • The is_numeric() function.
  • Operands of the ==, +, -, *, /, %, **, ++ and -- operators.
  • Arguments of internal functions using l, L or d type specifiers or the convert_scalar_to_number function.
  • Probably some other fringe cases.

Hex string arguments to internal functions will throw the customary “non well formed numeric string” notice.

Patch

Votes

An option needs 2/3 votes to win

Remove hex support in numeric strings? (100% approved)
User Vote
aharvey Yes
ajf Yes
andi Yes
bwoebi Yes
datibbaw Yes
dm Yes
dmitry Yes
dragoonis Yes
galvao Yes
guilhermeblanco Yes
gwynne Yes
irker Yes
jedibc Yes
jgmdev Yes
kalle Yes
laruence Yes
leigh Yes
levim Yes
lstrojny Yes
mbeccati Yes
nikic Yes
rasmus Yes
reeze Yes
santiagolizardo Yes
stas Yes
treffynnon Yes
tyrael Yes
yohgaki Yes
zeev Yes